az webpubsub hub
Note
This reference is part of the webpubsub extension for the Azure CLI (version 2.56.0 or higher). La extensión se instalará automáticamente la primera vez que ejecute un comando az webpubsub hub. Learn more about extensions.
Comandos para administrar la configuración del centro de Webpubsub.
Comandos
Nombre | Description | Tipo | Estado |
---|---|---|---|
az webpubsub hub create |
Cree la configuración del concentrador para el servicio WebPubSub o Web PubSub para Socket.IO en modo sin servidor. |
Extension | GA |
az webpubsub hub delete |
Permite eliminar la configuración del centro de conectividad para el servicio WebPubSub. |
Extension | GA |
az webpubsub hub list |
Permite enumerar la configuración del centro de conectividad para el servicio WebPubSub. |
Extension | GA |
az webpubsub hub show |
Permite mostrar la configuración del centro de conectividad para el servicio WebPubSub. |
Extension | GA |
az webpubsub hub update |
Actualice la configuración del centro de conectividad para el servicio WebPubSub o Web PubSub para Socket.IO en modo sin servidor. |
Extension | GA |
az webpubsub hub create
Cree la configuración del concentrador para el servicio WebPubSub o Web PubSub para Socket.IO en modo sin servidor.
az webpubsub hub create --hub-name
--name
--resource-group
[--allow-anonymous {false, true}]
[--event-handler]
[--websocket-keepalive]
Ejemplos
Creación de una configuración de concentrador con dos configuraciones de controlador de eventos
az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
Creación de una configuración de concentrador con conexión anónima permitida
az webpubsub hub create -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
Parámetros requeridos
Centro que se va a administrar.
Nombre del webpubsub.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Parámetros opcionales
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Establezca si se permiten conexiones anónimas para este centro. True significa permitir y False significa denegar.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Valores aceptados: | false, true |
Elemento de plantilla para la configuración del controlador de eventos. Use el patrón key=value para establecer propiedades. Las claves admitidas son "url-template", "user-event-pattern", "system-event", "auth-type" y "auth-resource". Establecer varios "eventos del sistema" da como resultado una matriz y para otras propiedades, solo el último conjunto toma activo.
Intervalo de mantenimiento de WebSocket en segundos para todos los clientes del centro. Intervalo válido: de 1 a 120. El valor predeterminado es de 20 segundos.
Propiedad | Valor |
---|---|
Valor predeterminado: | 20 |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Output format.
Propiedad | Valor |
---|---|
Valor predeterminado: | json |
Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
az webpubsub hub delete
Permite eliminar la configuración del centro de conectividad para el servicio WebPubSub.
az webpubsub hub delete [--hub-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Parámetros opcionales
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Nombre del centro.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Nombre del webpubsub.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Output format.
Propiedad | Valor |
---|---|
Valor predeterminado: | json |
Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
az webpubsub hub list
Permite enumerar la configuración del centro de conectividad para el servicio WebPubSub.
az webpubsub hub list --name
--resource-group
Parámetros requeridos
Nombre del webpubsub.
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Output format.
Propiedad | Valor |
---|---|
Valor predeterminado: | json |
Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
az webpubsub hub show
Permite mostrar la configuración del centro de conectividad para el servicio WebPubSub.
az webpubsub hub show [--hub-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Parámetros opcionales
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Nombre del centro.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Nombre del webpubsub.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Output format.
Propiedad | Valor |
---|---|
Valor predeterminado: | json |
Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
az webpubsub hub update
Actualice la configuración del centro de conectividad para el servicio WebPubSub o Web PubSub para Socket.IO en modo sin servidor.
az webpubsub hub update --hub-name
[--add]
[--allow-anonymous {false, true}]
[--event-handler]
[--force-string]
[--ids]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--websocket-keepalive]
Ejemplos
Actualizar la configuración del controlador de eventos de un centro
az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --event-handler url-template="http://host.com" user-event-pattern="MyEvent" --event-handler url-template="http://host2.com" system-event="connected" system-event="disconnected" auth-type="ManagedIdentity" auth-resource="uri://myUri"
Actualización para permitir la conexión anónima
az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --allow-anonymous true
La actualización al socket web mantiene el intervalo activo en segundos (el valor predeterminado es 20 segundos, el mínimo es 1, el máximo es 120)
az webpubsub hub update -n MyWebPubSub -g MyResourceGroup --hub-name MyHub --websocket-keepalive 30
Parámetros requeridos
Centro que se va a administrar.
Parámetros opcionales
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>
.
Propiedad | Valor |
---|---|
Parameter group: | Generic Update Arguments |
Valor predeterminado: | [] |
Establezca si se permiten conexiones anónimas para este centro. True significa permitir y False significa denegar.
Propiedad | Valor |
---|---|
Valores aceptados: | false, true |
Elemento de plantilla para la configuración del controlador de eventos. Use el patrón key=value para establecer propiedades. Las claves admitidas son "url-template", "user-event-pattern", "system-event", "auth-type" y "auth-resource". Establecer varios "eventos del sistema" da como resultado una matriz y para otras propiedades, solo el último conjunto toma activo.
Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.
Propiedad | Valor |
---|---|
Parameter group: | Generic Update Arguments |
Valor predeterminado: | False |
Uno o varios identificadores de recursos (delimitados por espacio). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Nombre del webpubsub.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove>
O --remove propertyToRemove
.
Propiedad | Valor |
---|---|
Parameter group: | Generic Update Arguments |
Valor predeterminado: | [] |
Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>
.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>
.
Propiedad | Valor |
---|---|
Parameter group: | Generic Update Arguments |
Valor predeterminado: | [] |
Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID
.
Propiedad | Valor |
---|---|
Parameter group: | Resource Id Arguments |
Intervalo de mantenimiento de WebSocket en segundos para todos los clientes del centro. Intervalo válido: de 1 a 120. El valor predeterminado es de 20 segundos.
Parámetros globales
Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Mostrar este mensaje de ayuda y salir.
Solo se muestran errores, suprimiendo advertencias.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |
Output format.
Propiedad | Valor |
---|---|
Valor predeterminado: | json |
Valores aceptados: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.
Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.
Propiedad | Valor |
---|---|
Valor predeterminado: | False |