Skip to content

Latest commit

 

History

History
61 lines (38 loc) · 3.25 KB

azure-signalr-scenario.md

File metadata and controls

61 lines (38 loc) · 3.25 KB
Raw
title description ms.topic ms.date
.NET Aspire support for Azure SignalR Service
Learn how to use the Azure SignalR Service with .NET Aspire.
how-to
06/13/2024

.NET Aspire support for Azure SignalR Service

In this article, you learn how to use .NET Aspire to express an Azure SignalR Service resource. Demonstrating how to write a SignalR app is beyond the scope of this article. Instead, you explore an app that's already been written and how it's wired up with .NET Aspire. Like other Azure resources within the .NET Aspire app model, you benefit from simple provisioning and deployment with the Azure Developer CLI (azd). For more information, see Deploy a .NET Aspire project to Azure Container Apps using the azd (in-depth guide).

Hub host

The hub host project is where you host your SignalR hub, the project that calls xref:Microsoft.Extensions.DependencyInjection.SignalRDependencyInjectionExtensions.AddSignalR and xref:Microsoft.AspNetCore.SignalR.HubRouteBuilder.MapHub%2A for example.

Install the NuGet package

You need to install the Microsoft.Azure.SignalR NuGet package.

.NET CLI

dotnet add package Microsoft.Azure.SignalR

PackageReference

<PackageReference Include="Microsoft.Azure.SignalR"
                  Version="[SelectVersion]" />

For more information, see dotnet add package or Manage package dependencies in .NET applications.

Express the resource

Whichever project you're using to host your xref:Microsoft.AspNetCore.SignalR.Hub is where you'll wire up your Azure SignalR Service resource. The following example demonstrates how to use the AddNamedAzureSignalR extension method which is chained on the AddSignalR method:

:::code language="csharp" source="snippets/signalr/SignalR.ApiService/Program.cs" highlight="7-8,14":::

Calling AddNamedAzureSignalR adds Azure SignalR with the specified name, the connection string will be read from ConnectionStrings_{name}, the settings are loaded from Azure:SignalR:{name} section.

App host

In the app host project, you express an AzureSignalRResource with the AddAzureSignalR method. The following example demonstrates how the resource is referenced by the consuming project, in this case the Hub host project:

:::code language="csharp" source="snippets/signalr/SignalR.AppHost/Program.cs":::

In the preceding code:

  • The builder has its execution context checked to see if it's in publish mode.
  • When publishing the AddAzureSignalR method is called to express the AzureSignalRResource.
  • When not publishing, the AddConnectionString method is called to express an IResourceWithConnectionString to an existing resource.
  • The signalr resource is referenced by the Hub host project, in this case known as apiService.
  • The apiService project resource is referenced by the SignalR_Web project.

See also