Snabbstart: Ansluta till Azure Web PubSub-instansen från CLI
Den här snabbstarten visar hur du ansluter till Azure Web PubSub-instansen och publicerar meddelanden till anslutna klienter med hjälp av Azure CLI.
Om du inte har en Azure-prenumeration skapar du ett kostnadsfritt Azure-konto innan du börjar.
Förutsättningar
Använd Bash-miljön i Azure Cloud Shell. Mer information finns i Snabbstart för Bash i Azure Cloud Shell.
Om du föredrar att köra CLI-referenskommandon lokalt installerar du Azure CLI. Om du kör i Windows eller macOS kan du köra Azure CLI i en Docker-container. Mer information finns i Så här kör du Azure CLI i en Docker-container.
Om du använder en lokal installation loggar du in på Azure CLI med hjälp av kommandot az login. Slutför autentiseringsprocessen genom att följa stegen som visas i terminalen. Andra inloggningsalternativ finns i Logga in med Azure CLI.
När du uppmanas att installera Azure CLI-tillägget vid första användningen. Mer information om tillägg finns i Använda tillägg med Azure CLI.
Kör az version om du vill hitta versionen och de beroende bibliotek som är installerade. Om du vill uppgradera till den senaste versionen kör du az upgrade.
- Den här snabbstarten kräver version 2.22.0 eller senare av Azure CLI. Om du använder Azure Cloud Shell är den senaste versionen redan installerad.
Skapa en resursgrupp
En resursgrupp är en logisk container där Azure-resurser distribueras och hanteras. Använd kommandot az group create för att skapa en resursgrupp med namnet myResourceGroup på eastus platsen.
az group create --name myResourceGroup --location EastUS
Skapa en Web PubSub-instans
Kör az extension add för att installera eller uppgradera webpubsub-tillägget till den aktuella versionen.
az extension add --upgrade --name webpubsub
Använd kommandot Azure CLI az webpubsub create för att skapa en Web PubSub i resursgruppen som du har skapat. Följande kommando skapar en Free Web PubSub-resurs under resursgruppen myResourceGroup i EastUS:
Viktigt!
Varje Web PubSub-resurs måste ha ett unikt namn. Ersätt <ditt unika resursnamn> med namnet på din Web PubSub i följande exempel.
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
Utdata från det här kommandot visar egenskaperna för den nyligen skapade resursen. Anteckna de två egenskaperna som visas nedan:
- Resursnamn: Det namn som du angav i parametern
--nameovan. - hostName: I exemplet är
<your-unique-resource-name>.webpubsub.azure.com/värdnamnet .
I det här läget är ditt Azure-konto det enda som har behörighet att utföra åtgärder på den nya resursen.
Spela upp med instansen
Ansluta till tjänsten
Använd azure CLI az webpubsub-klientkommandot för att starta en WebSocket-klientanslutning till tjänsten som skapades från föregående steg, med följande information:
- Hubbnamn: En sträng på 1 till 127 tecken. Den bör börja med alfabetiska tecken
(a-z, A-Z)och endast innehålla alfanumeriska(0-9, a-z, A-Z)tecken eller understreck(_).
Hubb är en logisk uppsättning av anslutna WebSocket-anslutningar. Mer information om begreppen finns i Om hubbar, grupper och anslutningar .
Viktigt!
Ersätt <ditt unika resursnamn> med namnet på din Web PubSub-resurs som skapades från föregående steg.
- Hubbnamn: myHub1.
- Resursgruppsnamn: myResourceGroup.
- Användar-ID: user1
az webpubsub client start --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --user-id "user1"
Du kan se att kommandot upprättade en WebSocket-anslutning till Web PubSub-tjänsten och du fick ett JSON-meddelande som anger att den nu är ansluten och tilldelas med ett unikt connectionId:
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
Spela med den och försök att ansluta till grupper med hjälp av joingroup <group-name> och skicka meddelanden till grupper med hjälp av sendtogroup <group-name>:
joingroup group1
sendtogroup group1 hello
Publicera meddelanden och hantera klienterna
Azure CLI tillhandahåller även az webpubsub service-kommandon för att hantera klientanslutningarna.
Öppna ett annat CLI-kommando så kan du skicka meddelanden till klienterna:
- Hubbnamn: myHub1.
- Resursgruppsnamn: myResourceGroup.
az webpubsub service broadcast --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --payload "Hello World"
Växla tillbaka till föregående CLI-kommando så kan du se att klienten tog emot meddelandet:
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
Du kan också lista alla tillgängliga kommandon med hjälp av --help alternativet och spela upp med de kommandon som visas.
az webpubsub service --help
Nästa steg
Den här snabbstarten ger dig en grundläggande uppfattning om hur du ansluter till Web PubSub-tjänsten och hur du publicerar meddelanden till anslutna klienter.
I verkliga program kan du använda SDK:er på olika språk och skapa ett eget program. Vi tillhandahåller även funktionstillägg som du enkelt kan använda för att skapa serverlösa program.
Använd dessa resurser för att börja skapa ett eget program: