Aspire.Hosting.Azure.SignalR
8.0.1
Prefix Reserved
dotnet add package Aspire.Hosting.Azure.SignalR --version 8.0.1
NuGet\Install-Package Aspire.Hosting.Azure.SignalR -Version 8.0.1
<PackageReference Include="Aspire.Hosting.Azure.SignalR" Version="8.0.1" />
paket add Aspire.Hosting.Azure.SignalR --version 8.0.1
#r "nuget: Aspire.Hosting.Azure.SignalR, 8.0.1"
// Install Aspire.Hosting.Azure.SignalR as a Cake Addin
#addin nuget:?package=Aspire.Hosting.Azure.SignalR&version=8.0.1
// Install Aspire.Hosting.Azure.SignalR as a Cake Tool
#tool nuget:?package=Aspire.Hosting.Azure.SignalR&version=8.0.1
Aspire.Hosting.Azure.SignalR library
Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure SignalR.
Getting started
Prerequisites
- Azure subscription - create one for free
Install the package
Install the .NET 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 .NET 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 Program.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");
Additional documentation
- https://github.com/dotnet/aspire/tree/main/src/Components/README.md
- https://learn.microsoft.com/dotnet/aspire/real-time/azure-signalr-scenario
- 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. |
-
net8.0
- Aspire.Hosting.Azure (>= 8.0.1)
- Azure.Provisioning (>= 0.2.0)
- Azure.Provisioning.SignalR (>= 0.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
8.0.1 | 495 | 5/21/2024 |
8.0.0 | 73 | 5/21/2024 |
8.0.0-preview.7.24251.11 | 176 | 5/7/2024 |
8.0.0-preview.6.24214.1 | 95 | 4/23/2024 |
8.0.0-preview.5.24201.12 | 89 | 4/9/2024 |