Guia de início rápido: conectar-se à instância do Azure Web PubSub da CLI
Este guia de início rápido mostra como se conectar à instância do Azure Web PubSub e publicar mensagens para os clientes conectados usando a CLI do Azure.
Se não tiver uma subscrição do Azure, crie uma conta gratuita do Azure antes de começar.
Pré-requisitos
Use o ambiente Bash no Azure Cloud Shell. Para obter mais informações, consulte Guia de início rápido para Bash no Azure Cloud Shell.
Se preferir executar comandos de referência da CLI localmente, instale a CLI do Azure. Se estiver a utilizar o Windows ou macOS, considere executar a CLI do Azure num contentor Docker. Para obter mais informações, consulte Como executar a CLI do Azure em um contêiner do Docker.
Se estiver a utilizar uma instalação local, inicie sessão no CLI do Azure ao utilizar o comando az login. Para concluir o processo de autenticação, siga os passos apresentados no seu terminal. Para outras opções de entrada, consulte Entrar com a CLI do Azure.
Quando solicitado, instale a extensão da CLI do Azure na primeira utilização. Para obter mais informações sobre as extensões, veja Utilizar extensões com o CLI do Azure.
Execute o comando az version para localizar a versão e as bibliotecas dependentes instaladas. Para atualizar para a versão mais recente, execute o comando az upgrade.
- Este início rápido requer a versão 2.22.0 ou superior da CLI do Azure. Se estiver usando o Azure Cloud Shell, a versão mais recente já está instalada.
Criar um grupo de recursos
Um grupo de recursos é um contentor lógico no qual os recursos do Azure são implementados e geridos. Use o comando az group create para criar um grupo de recursos nomeado myResourceGroup no eastus local.
az group create --name myResourceGroup --location EastUS
Criar uma instância do Web PubSub
Execute az extension add para instalar ou atualizar a extensão webpubsub para a versão atual.
az extension add --upgrade --name webpubsub
Use o comando Azure CLI az webpubsub create para criar um Web PubSub no grupo de recursos que você criou. O comando a seguir cria um recurso Free Web PubSub no grupo de recursos myResourceGroup em EastUS:
Importante
Cada recurso Web PubSub deve ter um nome exclusivo. Substitua <your-unique-resource-name> pelo nome do seu Web PubSub nos exemplos a seguir.
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
A saída deste comando mostra as propriedades do recurso recém-criado. Tome nota das duas propriedades listadas abaixo:
- Nome do recurso: O nome fornecido para o
--nameparâmetro acima. - hostName: No exemplo, o nome do host é
<your-unique-resource-name>.webpubsub.azure.com/.
Neste ponto, sua conta do Azure é a única autorizada a executar quaisquer operações neste novo recurso.
Jogar com a instância
Ligue-se ao serviço
Use o comando Azure CLI az webpubsub client para iniciar uma conexão de cliente WebSocket com o serviço criado na etapa anterior, fornecendo as seguintes informações:
- Nome do hub: uma cadeia de caracteres de 1 a 127 caracteres. Deve começar com caracteres alfabéticos e conter apenas caracteres
(a-z, A-Z)alfanuméricos(0-9, a-z, A-Z)ou sublinhado(_).
Hub é um conjunto lógico das conexões WebSocket conectadas. Verifique Sobre Hubs, grupos e conexões para obter detalhes sobre os conceitos.
Importante
Substitua <your-unique-resource-name> pelo nome do recurso Web PubSub criado a partir das etapas anteriores.
- Nome do hub: myHub1.
- Nome do grupo de recursos: myResourceGroup.
- ID de usuário: user1
az webpubsub client start --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --user-id "user1"
Você pode ver que o comando estabeleceu uma conexão WebSocket com o serviço Web PubSub e você recebeu uma mensagem JSON indicando que ele agora está conectado com êxito e é atribuído com um exclusivo connectionId:
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
Jogue com ele e tente participar de grupos usando e enviar mensagens para grupos usando joingroup <group-name> sendtogroup <group-name>:
joingroup group1
sendtogroup group1 hello
Publicar mensagens e gerenciar os clientes
A CLI do Azure também fornece comandos de serviço az webpubsub para gerenciar as conexões de cliente.
Abra outro comando da CLI e você pode transmitir mensagens para os clientes:
- Nome do hub: myHub1.
- Nome do grupo de recursos: myResourceGroup.
az webpubsub service broadcast --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --payload "Hello World"
Volte para o comando anterior da CLI e você pode ver que o cliente recebeu a mensagem:
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
Você também pode listar todos os comandos disponíveis usando --help opção e jogar com os comandos listados.
az webpubsub service --help
Próximos passos
Este guia de início rápido fornece uma ideia básica de como se conectar ao serviço Web PubSub e como publicar mensagens para os clientes conectados.
Em aplicativos do mundo real, você pode usar SDKs em vários idiomas para criar seu próprio aplicativo. Nós também fornecemos extensões de função para você construir aplicativos sem servidor facilmente.
Use estes recursos para começar a criar seu próprio aplicativo: