Démarrage rapide : Connexion à l’instance Azure Web PubSub à partir de l’interface CLI
Ce démarrage rapide montre comment se connecter à l’instance Azure Web PubSub et publier des messages sur les clients connectés avec Azure CLI.
Si vous n’avez pas d’abonnement Azure, créez un compte gratuit Azure avant de commencer.
Prérequis
Utilisez l’environnement Bash dans Azure Cloud Shell. Pour plus d’informations, consultez Démarrage rapide pour Bash dans Azure Cloud Shell.
Si vous préférez exécuter les commandes de référence de l’interface de ligne de commande localement, installez l’interface Azure CLI. Si vous exécutez sur Windows ou macOS, envisagez d’exécuter Azure CLI dans un conteneur Docker. Pour plus d’informations, consultez Guide pratique pour exécuter Azure CLI dans un conteneur Docker.
Si vous utilisez une installation locale, connectez-vous à Azure CLI à l’aide de la commande az login. Pour finir le processus d’authentification, suivez les étapes affichées dans votre terminal. Pour connaître les autres options de connexion, consultez Se connecter avec Azure CLI.
Lorsque vous y êtes invité, installez l’extension Azure CLI lors de la première utilisation. Pour plus d’informations sur les extensions, consultez Utiliser des extensions avec Azure CLI.
Exécutez az version pour rechercher la version et les bibliothèques dépendantes installées. Pour effectuer une mise à niveau vers la dernière version, exécutez az upgrade.
- Ce guide de démarrage rapide nécessite la version 2.22.0 ou ultérieure de l’interface Azure CLI. Si vous utilisez Azure Cloud Shell, la version la plus récente est déjà installée.
Créer un groupe de ressources
Un groupe de ressources est un conteneur logique dans lequel les ressources Azure sont déployées et gérées. Utilisez la commande az group create pour créer un groupe de ressources nommé myResourceGroup à l’emplacement eastus.
az group create --name myResourceGroup --location EastUS
Créer une instance Web PubSub
Exécutez la commande az extension add pour installer ou mettre à niveau l’extension webpubsub vers la version actuelle.
az extension add --upgrade --name webpubsub
Utilisez la commande az webpubsub create d’Azure CLI pour créer une instance Web PubSub dans le groupe de ressources que vous avez créé. La commande suivante crée une ressource Web PubSub GRATUITE sous le groupe de ressources myResourceGroup dans la zone EastUS :
Important
Chaque ressource Web PubSub doit avoir un nom unique. Remplacez <your-unique-keyvault-name> par le nom de votre Web PubSub dans les exemples suivants.
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
La sortie de cette commande affiche les propriétés de la ressource que vous venez de créer. Notez les deux propriétés ci-dessous :
- Nom de la ressource : nom que vous avez fourni au paramètre
--nameci-dessus. - Nom d’hôte : dans l’exemple, le nom d’hôte est
<your-unique-resource-name>.webpubsub.azure.com/.
À ce stade, votre compte Azure est le seul autorisé à effectuer des opérations sur cette nouvelle ressource.
Jeu avec l’instance
Se connecter au service
Utilisez la commande az webpubsub client Azure CLI pour démarrer une connexion client WebSocket au service créé à l’étape précédente, en fournissant les informations suivantes :
- Nom du hub : chaîne de 1 à 127 caractères. Elle doit commencer par des caractères alphabétiques
(a-z, A-Z)et ne contenir que des caractères alpha-numériques(0-9, a-z, A-Z)ou trait de soulignement(_).
Hub est un ensemble logique des connexions WebSocket connectées. Vérifiez À propos des hubs, groupes et connexions pour obtenir des informations sur les concepts.
Important
Remplacez <your-unique-resource-name> par le nom de votre ressource Web PubSub créée précédemment.
- Nom de l’hub : myHub1.
- Groupe de ressources nommé : myResourceGroup.
- ID d’utilisateur : user1
az webpubsub client start --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --user-id "user1"
Vous pouvez voir que la commande a établi une connexion WebSocket au service Web PubSub et que vous avez reçu un message JSON indiquant qu’il est désormais connecté avec succès et qu’il est attribué avec un connectionId unique :
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
Testez l’instance et essayez de rejoindre des groupes à l’aide de joingroup <group-name> et envoyez des messages à des groupes à l’aide de sendtogroup <group-name> :
joingroup group1
sendtogroup group1 hello
Publier des messages et gérer les clients
Azure CLI fournit également les commandes az webpubsub service pour gérer les connexions client.
Ouvrez une autre commande CLI pour pouvoir diffuser des messages aux clients :
- Nom de l’hub : myHub1.
- Groupe de ressources nommé : myResourceGroup.
az webpubsub service broadcast --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --payload "Hello World"
Revenez à la commande CLI précédente pour pouvoir vérifier que le client a reçu le message :
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
Vous pouvez également répertorier toutes les commandes disponibles à l’aide de l'option --help et jouer avec les commandes répertoriées.
az webpubsub service --help
Étapes suivantes
Ce tutoriel donne une idée de base de la procédure à suivre pour se connecter au service Web PubSub et publier des messages sur les clients connectés.
Dans les applications réelles, vous pouvez utiliser des kits de développement logiciel (SDK) dans différents langages pour créer votre propre application. Nous fournissons également des extensions de fonction qui vous permettent de créer facilement des applications serverless.
Utilisez ces ressources pour commencer à créer votre propre application :