Bibliothèque de client du service Azure Web PubSub pour .NET

Article
10/26/2023

Le service Azure Web PubSub est un service géré Azure qui aide les développeurs à créer facilement des applications web avec des fonctionnalités en temps réel et un modèle publication-abonnement. Tout scénario qui nécessite une messagerie de type publication-abonnement en temps réel entre un serveur et des clients ou entre des clients peut avoir recours au service Azure Web PubSub. Les fonctionnalités en temps réel traditionnelles qui demandent souvent d’interroger un serveur ou d’envoyer des requêtes HTTP peuvent aussi utiliser le service Azure Web PubSub.

Vous pouvez utiliser cette bibliothèque dans vos applications côté serveur pour gérer les connexions client WebSocket, comme indiqué dans le diagramme ci-dessous :

The overflow diagram shows the overflow of using the service client library.

Utilisez cette bibliothèque pour effectuer les opérations suivantes :

Envoyer des messages à des hubs et des groupes.
Envoyer des messages à des utilisateurs et des connexions particuliers.
Organiser des utilisateurs et des connexions en groupes.
Fermer les connexions
Accorder, révoquer et vérifier des autorisations pour une connexion existante

Code source | Package | Documentation de référence de l’API | Documentation du produit | Exemples

Bien démarrer

Installer le package

Installer la bibliothèque de client pour NuGet :

dotnet add package Azure.Messaging.WebPubSub

Prérequis

Un abonnement Azure
Une instance de service Azure Web PubSub existante.

Créez et authentifiez un`WebPubSubServiceClient`

Pour interagir avec le service, vous devez créer une instance de la classe WebPubSubServiceClient. Pour que cela soit possible, vous avez besoin de la chaîne de connexion ou d’une clé, à laquelle vous pouvez accéder dans le portail Azure.

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

Exemples

Diffuser un message texte à tous les clients

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

serviceClient.SendToAll("Hello World!");

Diffuser un message JSON à tous les clients

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

serviceClient.SendToAll(RequestContent.Create(
        new
        {
            Foo = "Hello World!",
            Bar = 42
        }),
        ContentType.ApplicationJson);

Diffuser un message binaire à tous les clients

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

Stream stream = BinaryData.FromString("Hello World!").ToStream();
serviceClient.SendToAll(RequestContent.Create(stream), ContentType.ApplicationOctetStream);