Aspire.Hosting.Azure.EventHubs
9.5.2
Prefix Reserved
dotnet add package Aspire.Hosting.Azure.EventHubs --version 9.5.2
NuGet\Install-Package Aspire.Hosting.Azure.EventHubs -Version 9.5.2
<PackageReference Include="Aspire.Hosting.Azure.EventHubs" Version="9.5.2" />
<PackageVersion Include="Aspire.Hosting.Azure.EventHubs" Version="9.5.2" />
<PackageReference Include="Aspire.Hosting.Azure.EventHubs" />
paket add Aspire.Hosting.Azure.EventHubs --version 9.5.2
#r "nuget: Aspire.Hosting.Azure.EventHubs, 9.5.2"
#:package Aspire.Hosting.Azure.EventHubs@9.5.2
#addin nuget:?package=Aspire.Hosting.Azure.EventHubs&version=9.5.2
#tool nuget:?package=Aspire.Hosting.Azure.EventHubs&version=9.5.2
Aspire.Hosting.Azure.EventHubs library
Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure Event Hubs.
Getting started
Prerequisites
- Azure subscription - create one for free
Install the package
Install the .NET Aspire Azure Event Hubs Hosting library with NuGet:
dotnet add package Aspire.Hosting.Azure.EventHubs
Configure Azure Provisioning for local development
Adding Azure resources to the .NET Aspire application model will automatically enable development-time provisioning for Azure resources so that you don't need to configure them manually. Provisioning requires a number of settings to be available via .NET configuration. Set these values in user secrets in order to allow resources to be configured automatically.
{
"Azure": {
"SubscriptionId": "<your subscription id>",
"ResourceGroupPrefix": "<prefix for the resource group>",
"Location": "<azure location>"
}
}
NOTE: Developers must have Owner access to the target subscription so that role assignments can be configured for the provisioned resources.
Usage example
In the AppHost.cs file of AppHost, add an Event Hubs connection and consume the connection using the following methods:
var eventHubs = builder.AddAzureEventHubs("eh");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(eventHubs);
The WithReference method passes that connection information into a connection string named eh in the MyService project. In the Program.cs file of MyService, the connection can be consumed using the client library Aspire.Azure.Messaging.EventHubs:
builder.AddAzureEventProcessorClient("eh");
Additional documentation
- https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/eventhub/Microsoft.Azure.EventHubs/README.md
- https://github.com/dotnet/aspire/tree/main/src/Components/README.md
Feedback & contributing
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net8.0
- Aspire.Hosting.Azure (>= 9.5.2)
- Aspire.Hosting.Azure.Storage (>= 9.5.2)
- AspNetCore.HealthChecks.Azure.Storage.Blobs (>= 9.0.0)
- AspNetCore.HealthChecks.Azure.Storage.Queues (>= 9.0.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.47.3)
- Azure.Identity (>= 1.15.0)
- Azure.Provisioning (>= 1.3.0)
- Azure.Provisioning.EventHubs (>= 1.1.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.Provisioning.Storage (>= 1.1.2)
- Azure.ResourceManager.Authorization (>= 1.1.5)
- Azure.ResourceManager.KeyVault (>= 1.3.2)
- Azure.ResourceManager.Resources (>= 1.11.1)
- Azure.Security.KeyVault.Secrets (>= 4.8.0)
- Azure.Storage.Blobs (>= 12.25.0)
- Azure.Storage.Queues (>= 12.23.0)
- Google.Protobuf (>= 3.32.0)
- Grpc.AspNetCore (>= 2.71.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.Tools (>= 2.72.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 17.0.14)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.20)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Newtonsoft.Json (>= 13.0.3)
- Polly.Core (>= 8.6.3)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.11)
- System.IO.Hashing (>= 9.0.8)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Aspire.Hosting.Azure.EventHubs:
| Package | Downloads |
|---|---|
|
LupusBytes.Aspire.Hosting.Azure.EventHubs.LiveExplorer
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated | |
|---|---|---|---|
| 9.5.2 | 947 | 10/23/2025 | |
| 9.5.1 | 4,973 | 10/3/2025 | |
| 9.5.0 | 3,013 | 9/25/2025 | |
| 9.4.2 | 8,341 | 9/2/2025 | |
| 9.4.1 | 6,018 | 8/12/2025 | |
| 9.4.0 | 8,461 | 7/29/2025 | |
| 9.3.1 | 12,967 | 6/10/2025 | |
| 9.3.0 | 4,292 | 5/19/2025 | |
| 9.2.1 | 5,494 | 4/24/2025 | |
| 9.2.0 | 2,242 | 4/10/2025 | |
| 9.1.0 | 10,033 | 2/25/2025 | |
| 9.0.0 | 16,159 | 11/12/2024 | |
| 9.0.0-rc.1.24511.1 | 472 | 10/15/2024 | |
| 8.2.2 | 1,004 | 10/24/2024 | |
| 8.2.1 | 1,373 | 9/26/2024 | |
| 8.2.0 | 2,065 | 8/29/2024 | |
| 8.1.0 | 712 | 7/23/2024 | |
| 8.0.2 | 947 | 6/28/2024 | |
| 8.0.1 | 605 | 5/21/2024 | |
| 8.0.0 | 399 | 5/21/2024 | |
| 8.0.0-preview.7.24251.11 | 224 | 5/7/2024 | |
| 8.0.0-preview.6.24214.1 | 217 | 4/23/2024 | |
| 8.0.0-preview.5.24201.12 | 244 | 4/9/2024 |