Aspire.Hosting.Azure.SignalR
13.6.4
Prefix Reserved
dotnet add package Aspire.Hosting.Azure.SignalR --version 13.6.4
NuGet\Install-Package Aspire.Hosting.Azure.SignalR -Version 13.6.4
<PackageReference Include="Aspire.Hosting.Azure.SignalR" Version="13.6.4" />
<PackageVersion Include="Aspire.Hosting.Azure.SignalR" Version="13.6.4" />
<PackageReference Include="Aspire.Hosting.Azure.SignalR" />
paket add Aspire.Hosting.Azure.SignalR --version 13.6.4
#r "nuget: Aspire.Hosting.Azure.SignalR, 13.6.4"
#:package Aspire.Hosting.Azure.SignalR@13.6.4
#addin nuget:?package=Aspire.Hosting.Azure.SignalR&version=13.6.4
#tool nuget:?package=Aspire.Hosting.Azure.SignalR&version=13.6.4
Azure SignalR Service hosting integration
Use this integration to model, configure, and orchestrate Azure SignalR in an Aspire solution.
Getting started
Prerequisites
- Azure subscription - create one for free
Add the integration
From your AppHost directory, add the Aspire.Hosting.Azure.SignalR integration with the Aspire CLI:
aspire add Aspire.Hosting.Azure.SignalR
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 SignalR connection and reference it from another resource with either C# or TypeScript:
C#
var signalR = builder.AddAzureSignalR("sr");
var myService = builder.AddProject<Projects.MyService>()
.WithReference(signalR);
TypeScript
const signalR = await builder.addAzureSignalR("sr");
const myService = await builder.addNodeApp("myService", "../my-service", "server.js")
.withReference(signalR);
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://aspire.dev/integrations/gallery/
- https://aspire.dev/integrations/cloud/azure/azure-signalr/azure-signalr-host/
- https://learn.microsoft.com/azure/azure-signalr/signalr-overview
Feedback & contributing
| 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.6.4)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.62.0)
- Azure.Identity (>= 1.21.0)
- Azure.Provisioning (>= 1.6.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.Provisioning.SignalR (>= 1.1.0)
- Azure.ResourceManager.Authorization (>= 1.1.7)
- Azure.ResourceManager.KeyVault (>= 1.4.0)
- Azure.ResourceManager.Resources.Deployments (>= 1.0.0)
- Azure.Security.KeyVault.Secrets (>= 4.11.1)
- Google.Protobuf (>= 3.36.1)
- Grpc.AspNetCore (>= 2.83.0)
- Grpc.Net.ClientFactory (>= 2.83.0)
- Grpc.Tools (>= 2.83.0)
- Hex1b (>= 0.168.0)
- KubernetesClient (>= 19.0.2)
- MessagePack (>= 2.5.307)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.12)
- Microsoft.Extensions.Configuration.Binder (>= 10.0.12)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 10.0.12)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.12)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.31)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.12)
- Microsoft.Extensions.Hosting (>= 10.0.12)
- Microsoft.Extensions.Hosting.Abstractions (>= 10.0.12)
- Microsoft.Extensions.Http (>= 10.0.12)
- Microsoft.Extensions.Logging (>= 10.0.12)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.12)
- Microsoft.Extensions.Options (>= 10.0.12)
- Microsoft.Extensions.Primitives (>= 10.0.12)
- ModelContextProtocol (>= 1.4.1)
- Newtonsoft.Json (>= 13.0.4)
- OpenTelemetry.Exporter.OpenTelemetryProtocol (>= 1.17.0)
- OpenTelemetry.Extensions.Hosting (>= 1.17.0)
- Polly.Core (>= 8.7.0)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.25.29)
- System.IO.Hashing (>= 10.0.12)
- System.Text.Json (>= 10.0.12)
- YamlDotNet (>= 18.1.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Aspire.Hosting.Azure.SignalR:
| Package | Downloads |
|---|---|
|
Aspire.Hosting.Azure.Provisioning.SignalR
Opt-in Azure Provisioning SignalR APIs for polyglot Aspire AppHosts. |
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.6.4 | 1,319 | 10/24/2026 |
| 13.6.3 | 1,462 | 10/21/2026 |
| 13.6.2 | 1,156 | 10/20/2026 |
| 13.6.1 | 11,803 | 10/7/2026 |
| 13.6.0 | 14,107 | 9/29/2026 |
| 13.5.4 | 48,461 | 9/15/2026 |
| 13.5.3 | 10,975 | 8/25/2026 |
| 13.5.2 | 2,946 | 8/21/2026 |
| 13.5.1 | 818 | 8/20/2026 |
| 13.5.0 | 3,510 | 8/18/2026 |
| 13.4.6 | 38,298 | 6/19/2026 |
| 13.4.5 | 1,918 | 6/17/2026 |
| 13.4.4 | 4,677 | 6/15/2026 |
| 13.4.3 | 7,131 | 6/8/2026 |
| 13.4.2 | 89,631 | 6/3/2026 |
| 13.4.1 | 733 | 6/3/2026 |
| 13.4.0 | 1,942 | 6/1/2026 |
| 13.3.5 | 21,373 | 5/21/2026 |
| 13.3.4 | 2,208 | 5/19/2026 |
| 13.3.3 | 1,980 | 5/15/2026 |