Aspire.Hosting.Azure.WebPubSub
13.1.0
Prefix Reserved
dotnet add package Aspire.Hosting.Azure.WebPubSub --version 13.1.0
NuGet\Install-Package Aspire.Hosting.Azure.WebPubSub -Version 13.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Aspire.Hosting.Azure.WebPubSub" Version="13.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Aspire.Hosting.Azure.WebPubSub" Version="13.1.0" />
<PackageReference Include="Aspire.Hosting.Azure.WebPubSub" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Aspire.Hosting.Azure.WebPubSub --version 13.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Aspire.Hosting.Azure.WebPubSub, 13.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Aspire.Hosting.Azure.WebPubSub@13.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Aspire.Hosting.Azure.WebPubSub&version=13.1.0
#tool nuget:?package=Aspire.Hosting.Azure.WebPubSub&version=13.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Aspire.Hosting.Azure.WebPubSub library
Provides extension methods and resource definitions for an Aspire AppHost to configure Azure Web PubSub.
Getting started
Prerequisites
- Azure subscription - create one for free
Install the package
Install the Aspire Azure Web PubSub Hosting library with NuGet:
dotnet add package Aspire.Hosting.Azure.WebPubSub
Usage example
In the AppHost.cs file of AppHost, add a WebPubSub connection and consume the connection using the following methods:
var wps = builder.AddAzureWebPubSub("wps1");
var web = builder.AddProject<Projects.WebPubSubWeb>("webfrontend")
.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
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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- Aspire.Hosting.Azure (>= 13.1.0)
- AspNetCore.HealthChecks.Uris (>= 9.0.0)
- Azure.Core (>= 1.50.0)
- Azure.Identity (>= 1.17.0)
- Azure.Provisioning (>= 1.4.0)
- Azure.Provisioning.KeyVault (>= 1.1.0)
- Azure.Provisioning.WebPubSub (>= 1.1.0)
- Azure.ResourceManager.Authorization (>= 1.1.6)
- Azure.ResourceManager.KeyVault (>= 1.3.3)
- Azure.ResourceManager.Resources (>= 1.11.1)
- Azure.Security.KeyVault.Secrets (>= 4.8.0)
- Google.Protobuf (>= 3.33.0)
- Grpc.AspNetCore (>= 2.71.0)
- Grpc.Net.ClientFactory (>= 2.71.0)
- Grpc.Tools (>= 2.72.0)
- Humanizer.Core (>= 2.14.1)
- JsonPatch.Net (>= 3.3.0)
- KubernetesClient (>= 18.0.5)
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.2)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 8.0.22)
- Microsoft.Extensions.FileSystemGlobbing (>= 10.0.1)
- Microsoft.Extensions.Hosting (>= 8.0.1)
- Microsoft.Extensions.Hosting.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.1)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.3)
- Microsoft.Extensions.Options (>= 8.0.2)
- Microsoft.Extensions.Primitives (>= 8.0.0)
- Newtonsoft.Json (>= 13.0.4)
- Polly.Core (>= 8.6.4)
- Semver (>= 3.0.0)
- StreamJsonRpc (>= 2.22.23)
- System.IO.Hashing (>= 9.0.10)
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 | |
|---|---|---|---|
| 13.1.0 | 376 | 12/17/2025 | |
| 13.0.2 | 335 | 12/4/2025 | |
| 13.0.1 | 463 | 11/26/2025 | |
| 13.0.0 | 645 | 11/11/2025 | |
| 9.5.2 | 604 | 10/23/2025 | |
| 9.5.1 | 447 | 10/3/2025 | |
| 9.5.0 | 509 | 9/25/2025 | |
| 9.4.2 | 474 | 9/2/2025 | |
| 9.4.1 | 427 | 8/12/2025 | |
| 9.4.0 | 379 | 7/29/2025 | |
| 9.3.1 | 637 | 6/10/2025 | |
| 9.3.0 | 464 | 5/19/2025 | |
| 9.2.1 | 401 | 4/24/2025 | |
| 9.2.0 | 1,015 | 4/10/2025 | |
| 9.1.0 | 8,391 | 2/25/2025 | |
| 9.0.0 | 2,347 | 11/12/2024 | |
| 9.0.0-preview.4.24511.1 | 419 | 10/15/2024 | |
| 8.2.2-preview.1.24521.5 | 254 | 10/24/2024 | |
| 8.2.1-preview.1.24473.4 | 384 | 9/26/2024 | |
| 8.2.0-preview.1.24428.5 | 429 | 8/29/2024 | |
| 8.1.0-preview.1.24373.2 | 685 | 7/23/2024 |