Szybki start: Połączenie do wystąpienia usługi Azure Web PubSub z poziomu interfejsu wiersza polecenia
W tym przewodniku Szybki start pokazano, jak nawiązać połączenie z wystąpieniem usługi Azure Web PubSub i opublikować komunikaty do połączonych klientów przy użyciu interfejsu wiersza polecenia platformy Azure.
Jeśli nie masz subskrypcji platformy Azure, przed rozpoczęciem utwórz bezpłatne konto platformy Azure.
Wymagania wstępne
Użyj środowiska powłoki Bash w usłudze Azure Cloud Shell. Aby uzyskać więcej informacji, zobacz Szybki start dotyczący powłoki Bash w usłudze Azure Cloud Shell.
Jeśli wolisz uruchamiać polecenia referencyjne interfejsu wiersza polecenia lokalnie, zainstaluj interfejs wiersza polecenia platformy Azure. Jeśli korzystasz z systemu Windows lub macOS, rozważ uruchomienie interfejsu wiersza polecenia platformy Azure w kontenerze Docker. Aby uzyskać więcej informacji, zobacz Jak uruchomić interfejs wiersza polecenia platformy Azure w kontenerze platformy Docker.
Jeśli korzystasz z instalacji lokalnej, zaloguj się do interfejsu wiersza polecenia platformy Azure za pomocą polecenia az login. Aby ukończyć proces uwierzytelniania, wykonaj kroki wyświetlane w terminalu. Aby uzyskać inne opcje logowania, zobacz Logowanie się przy użyciu interfejsu wiersza polecenia platformy Azure.
Po wyświetleniu monitu zainstaluj rozszerzenie interfejsu wiersza polecenia platformy Azure podczas pierwszego użycia. Aby uzyskać więcej informacji na temat rozszerzeń, zobacz Korzystanie z rozszerzeń w interfejsie wiersza polecenia platformy Azure.
Uruchom polecenie az version, aby znaleźć zainstalowane wersje i biblioteki zależne. Aby uaktualnić do najnowszej wersji, uruchom polecenie az upgrade.
- Ten przewodnik Szybki start wymaga wersji 2.22.0 lub nowszej interfejsu wiersza polecenia platformy Azure. W przypadku korzystania z usługi Azure Cloud Shell najnowsza wersja jest już zainstalowana.
Tworzenie grupy zasobów
Grupa zasobów to logiczny kontener przeznaczony do wdrażania zasobów platformy Azure i zarządzania nimi. Użyj polecenia az group create, aby utworzyć grupę zasobów o nazwie myResourceGroup
w eastus
lokalizacji.
az group create --name myResourceGroup --location EastUS
Tworzenie wystąpienia usługi Web PubSub
Uruchom polecenie az extension add , aby zainstalować lub uaktualnić rozszerzenie webpubsub do bieżącej wersji.
az extension add --upgrade --name webpubsub
Użyj polecenia az webpubsub create interfejsu wiersza polecenia platformy Azure, aby utworzyć internetowy pubSub w utworzonej grupie zasobów. Następujące polecenie tworzy zasób Free Web PubSub w grupie zasobów myResourceGroup w regionie EastUS:
Ważne
Każdy zasób Web PubSub musi mieć unikatową nazwę. Zastąp <ciąg your-unique-resource-name> nazwą usługi Web PubSub w poniższych przykładach.
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
Dane wyjściowe tego polecenia pokazują właściwości nowo utworzonego zasobu. Zanotuj dwie poniższe właściwości:
- Nazwa zasobu: nazwa podana powyżej parametru
--name
. - hostName: w przykładzie nazwa hosta to
<your-unique-resource-name>.webpubsub.azure.com/
.
W tym momencie Twoje konto platformy Azure jest jedynym autoryzowanym do wykonywania jakichkolwiek operacji na tym nowym zasobie.
Odtwarzanie z wystąpieniem
Połączenie do usługi
Użyj polecenia az webpubsub client interfejsu wiersza polecenia platformy Azure, aby uruchomić połączenie klienta protokołu WebSocket z usługą utworzoną w poprzednim kroku, podając następujące informacje:
- Nazwa centrum: ciąg od 1 do 127 znaków. Powinien zaczynać się od znaków
(a-z, A-Z)
alfabetycznych i zawierać tylko znaki alfanumeryczne(0-9, a-z, A-Z)
lub podkreślenie(_)
.
Hub to logiczny zestaw połączonych połączeń protokołu WebSocket. Aby uzyskać szczegółowe informacje na temat pojęć, zobacz Informacje o centrach, grupach i połączeniach .
Ważne
Zastąp <ciąg your-unique-resource-name> nazwą zasobu Web PubSub utworzonego na podstawie poprzednich kroków.
- Nazwa centrum: myHub1.
- Nazwa grupy zasobów: myResourceGroup.
- Identyfikator użytkownika: user1
az webpubsub client start --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --user-id "user1"
Widać, że polecenie nawiązało połączenie protokołu WebSocket z usługą Web PubSub i odebrano komunikat JSON wskazujący, że jest on teraz pomyślnie połączony i jest przypisany z unikatowym connectionId
elementem :
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
Odtwórz ją i spróbuj dołączyć do grup przy użyciu polecenia i wysłać komunikaty do grup przy użyciu joingroup <group-name>
polecenia sendtogroup <group-name>
:
joingroup group1
sendtogroup group1 hello
Publikowanie komunikatów i zarządzanie klientami
Interfejs wiersza polecenia platformy Azure udostępnia również polecenia az webpubsub service do zarządzania połączeniami klienta.
Otwórz inne polecenie interfejsu wiersza polecenia i możesz rozgłaszać komunikaty do klientów:
- Nazwa centrum: myHub1.
- Nazwa grupy zasobów: myResourceGroup.
az webpubsub service broadcast --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --payload "Hello World"
Wróć do poprzedniego polecenia interfejsu wiersza polecenia i zobaczysz, że klient otrzymał komunikat:
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
Możesz również wyświetlić listę wszystkich dostępnych poleceń przy użyciu opcji i odtworzyć je za pomocą --help
wymienionych poleceń.
az webpubsub service --help
Następne kroki
Ten przewodnik Szybki start zawiera podstawowe informacje na temat nawiązywania połączenia z usługą Web PubSub i publikowania komunikatów na połączonych klientach.
W rzeczywistych aplikacjach można używać zestawów SDK w różnych językach tworzących własną aplikację. Udostępniamy również rozszerzenia funkcji do łatwego kompilowania aplikacji bezserwerowych.
Użyj tych zasobów, aby rozpocząć tworzenie własnej aplikacji: