Get started with the Azure SignalR Service integration

Azure SignalR Service is a fully managed real-time messaging service that simplifies adding real-time web functionality to applications. The Aspire Azure SignalR Service integration enables you to connect to Azure SignalR instances from your applications.

In this introduction, you’ll see how to install and use the Aspire Azure SignalR Service integrations in a simple configuration. If you already have this knowledge, see Azure SignalR Service Hosting integration for full reference details.

Note

To follow this guide, you must have created an Aspire solution to work with. To learn how to do that, see Build your first Aspire app.

Set up hosting integration

To begin, install the Aspire Azure SignalR Service Hosting integration in your Aspire AppHost project. This integration allows you to create and manage Azure SignalR Service resources from your Aspire hosting projects:

Aspire CLI

Aspire CLI — Add Aspire.Hosting.Azure.SignalR package

aspire add azure-signalr

The Aspire CLI is interactive, be sure to select the appropriate search result when prompted:

Aspire CLI — Example output prompt

Select an integration to add:

> azure-signalr (Aspire.Hosting.Azure.SignalR)
> Other results listed as selectable options...

Note

If there's only one result, the CLI selects it automatically. You'll still need to confirm the version.

apphost.cs (C# file-based app)

C# — AppHost.cs

#:package Aspire.Hosting.Azure.SignalR@*

PackageReference (*.csproj)

XML — Add Aspire.Hosting.Azure.SignalR package reference

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

Next, in the AppHost project, create an Azure SignalR Service resource and pass it to the consuming projects:

C# — AppHost.cs

var builder = DistributedApplication.CreateBuilder(args);

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

var api = builder.AddProject<Projects.ApiService>("api")
    .WithReference(signalR)
    .WaitFor(signalR);

builder.AddProject<Projects.WebApp>("webapp")
    .WithReference(api)
    .WaitFor(api);

// After adding all resources, run the app...

builder.Build().Run();

The preceding code adds an Azure SignalR Service resource named signalr to the AppHost project. The api project references the SignalR service and the webapp project references the API.

Caution

When you call AddAzureSignalR, it implicitly calls AddAzureProvisioning—which adds support for generating Azure resources dynamically during app startup. The app must configure the appropriate subscription and location. For more information, see Local provisioning: Configuration.

Tip

This is the simplest implementation of Azure SignalR Service resources in the AppHost. There are many more options you can choose from to address your requirements. For full details, see Azure SignalR Service Hosting integration.

Set up hub host integration

To use Azure SignalR Service from your hub host applications, install the SignalR package in your project:

.NET CLI

.NET CLI — Add Microsoft.Azure.SignalR package

dotnet add package Microsoft.Azure.SignalR

Program.cs (C# file-based app)

Program.cs

#:package Microsoft.Azure.SignalR@*

PackageReference (*.csproj)

XML — Add Microsoft.Azure.SignalR package reference

<PackageReference Include="Microsoft.Azure.SignalR" Version="*" />

In the Program.cs file of your hub host project, configure Azure SignalR Service by chaining calls to .AddSignalR().AddNamedAzureSignalR("name"):

var builder = WebApplication.CreateBuilder(args);

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

var app = builder.Build();

app.MapHub<ChatHub>("/chat");

app.Run();

Tip

The name parameter must match the name used when adding the Azure SignalR Service resource in the AppHost project.

For full details on using the hub host integration, see Azure SignalR Service Hub host integration.

Next steps

Azure SignalR Service Hosting integration Learn more about the hosting integration features and capabilities

Azure SignalR Service Hub host integration Learn how to use the Azure SignalR Service hub host integration