Schnellstart: Herstellen einer Verbindung mit der Azure Web PubSub-Instanz über die CLI
In dieser Schnellstartanleitung erfahren Sie, wie Sie über die Azure CLI eine Verbindung mit der Azure Web PubSub-Instanz herstellen und Nachrichten an die verbundenen Clients veröffentlichen.
Wenn Sie kein Azure-Abonnement haben, erstellen Sie ein kostenloses Azure-Konto, bevor Sie beginnen.
Voraussetzungen
Verwenden Sie die Bash-Umgebung in Azure Cloud Shell. Weitere Informationen finden Sie unter Schnellstart für Bash in Azure Cloud Shell.
Wenn Sie CLI-Referenzbefehle lieber lokal ausführen, installieren Sie die Azure CLI. Wenn Sie Windows oder macOS ausführen, sollten Sie die Azure CLI in einem Docker-Container ausführen. Weitere Informationen finden Sie unter Ausführen der Azure CLI in einem Docker-Container.
Wenn Sie eine lokale Installation verwenden, melden Sie sich mithilfe des Befehls az login bei der Azure CLI an. Führen Sie die in Ihrem Terminal angezeigten Schritte aus, um den Authentifizierungsprozess abzuschließen. Informationen zu anderen Anmeldeoptionen finden Sie unter Anmelden mit der Azure CLI.
Installieren Sie die Azure CLI-Erweiterung beim ersten Einsatz, wenn Sie dazu aufgefordert werden. Weitere Informationen zu Erweiterungen finden Sie unter Verwenden von Erweiterungen mit der Azure CLI.
Führen Sie az version aus, um die installierte Version und die abhängigen Bibliotheken zu ermitteln. Führen Sie az upgrade aus, um das Upgrade auf die aktuelle Version durchzuführen.
- Für diese Schnellstartanleitung ist mindestens Version 2.22.0 der Azure CLI erforderlich. Bei Verwendung von Azure Cloud Shell ist die aktuelle Version bereits installiert.
Erstellen einer Ressourcengruppe
Eine Ressourcengruppe ist ein logischer Container, in dem Azure-Ressourcen bereitgestellt und verwaltet werden. Erstellen Sie mithilfe des Befehls az group create eine Ressourcengruppe namens myResourceGroup in der Region eastus.
az group create --name myResourceGroup --location EastUS
Erstellen einer Web PubSub-Instanz
Führen Sie az extension add aus, um die Erweiterung webpubsub zu installieren bzw. auf die aktuelle Version zu aktualisieren.
az extension add --upgrade --name webpubsub
Verwenden Sie den Azure CLI-Befehl az webpubsub create, um eine Web PubSub-Instanz in der erstellten Ressourcengruppe zu erstellen. Mit dem folgenden Befehl wird eine Kostenlose Web-PubSub-Ressource unter der Ressourcengruppe myResourceGroup in USA, Osten erstellt:
Wichtig
Jede Web PubSub-Ressource muss einen eindeutigen Namen haben. Ersetzen Sie in den folgenden Beispielen <your-unique-resource-name> durch den Namen Ihrer Web PubSub-Instanz.
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
In der Ausgabe dieses Befehls werden die Eigenschaften der neu erstellten Ressource angezeigt. Beachten Sie die beiden folgenden Eigenschaften:
- Resource Name: Der Name, den Sie oben für den Parameter
--nameangegeben haben. - hostName: Im Beispiel lautet der Hostname
<your-unique-resource-name>.webpubsub.azure.com/.
An diesem Punkt ist nur Ihr Azure-Konto zum Ausführen von Vorgängen für die neue Ressource autorisiert.
Testen der Instanz
Herstellen einer Verbindung mit dem Dienst
Verwenden Sie den Befehl az webpubsub client der Azure CLI, um eine WebSocket-Clientverbindung mit dem Dienst zu erstellen, der im vorherigen Schritt erstellt wurde. Geben Sie dabei die folgenden Informationen an:
- Hubname: Eine Zeichenfolge mit 1 bis 127 Zeichen. Sie sollte mit alphabetischen Zeichen
(a-z, A-Z)beginnen und nur alphanumerische Zeichen(0-9, a-z, A-Z)oder Unterstriche(_)enthalten.
Ein Hub ist ein logischer Satz der verbundenen WebSocket-Verbindungen. Ausführliche Informationen zu den Konzepten finden Sie unter Grundlegende Azure Web PubSub-Konzepte.
Wichtig
Ersetzen Sie <your-unique-resource-name> durch den Namen Ihrer Web PubSub-Instanz, die in den vorherigen Schritten erstellt wurde.
- Hubname: myHub1
- Ressourcengruppennamen: myResourceGroup
- Benutzer-ID: user1
az webpubsub client start --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --user-id "user1"
Sie sehen, dass der Befehl eine WebSocket-Verbindung mit dem Web PubSub-Dienst hergestellt hat und sie eine JSON-Nachricht mit dem Hinweis erhalten haben, dass die Verbindung nun erfolgreich hergestellt und ihr eine eindeutige ID (connectionId) zugewiesen wurde:
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
Experimentieren Sie damit, und versuchen Sie, mithilfe von joingroup <group-name> Gruppen beizutreten und mithilfe von sendtogroup <group-name> Nachrichten an Gruppen zu senden:
joingroup group1
sendtogroup group1 hello
Veröffentlichen von Nachrichten und Verwalten der Clients
Über die Azure CLI stehen außerdem Befehle vom Typ az webpubsub service zum Verwalten der Clientverbindungen zur Verfügung.
Öffnen Sie einen weiteren CLI-Befehl, und Sie können Nachrichten an die Clients übertragen:
- Hubname: myHub1
- Ressourcengruppennamen: myResourceGroup
az webpubsub service broadcast --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --payload "Hello World"
Wechseln Sie zurück zum vorherigen CLI-Befehl. Sie sehen, dass der Client eine Nachricht empfangen hat:
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
Sie können auch alle verfügbaren Befehle mithilfe der Option --help auflisten und die aufgeführten Befehle ausprobieren.
az webpubsub service --help
Nächste Schritte
In dieser Schnellstartanleitung erhalten Sie grundlegende Informationen dazu, wie Sie eine Verbindung mit dem Web PubSub-Dienst herstellen und Nachrichten auf den verbundenen Clients veröffentlichen.
In realen Anwendungen können Sie SDKs in verschiedenen Sprachen verwenden, um Ihre eigene Anwendung zu erstellen. Außerdem werden Funktionserweiterungen zur Verfügung gestellt, mit deren Hilfe Sie problemlos serverlose Anwendungen erstellen können.
Erstellen Sie mithilfe dieser Ressourcen Ihre eigene Anwendung: