Aspire.Hosting.Azure.ServiceBus 13.0.2

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Aspire.Hosting.Azure.ServiceBus --version 13.0.2
                    


                    

                
NuGet\Install-Package Aspire.Hosting.Azure.ServiceBus -Version 13.0.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.0.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.0.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.0.2
                    


                    

                
#r "nuget: Aspire.Hosting.Azure.ServiceBus, 13.0.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.0.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.0.2
                    


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

Aspire.Hosting.Azure.ServiceBus library

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

Getting started

Prerequisites

Install the package

Install the 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 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 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
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.

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