Aspire.Hosting.Azure.ServiceBus 9.5.1

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package Aspire.Hosting.Azure.ServiceBus --version 9.5.1

NuGet\Install-Package Aspire.Hosting.Azure.ServiceBus -Version 9.5.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Aspire.Hosting.Azure.ServiceBus" Version="9.5.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Aspire.Hosting.Azure.ServiceBus" Version="9.5.1" />
                    

                            Directory.Packages.props

<PackageReference Include="Aspire.Hosting.Azure.ServiceBus" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Aspire.Hosting.Azure.ServiceBus --version 9.5.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Aspire.Hosting.Azure.ServiceBus, 9.5.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Aspire.Hosting.Azure.ServiceBus@9.5.1

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Aspire.Hosting.Azure.ServiceBus&version=9.5.1
                    

                            Install as a Cake Addin

#tool nuget:?package=Aspire.Hosting.Azure.ServiceBus&version=9.5.1
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Aspire.Hosting.Azure.ServiceBus library

Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure Service Bus.

Getting started

Prerequisites

Azure subscription - create one for free

Install the package

Install the .NET Aspire Azure Service Bus Hosting library with NuGet:

dotnet add package Aspire.Hosting.Azure.ServiceBus

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 a Service Bus connection and consume the connection using the following methods:

var serviceBus = builder.AddAzureServiceBus("sb");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(serviceBus);

The WithReference method passes that connection information into a connection string named sb in the MyService project. In the Program.cs file of MyService, the connection can be consumed using the client library Aspire.Azure.Messaging.ServiceBus:

builder.AddAzureServiceBusClient("sb");

Additional documentation

Feedback & contributing

https://github.com/dotnet/aspire

Product	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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net8.0
- Aspire.Hosting.Azure (>= 9.5.1)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.47.3)
- Azure.Identity (>= 1.15.0)
- Azure.Provisioning (>= 1.3.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.Provisioning.ServiceBus (>= 1.1.0)
- 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)
- 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.ServiceBus:

Package	Downloads
AJP.Aspire.Hosting.AsbEmulatorUi A UI for the ASB Emulator, view entities, message counts, send, peek and receive messages, canned Messages, also API for automated testing.	53

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Aspire.Hosting.Azure.ServiceBus:

Repository	Stars
Azure-Samples/eShopOnAzure A variant of https://github.com/dotnet/eShop that uses Azure services	250

Version	Downloads	Last Updated
13.0.0	6,634	11/11/2025
9.5.2	21,770	10/23/2025
9.5.1	33,118	10/3/2025
9.5.0	18,527	9/25/2025
9.4.2	35,538	9/2/2025
9.4.1	28,547	8/12/2025
9.4.0	14,289	7/29/2025
9.3.1	53,155	6/10/2025
9.3.0	24,566	5/19/2025
9.2.1	19,311	4/24/2025
9.2.0	13,988	4/10/2025
9.1.0	41,580	2/25/2025
9.0.0	34,067	11/12/2024
9.0.0-rc.1.24511.1	1,177	10/15/2024
8.2.2	4,521	10/24/2024
8.2.1	6,221	9/26/2024
8.2.0	14,026	8/29/2024
8.1.0	6,145	7/23/2024
8.0.2	3,354	6/28/2024
8.0.1	5,844	5/21/2024
8.0.0	2,207	5/21/2024
8.0.0-preview.7.24251.11	3,183	5/7/2024
8.0.0-preview.6.24214.1	377	4/23/2024
8.0.0-preview.5.24201.12	832	4/9/2024