Azure.Messaging.WebPubSub 1.3.0

Prefix Reserved
dotnet add package Azure.Messaging.WebPubSub --version 1.3.0                
NuGet\Install-Package Azure.Messaging.WebPubSub -Version 1.3.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="Azure.Messaging.WebPubSub" Version="1.3.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Azure.Messaging.WebPubSub --version 1.3.0                
#r "nuget: Azure.Messaging.WebPubSub, 1.3.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.
// Install Azure.Messaging.WebPubSub as a Cake Addin
#addin nuget:?package=Azure.Messaging.WebPubSub&version=1.3.0

// Install Azure.Messaging.WebPubSub as a Cake Tool
#tool nuget:?package=Azure.Messaging.WebPubSub&version=1.3.0                

Azure Web PubSub service client library for .NET

Azure Web PubSub Service is an Azure-managed service that helps developers easily build web applications with real-time features and publish-subscribe pattern. Any scenario that requires real-time publish-subscribe messaging between server and clients or among clients can use Azure Web PubSub service. Traditional real-time features that often require polling from server or submitting HTTP requests can also use Azure Web PubSub service.

You can use this library in your app server side to manage the WebSocket client connections, as shown in below diagram:


Use this library to:

  • Send messages to hubs and groups.
  • Send messages to particular users and connections.
  • Organize users and connections into groups.
  • Close connections
  • Grant, revoke, and check permissions for an existing connection

Details about the terms used here are described in Key concepts section.

Source code | Package | API reference documentation | Product documentation | Samples

Getting started

Install the package

Install the client library from NuGet:

dotnet add package Azure.Messaging.WebPubSub


Create and authenticate a WebPubSubServiceClient

In order to interact with the service, you'll need to create an instance of the WebPubSubServiceClient class. To make this possible, you'll need the connection string or a key, which you can access in the Azure portal.

// Create a WebPubSubServiceClient that will authenticate using a key credential.
var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

Key concepts


A connection, also known as a client or a client connection, represents an individual WebSocket connection connected to the Web PubSub service. When successfully connected, a unique connection ID is assigned to this connection by the Web PubSub service.


A hub is a logical concept for a set of client connections. Usually you use one hub for one purpose, for example, a chat hub, or a notification hub. When a client connection is created, it connects to a hub, and during its lifetime, it belongs to that hub. Different applications can share one Azure Web PubSub service by using different hub names.


A group is a subset of connections to the hub. You can add a client connection to a group, or remove the client connection from the group, anytime you want. For example, when a client joins a chat room, or when a client leaves the chat room, this chat room can be considered to be a group. A client can join multiple groups, and a group can contain multiple clients.


Connections to Web PubSub can belong to one user. A user might have multiple connections, for example when a single user is connected across multiple devices or multiple browser tabs.


When a client is connected, it can send messages to the upstream application, or receive messages from the upstream application, through the WebSocket connection.


Generate the full URI containing access token for the connection to use when connects the Azure Web PubSub

// Generate client access URI for userA
serviceClient.GetClientAccessUri(userId: "userA");
// Generate client access URI with initial permissions
serviceClient.GetClientAccessUri(roles: new string[] { "webpubsub.joinLeaveGroup.group1", "webpubsub.sendToGroup.group1" });
// Generate client access URI with initial groups to join when the connection connects
serviceClient.GetClientAccessUri(groups: new string[] { "group1", "group2" });

Send messages to the connections

Broadcast a text message to all clients
var serviceClient = new WebPubSubServiceClient(connectionString, "some_hub");

serviceClient.SendToAll("Hello World!");
Broadcast a JSON message to all clients
var serviceClient = new WebPubSubServiceClient(connectionString, "some_hub");

            Foo = "Hello World!",
            Bar = 42
Broadcast a binary message to all clients
var serviceClient = new WebPubSubServiceClient(connectionString, "some_hub");

Stream stream = BinaryData.FromString("Hello World!").ToStream();
serviceClient.SendToAll(RequestContent.Create(stream), ContentType.ApplicationOctetStream);
Broadcast messages to clients using filter

Azure Web PubSub supports OData filter syntax to filter out the connections to send messages to.

Details about filter syntax please see OData filter syntax for Azure Web PubSub.

var serviceClient = new WebPubSubServiceClient(connectionString, "some_hub");

// Use filter to send text message to anonymous connections
        RequestContent.Create("Hello World!"),
        filter: ClientConnectionFilter.Create($"userId eq {null}"));

// Use filter to send JSON message to connections in groupA but not in groupB
var group1 = "GroupA";
var group2 = "GroupB";
            Foo = "Hello World!",
            Bar = 42
        filter: ClientConnectionFilter.Create($"{group1} in groups and not({group2} in groups)"));

Connection management

Add connections for some user to some group:
client.AddUserToGroup("some_group", "some_user");

// Avoid sending messages to users who do not exist.
if (client.UserExists("some_user").Value)
    client.SendToUser("some_user", "Hi, I am glad you exist!");

client.RemoveUserFromGroup("some_group", "some_user");
Remove connection from all groups
var client = new WebPubSubServiceClient(connectionString, "some_hub");


Setting up console logging

You can also easily enable console logging if you want to dig deeper into the requests you're making against the service.

Next steps

Please take a look at the samples directory for detailed examples on how to use this library.

You can also find more samples here.


This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (8)

Showing the top 5 NuGet packages that depend on Azure.Messaging.WebPubSub:

Package Downloads

Azure SDK client library for the WebPubSub service


Azure Functions extension for the WebPubSub service


Blazor.Ninja Local Client Package


Toggly.FeatureManagement extends Microsoft.FeatureManagement with extensions to handle feature state changes, Decorate and register services that are injected when a feature is on, feature usage tracking, and integration with


Software development kit to call RPC functions.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Azure.Messaging.WebPubSub:

Repository Stars
This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at or our versioned developer docs at
Version Downloads Last updated
1.3.0 560,809 11/21/2022
1.2.0 168,866 11/7/2022
1.1.0 4,297 10/29/2022
1.1.0-beta.1 1,080 8/11/2022
1.0.0 352,016 11/12/2021
1.0.0-beta.3 39,553 9/8/2021
1.0.0-beta.2 11,572 7/15/2021
1.0.0-beta.1 32,691 4/26/2021