Aspire.Hosting.Azure.SignalR 13.2.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.SignalR --version 13.2.2
                    


                    

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


                            Directory.Packages.props
                        

                    

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


                            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.SignalR --version 13.2.2
                    


                    

                
#r "nuget: Aspire.Hosting.Azure.SignalR, 13.2.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.SignalR@13.2.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.SignalR&version=13.2.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Aspire.Hosting.Azure.SignalR&version=13.2.2
                    


                            Install as a Cake Tool

Aspire.Hosting.Azure.SignalR library

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

Getting started

Prerequisites

Install the package

Install the Aspire Azure SignalR Hosting library with NuGet:

dotnet add package Aspire.Hosting.Azure.SignalR

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

var signalR = builder.AddAzureSignalR("sr");

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

The WithReference method configures a connection in the MyService project named sr. In the Program.cs file of MyService, the Azure SignalR connection can be consumed using the client library Microsoft.Azure.SignalR:

builder.Services.AddSignalR()
    .AddNamedAzureSignalR("sr");

Connection Properties

When you reference an Azure SignalR resource using WithReference, the following connection properties are made available to the consuming project:

Property Name Description
Uri The connection URI for the SignalR service, with the format https://{host} in Azure (typically https://<resource-name>.service.signalr.net) or the emulator-provided endpoint when running locally

Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called sr becomes SR_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

This package is not used by any NuGet packages.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Aspire.Hosting.Azure.SignalR:

Repository Stars
foxminchan/BookWorm
The practical implementation of Aspire using Microservices, AI-Agents
PacktPublishing/Pragmatic-Microservices-with-CSharp-and-Azure
Pragmatic Microservices with C# and Azure, published by Packt