Aspire.Hosting.Azure.SignalR
13.4.6
Prefix Reserved
dotnet add package Aspire.Hosting.Azure.SignalR --version 13.4.6
NuGet\Install-Package Aspire.Hosting.Azure.SignalR -Version 13.4.6
<PackageReference Include="Aspire.Hosting.Azure.SignalR" Version="13.4.6" />
<PackageVersion Include="Aspire.Hosting.Azure.SignalR" Version="13.4.6" />
<PackageReference Include="Aspire.Hosting.Azure.SignalR" />
paket add Aspire.Hosting.Azure.SignalR --version 13.4.6
#r "nuget: Aspire.Hosting.Azure.SignalR, 13.4.6"
#:package Aspire.Hosting.Azure.SignalR@13.4.6
#addin nuget:?package=Aspire.Hosting.Azure.SignalR&version=13.4.6
#tool nuget:?package=Aspire.Hosting.Azure.SignalR&version=13.4.6
Aspire.Hosting.Azure.SignalR library
Provides extension methods and resource definitions for an Aspire AppHost to configure Azure SignalR.
Getting started
Prerequisites
- Azure subscription - create one for free
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
- https://github.com/microsoft/aspire/tree/main/src/Components/README.md
- https://aspire.dev/integrations/cloud/azure/azure-signalr/
- https://learn.microsoft.com/azure/azure-signalr/signalr-overview
Feedback & contributing
https://github.com/microsoft/aspire
| 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 (>= 13.4.6)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.55.0)
- Azure.Identity (>= 1.21.0)
- Azure.Provisioning (>= 1.5.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.Provisioning.SignalR (>= 1.1.0)
- Azure.ResourceManager.Authorization (>= 1.1.6)
- Azure.ResourceManager.Resources (>= 1.11.2)
- Azure.Security.KeyVault.Secrets (>= 4.11.0)
- Google.Protobuf (>= 3.34.1)
- Grpc.AspNetCore (>= 2.80.0)
- Grpc.Net.ClientFactory (>= 2.80.0)
- Grpc.Tools (>= 2.80.0)
- Humanizer.Core (>= 3.0.10)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 19.0.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.8)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.8)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.8)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.27)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.8)
- Microsoft.Extensions.Hosting (>= 10.0.8)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.8)
- Microsoft.Extensions.Http (>= 10.0.8)
- Microsoft.Extensions.Logging (>= 10.0.8)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.8)
- Microsoft.Extensions.Options (>= 10.0.8)
- Microsoft.Extensions.Primitives (>= 10.0.8)
- ModelContextProtocol (>= 1.3.0)
- Newtonsoft.Json (>= 13.0.4)
- OpenTelemetry.Exporter.OpenTelemetryProtocol (>= 1.15.3)
- OpenTelemetry.Extensions.Hosting (>= 1.15.3)
- Polly.Core (>= 8.6.6)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.25.29)
- System.IO.Hashing (>= 10.0.8)
- System.Text.Json (>= 10.0.8)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Aspire.Hosting.Azure.SignalR:
| Repository | Stars |
|---|---|
|
PacktPublishing/Pragmatic-Microservices-with-CSharp-and-Azure
Pragmatic Microservices with C# and Azure, published by Packt
|
| Version | Downloads | Last Updated |
|---|---|---|
| 13.4.6 | 7,614 | 6/19/2026 |
| 13.4.5 | 1,223 | 6/17/2026 |
| 13.4.4 | 1,498 | 6/15/2026 |
| 13.4.3 | 4,319 | 6/8/2026 |
| 13.4.2 | 33,974 | 6/3/2026 |
| 13.4.1 | 380 | 6/3/2026 |
| 13.4.0 | 975 | 6/1/2026 |
| 13.3.5 | 16,338 | 5/21/2026 |
| 13.3.4 | 1,909 | 5/19/2026 |
| 13.3.3 | 1,788 | 5/15/2026 |
| 13.3.2 | 743 | 5/14/2026 |
| 13.3.1 | 1,003 | 5/12/2026 |
| 13.3.0 | 1,952 | 5/7/2026 |
| 13.2.4 | 10,528 | 4/24/2026 |
| 13.2.3 | 1,725 | 4/21/2026 |
| 13.2.2 | 4,850 | 4/8/2026 |
| 13.2.1 | 4,606 | 3/31/2026 |
| 13.2.0 | 5,608 | 3/23/2026 |
| 13.1.3 | 4,808 | 3/19/2026 |
| 13.1.2 | 8,616 | 2/26/2026 |