Inicio rápido: Conexión a la instancia de Azure Web PubSub desde la CLI
En este inicio rápido se muestra cómo conectarse a la instancia de Azure Web PubSub y publicar mensajes en los clientes conectados mediante la CLI de Azure.
Si no tiene una suscripción a Azure, cree una cuenta gratuita de Azure antes de empezar.
Requisitos previos
Use el entorno de Bash en Azure Cloud Shell. Para más información, consulte Inicio rápido para Bash en Azure Cloud Shell.
Si prefiere ejecutar comandos de referencia de la CLI localmente, instale la CLI de Azure. Si utiliza Windows o macOS, considere la posibilidad de ejecutar la CLI de Azure en un contenedor Docker. Para más información, vea Ejecución de la CLI de Azure en un contenedor de Docker.
Si usa una instalación local, inicie sesión en la CLI de Azure mediante el comando az login. Siga los pasos que se muestran en el terminal para completar el proceso de autenticación. Para ver otras opciones de inicio de sesión, consulte Inicio de sesión con la CLI de Azure.
En caso de que se le solicite, instale las extensiones de la CLI de Azure la primera vez que la use. Para más información sobre las extensiones, consulte Uso de extensiones con la CLI de Azure.
Ejecute az version para buscar cuál es la versión y las bibliotecas dependientes que están instaladas. Para realizar la actualización a la versión más reciente, ejecute az upgrade.
- Para realizar este inicio rápido es necesaria la versión 2.22.0 o posterior de la CLI de Azure. Si usa Azure Cloud Shell, ya está instalada la versión más reciente.
Crear un grupo de recursos
Un grupo de recursos es un contenedor lógico en el que se implementan y se administran los recursos de Azure. Use el comando az group create para crear un grupo de recursos denominado myResourceGroup en la ubicación eastus.
az group create --name myResourceGroup --location EastUS
Creación de una instancia de Web PubSub
Ejecute az extension add para instalar o actualizar la extensión webpubsub en la versión actual.
az extension add --upgrade --name webpubsub
Use el comando az webpubsub create de la CLI de Azure para crear una instancia de Web PubSub en el grupo de recursos que ha creado. El comando siguiente crea un recurso Free de Web PubSub en el grupo de recursos myResourceGroup en EastUS:
Importante
Cada recurso de Web PubSub debe tener un nombre único. Reemplace <your-unique-resource-name> por el nombre de Web PubSub en los ejemplos siguientes.
az webpubsub create --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --location "EastUS" --sku Free_F1
La salida de este comando muestra las propiedades del recurso que acaba de crear. Tome nota de las dos propiedades siguientes:
- Nombre del recurso: nombre que proporcionó al parámetro
--nameanterior. - hostName: en el ejemplo, el nombre de host es
<your-unique-resource-name>.webpubsub.azure.com/.
En este momento, su cuenta de Azure es la única autorizada para realizar operaciones en este nuevo recurso.
Reproducción con la instancia
Conexión al servicio
Use la CLI de Azure az webpubsub client para iniciar una conexión de cliente webSocket con el servicio creado en el paso anterior, proporcionando la siguiente información:
- Nombre del centro: una cadena de 1 a 127 caracteres. Debe comenzar con los caracteres alfabéticos
(a-z, A-Z)y solo puede contener caracteres(0-9, a-z, A-Z)alfanuméricos o un guion bajo(_).
Un centro es un conjunto lógico de las conexiones de WebSocket conectadas. Para obtener más información sobre estos conceptos, consulte Acerca de centros de conectividad, grupos y conexiones para obtener más información sobre los conceptos.
Importante
Reemplace <your-unique-resource-name> por el nombre del recurso de Web PubSub que creó en los pasos anteriores.
- Nombre del centro: myHub1.
- Nombre del grupo de recursos: myResourceGroup.
- Id. de usuario: user1
az webpubsub client start --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --user-id "user1"
Puede ver que el comando estableció una conexión de WebSocket con el servicio PubSub web y que recibió un mensaje JSON que indica que ahora está conectado correctamente y se le asigna un único connectionId:
{"type":"system","event":"connected","userId":"user1","connectionId":"<your_unique_connection_id>"}
Jugar con él e intentar unirse a grupos mediante joingroup <group-name> y enviar mensajes a grupos mediante sendtogroup <group-name>:
joingroup group1
sendtogroup group1 hello
Publicación de mensajes y administración de los clientes
La CLI de Azure también proporciona comandos az webpubsub service para administrar las conexiones de cliente.
Abra otro comando de la CLI y podrá difundir mensajes a los clientes.
- Nombre del centro: myHub1.
- Nombre del grupo de recursos: myResourceGroup.
az webpubsub service broadcast --name "<your-unique-resource-name>" --resource-group "myResourceGroup" --hub-name "myHub1" --payload "Hello World"
Vuelva al comando anterior de la CLI y verá que el cliente recibió el mensaje:
{"type":"message","from":"server","dataType":"text","data":"Hello World"}
También puede mostrar todos los comandos disponibles mediante la opción --help y probarlos.
az webpubsub service --help
Pasos siguientes
En este inicio rápido, se proporciona una idea básica de cómo conectarse al servicio Web PubSub y cómo publicar mensajes en los clientes conectados.
En las aplicaciones del mundo real, puede usar SDK en varios lenguajes para crear su propia aplicación. También proporcionamos extensiones de función para que pueda crear aplicaciones sin servidor fácilmente.
Use estos recursos para empezar a compilar su propia aplicación: