Quickstart: Verbinding maken met het Azure Web PubSub-exemplaar vanuit CLI
In deze quickstart ziet u hoe u verbinding maakt met het Azure Web PubSub-exemplaar en berichten publiceert naar de verbonden clients met behulp van de Azure CLI.
Als u geen Azure-abonnement hebt, kunt u een gratis Azure-account maken voordat u begint.
Vereisten
Gebruik de Bash-omgeving in Azure Cloud Shell. Zie quickstart voor Bash in Azure Cloud Shell voor meer informatie.
Installeer de Azure CLI, indien gewenst, om CLI-referentieopdrachten uit te voeren. Als u in Windows of macOS werkt, kunt u Azure CLI uitvoeren in een Docker-container. Zie De Azure CLI uitvoeren in een Docker-container voor meer informatie.
Als u een lokale installatie gebruikt, meldt u zich aan bij Azure CLI met behulp van de opdracht az login. Volg de stappen die worden weergegeven in de terminal, om het verificatieproces te voltooien. Raadpleeg Aanmelden bij Azure CLI voor aanvullende aanmeldingsopties.
Installeer de Azure CLI-extensie bij het eerste gebruik, wanneer u hierom wordt gevraagd. Raadpleeg Extensies gebruiken met Azure CLI voor meer informatie over extensies.
Voer az version uit om de geïnstalleerde versie en afhankelijke bibliotheken te vinden. Voer az upgrade uit om te upgraden naar de nieuwste versie.
- Voor deze quickstart is versie 2.22.0 of hoger van de Azure CLI vereist. Als u Azure Cloud Shell gebruikt, is de nieuwste versie al geïnstalleerd.
Een brongroep maken
Een resourcegroep is een logische container waarin Azure-resources worden geïmplementeerd en beheerd. Gebruik de opdracht az group create om een resourcegroep te maken met de naam myResourceGroup
op de eastus
locatie.
az group create --name myResourceGroup --location EastUS
Een Web PubSub-exemplaar maken
Voer az extension add uit om de webpubsub-extensie te installeren of bij te werken naar de huidige versie.
az extension add --upgrade --name webpubsub
Gebruik de azure CLI az webpubsub create command om een Web PubSub te maken in de resourcegroep die u hebt gemaakt. Met de volgende opdracht maakt u een gratis Web PubSub-resource onder resourcegroep myResourceGroup in EastUS:
Belangrijk
Elke Web PubSub-resource moet een unieke naam hebben. Vervang <uw unieke resourcenaam> door de naam van uw Web PubSub in de volgende voorbeelden.
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
In de uitvoer van deze opdracht ziet u eigenschappen van de zojuist gemaakte resource. Let op de onderstaande twee eigenschappen:
- Resourcenaam: de naam die u hebt opgegeven voor de
--name
bovenstaande parameter. - hostName: In het voorbeeld is
<your-unique-resource-name>.webpubsub.azure.com/
de hostnaam .
Op dit moment is uw Azure-account de enige die gemachtigd is om bewerkingen uit te voeren op deze nieuwe resource.
Afspelen met het exemplaar
Verbinding maken met de service
Gebruik de Azure CLI az webpubsub client command om een WebSocket-clientverbinding te starten met de service die u in de vorige stap hebt gemaakt, met de volgende informatie:
- Hubnaam: een tekenreeks van 1 tot 127 tekens. Deze moet beginnen met alfabetische tekens
(a-z, A-Z)
en mag alleen alfanumerieke(0-9, a-z, A-Z)
tekens of onderstrepingstekens(_)
bevatten.
Hub is een logische set verbonden WebSocket-verbindingen. Controleer over hubs, groepen en verbindingen voor meer informatie over de concepten.
Belangrijk
Vervang <uw unieke resourcenaam door de naam van uw Web PubSub-resource> die u in de vorige stappen hebt gemaakt.
- Hubnaam: myHub1.
- Naam van resourcegroep: myResourceGroup.
- Gebruikers-id: gebruiker1
az webpubsub client start --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --user-id "user1"
U kunt zien dat de opdracht een WebSocket-verbinding tot stand heeft gebracht met de Web PubSub-service en u een JSON-bericht hebt ontvangen dat aangeeft dat deze nu is verbonden en is toegewezen met een uniek:connectionId
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
Speel ermee af en probeer deel te nemen aan groepen met behulp van joingroup <group-name>
en berichten te verzenden naar groepen met behulp van sendtogroup <group-name>
:
joingroup group1
sendtogroup group1 hello
Berichten publiceren en de clients beheren
Azure CLI biedt ook az webpubsub service-opdrachten voor het beheren van de clientverbindingen.
Open een andere CLI-opdracht en u kunt berichten uitzenden naar de clients:
- Hubnaam: myHub1.
- Naam van resourcegroep: myResourceGroup.
az webpubsub service broadcast --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --payload "Hello World"
Ga terug naar de vorige CLI-opdracht en u kunt zien dat het bericht dat de client heeft ontvangen:
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
U kunt ook alle beschikbare opdrachten weergeven met de --help
optie en afspelen met de vermelde opdrachten.
az webpubsub service --help
Volgende stappen
Deze quickstart biedt een basisidee van het maken van verbinding met de Web PubSub-service en het publiceren van berichten naar de verbonden clients.
In echte toepassingen kunt u SDK's in verschillende talen gebruiken om uw eigen toepassing te bouwen. We bieden ook functie-extensies voor u om eenvoudig serverloze toepassingen te bouwen.
Gebruik deze resources om te beginnen met het bouwen van uw eigen toepassing: