Aspire.Hosting.Azure.WebPubSub
13.6.4
Prefix Reserved
dotnet add package Aspire.Hosting.Azure.WebPubSub --version 13.6.4
NuGet\Install-Package Aspire.Hosting.Azure.WebPubSub -Version 13.6.4
<PackageReference Include="Aspire.Hosting.Azure.WebPubSub" Version="13.6.4" />
<PackageVersion Include="Aspire.Hosting.Azure.WebPubSub" Version="13.6.4" />
<PackageReference Include="Aspire.Hosting.Azure.WebPubSub" />
paket add Aspire.Hosting.Azure.WebPubSub --version 13.6.4
#r "nuget: Aspire.Hosting.Azure.WebPubSub, 13.6.4"
#:package Aspire.Hosting.Azure.WebPubSub@13.6.4
#addin nuget:?package=Aspire.Hosting.Azure.WebPubSub&version=13.6.4
#tool nuget:?package=Aspire.Hosting.Azure.WebPubSub&version=13.6.4
Azure Web PubSub hosting integration
Use this integration to model, configure, and orchestrate Azure Web PubSub 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.WebPubSub integration with the Aspire CLI:
aspire add Aspire.Hosting.Azure.WebPubSub
Usage example
In the AppHost, add a WebPubSub connection and reference it from another resource with either C# or TypeScript:
C#
var wps = builder.AddAzureWebPubSub("wps1");
var web = builder.AddProject<Projects.WebPubSubWeb>("webfrontend")
.WithReference(wps);
TypeScript
const wps = await builder.addAzureWebPubSub("wps1");
const web = await builder.addNodeApp("webfrontend", "../web-frontend", "server.js")
.withReference(wps);
Connection Properties
When you reference an Azure Web PubSub resource using WithReference, the following connection properties are made available to the consuming project:
| Property Name | Description |
|---|---|
Uri |
The HTTPS endpoint for the Web PubSub service, typically https://<resource-name>.webpubsub.azure.com/ |
Aspire exposes each property as an environment variable named [RESOURCE]_[PROPERTY]. For instance, the Uri property of a resource called wps1 becomes WPS1_URI.
Additional documentation
- https://aspire.dev/integrations/gallery/
- https://aspire.dev/integrations/cloud/azure/azure-web-pubsub/azure-web-pubsub-host/
- https://learn.microsoft.com/azure/azure-web-pubsub/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.WebPubSub (>= 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.WebPubSub:
| Package | Downloads |
|---|---|
|
Aspire.Hosting.Azure.Provisioning.WebPubSub
Opt-in Azure Provisioning Web PubSub APIs for polyglot Aspire AppHosts. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 13.6.4 | 77 | 10/24/2026 |
| 13.6.3 | 108 | 10/21/2026 |
| 13.6.2 | 111 | 10/20/2026 |
| 13.6.1 | 176 | 10/7/2026 |
| 13.6.0 | 234 | 9/29/2026 |
| 13.5.4 | 321 | 9/15/2026 |
| 13.5.3 | 238 | 8/25/2026 |
| 13.5.2 | 152 | 8/21/2026 |
| 13.5.1 | 173 | 8/20/2026 |
| 13.5.0 | 174 | 8/18/2026 |
| 13.4.6 | 622 | 6/19/2026 |
| 13.4.5 | 188 | 6/17/2026 |
| 13.4.4 | 156 | 6/15/2026 |
| 13.4.3 | 207 | 6/8/2026 |
| 13.4.2 | 175 | 6/3/2026 |
| 13.4.1 | 152 | 6/3/2026 |
| 13.4.0 | 269 | 6/1/2026 |
| 13.3.5 | 550 | 5/21/2026 |
| 13.3.4 | 153 | 5/19/2026 |
| 13.3.3 | 159 | 5/15/2026 |