Aspire.Hosting.Azure.ServiceBus 13.5.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Aspire.Hosting.Azure.ServiceBus --version 13.5.2
                    


                    

                
NuGet\Install-Package Aspire.Hosting.Azure.ServiceBus -Version 13.5.2
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="13.5.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Aspire.Hosting.Azure.ServiceBus" Version="13.5.2" />
                    


                            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 13.5.2
                    


                    

                
#r "nuget: Aspire.Hosting.Azure.ServiceBus, 13.5.2"
#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@13.5.2
#: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=13.5.2
                    


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

Azure Service Bus hosting integration

Use this integration to model, configure, and orchestrate Azure Service Bus in an Aspire solution.

Getting started

Prerequisites

Add the integration

From your AppHost directory, add the Aspire.Hosting.Azure.ServiceBus integration with the Aspire CLI:

aspire add Aspire.Hosting.Azure.ServiceBus

Configure Azure Provisioning for local development

Adding Azure resources to the AppHost 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 AppHost configuration. From your AppHost directory, set these values with aspire secret set:

aspire secret set Azure:SubscriptionId "<your subscription id>"
aspire secret set Azure:ResourceGroupPrefix "<prefix for the resource group>"
aspire secret set Azure: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, add a Service Bus connection and reference it from another resource with either C# or TypeScript:

C#

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

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

TypeScript

const serviceBus = await builder.addAzureServiceBus("sb");

const myService = await builder.addNodeApp("myService", "../my-service", "server.js")
                       .withReference(serviceBus);

Connection Properties

When you reference Azure Service Bus resources using WithReference, the following connection properties are made available to the consuming project:

Service Bus namespace

The Service Bus namespace resource exposes the following connection properties:

Property Name Description
Host The hostname of the Service Bus namespace
Port The port of the Service Bus namespace when the emulator is used
Uri The connection URI, with the format sb://myservicebus.servicebus.windows.net
ConnectionString Emulator only. Includes SAS key material for the local emulator connection.

Service Bus queue

The Service Bus queue resource inherits all properties from its parent Service Bus namespace and adds:

Property Name Description
QueueName The name of the queue

Service Bus topic

The Service Bus topic resource inherits all properties from its parent Service Bus namespace and adds:

Property Name Description
TopicName The name of the topic

Service Bus subscription

The Service Bus subscription resource inherits all properties from its parent Service Bus topic and adds:

Property Name Description
SubscriptionName The name of the subscription
ConnectionString The connection string for the subscription

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called db1 becomes DB1_URI.

Additional documentation

Feedback & contributing

https://github.com/microsoft/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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 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.
SoftwareExtravaganza.Whizbang.Hosting.Azure.ServiceBus

Aspire hosting extensions for Whizbang Azure Service Bus integration
Flowly.AzureServiceBus.Aspire

Aspire AppHost integration for Flowly Azure Service Bus.
QueueView.Hosting

Aspire hosting extension for viewing Azure ServiceBus queues. Add .WithQueueView() to any ServiceBus resource to get instant queue visibility in your Aspire dashboard.
OpinionatedEventing.Aspire.AzureServiceBus

Aspire AppHost extension for OpinionatedEventing — adds an Azure Service Bus emulator resource. Reference this package from your AppHost project only.

GitHub repositories (3)

Showing the top 3 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
akkadotnet/Alpakka
Akka Streams Connectors - Alpakka
baotoq/micro-commerce
.NET 10 .NET Aspire
Version Downloads Last Updated
13.5.2 1,147 8/21/2026
13.5.1 2,237 8/20/2026
13.5.0 4,532 8/18/2026
13.4.6 251,415 6/19/2026
13.4.5 25,318 6/17/2026
13.4.4 22,689 6/15/2026
13.4.3 39,265 6/8/2026
13.4.2 87,174 6/3/2026
13.4.1 2,062 6/3/2026
13.4.0 41,790 6/1/2026
13.3.5 93,056 5/21/2026
13.3.4 18,083 5/19/2026
13.3.3 34,737 5/15/2026
13.3.2 16,381 5/14/2026
13.3.1 10,974 5/12/2026
13.3.0 33,391 5/7/2026
13.2.4 90,602 4/24/2026
13.2.3 30,041 4/21/2026
13.2.2 92,451 4/8/2026
13.2.1 41,652 3/31/2026
Loading failed