Início Rápido: conectar com a instância do Azure Web PubSub usando a 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.
Caso você não tenha uma assinatura 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, confira Início Rápido para Bash no Azure Cloud Shell.
Se preferir executar os comandos de referência da CLI localmente, instale a CLI do Azure. Para execuções no Windows ou no macOS, considere executar a CLI do Azure em um contêiner do Docker. Para obter mais informações, confira Como executar a CLI do Azure em um contêiner do Docker.
Se estiver usando uma instalação local, entre com a CLI do Azure usando o comando az login. Para concluir o processo de autenticação, siga as etapas exibidas no terminal. Para ver outras opções de entrada, confira Conectar-se com a CLI do Azure.
Quando solicitado, instale a extensão da CLI do Azure no primeiro uso. Para obter mais informações sobre extensões, confira Usar extensões com a CLI do Azure.
Execute az version para localizar a versão e as bibliotecas dependentes que estão instaladas. Para fazer a atualização para a versão mais recente, execute az upgrade.
- Este guia de início rápido exige a versão 2.22.0 ou superior da CLI do Azure. Se você está usando o Azure Cloud Shell, a versão mais recente já está instalada.
Criar um grupo de recursos
Um grupo de recursos é um contêiner lógico no qual os recursos do Azure são implantados e gerenciados. Use o comando az group create para criar um grupo de recursos chamado myResourceGroup no local eastus.
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 az webpubsub create da CLI do Azure para criar um Web PubSub no grupo de recursos criado. O seguinte comando cria um recurso gratuito do Web PubSub no grupo de recursos myResourceGroup no EastUS:
Importante
Cada recurso Web PubSub precisa ter um nome exclusivo. Substitua <nome-de recurso-exclusivo> pelo nome do 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. Anote as duas propriedades listadas abaixo:
- Nome do Recurso: o nome que você forneceu ao parâmetro
--nameacima. - hostName: no exemplo, o nome do host é
<your-unique-resource-name>.webpubsub.azure.com/.
Nesse ponto, sua conta do Azure é a única autorizada a executar qualquer operação nesse novo recurso.
Executar com a instância
Conectar ao serviço
Use o comando az webpubsub client da CLI do Azure para iniciar uma conexão de cliente WebSocket com o serviço da etapa anterior, fornecendo as seguintes informações:
- Nome do hub: uma cadeia de caracteres de 1 a 127 caracteres. Ela deve começar com caracteres alfabéticos
(a-z, A-Z)e só conter caracteres(0-9, a-z, A-Z)alfanuméricos ou sublinhado(_).
O hub é um conjunto lógico de conexões WebSocket conectadas. Confira Sobre hubs, grupos e conexões para obter detalhes sobre os conceitos.
Importante
Substitua <nome-de-recurso-exclusivo> pelo nome do recurso Web PubSub criado nas 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ê poderá ver que o comando estabeleceu uma conexão WebSocket com o serviço Web PubSub e uma mensagem JSON foi enviada indicando que já ele está conectado com êxito e recebeu uma connectionId exclusiva:
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
Explore e tente ingressar em grupos usando joingroup <group-name> e envie mensagens para grupos usando sendtogroup <group-name>:
joingroup group1
sendtogroup group1 hello
Publicar mensagens e gerenciar os clientes
A CLI do Azure também fornece comandos az webpubsub service para gerenciamento das conexões de clientes.
Abra outro comando da CLI e você poderá 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ê poderá 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 a opção --help e explorar os comandos listados.
az webpubsub service --help
Próximas etapas
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 nos clientes conectados.
Em aplicativos do mundo real, você pode usar SDKs em várias linguagens para criar seu próprio aplicativo. Também fornecemos extensões de Função para você criar aplicativos sem servidor com facilidade.
Use estes recursos para começar a criar seu aplicativo: