Leer en inglés

Compartir vía

az webpubsub

  • Referencia

Nota

Esta referencia forma parte de la extensión webpubsub para la CLI de Azure (versión 2.39.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az webpubsub . Obtenga más información sobre las extensiones.

Comandos para administrar Webpubsub.

Comandos

Nombre Description Tipo Estado
az webpubsub client

Comandos para administrar las conexiones de cliente.

 Extensión GA
az webpubsub client start

Inicie una conexión de cliente interactiva.

 Extensión GA
az webpubsub create

Cree un webpubsub.

 Extensión GA
az webpubsub delete

Elimine un webpubsub.

 Extensión GA
az webpubsub hub

Comandos para administrar la configuración del centro de Webpubsub.

 Extensión GA
az webpubsub hub create

Cree la configuración del centro de conectividad para el servicio WebPubSub.

 Extensión GA
az webpubsub hub delete

Permite eliminar la configuración del centro de conectividad para el servicio WebPubSub.

 Extensión GA
az webpubsub hub list

Permite enumerar la configuración del centro de conectividad para el servicio WebPubSub.

 Extensión GA
az webpubsub hub show

Permite mostrar la configuración del centro de conectividad para el servicio WebPubSub.

 Extensión GA
az webpubsub hub update

Permite actualizar la configuración del centro de conectividad para el servicio WebPubSub.

 Extensión GA
az webpubsub key

Comandos para administrar claves de Webpubsub.

 Extensión GA
az webpubsub key regenerate

Regenera las claves de un servicio WebPubSub.

 Extensión GA
az webpubsub key show

Mostrar cadenas y claves de connetion para un servicio WebPubSub.

 Extensión GA
az webpubsub list

Enumerar Webpubsub.

 Extensión GA
az webpubsub list-skus

Enumere todas las sku disponibles del recurso.

 Extensión GA
az webpubsub list-usage

Enumerar las cuotas de uso de recursos por ubicación.

 Extensión GA
az webpubsub network-rule

Comandos para administrar reglas de red de Webpubsub.

 Extensión GA
az webpubsub network-rule show

Obtenga el control de acceso de red del servicio WebPubSub.

 Extensión GA
az webpubsub network-rule update

Actualice el control de acceso de red del servicio WebPubSub.

 Extensión GA
az webpubsub replica

Administrar la configuración de réplica.

 Extensión GA
az webpubsub replica create

Cree una réplica del servicio Webpubsub.

 Extensión GA
az webpubsub replica delete

Elimine una réplica del servicio WebPubSub.

 Extensión GA
az webpubsub replica list

Enumerar réplicas del servicio Webpubsub.

 Extensión GA
az webpubsub replica show

Muestra los detalles de una réplica.

 Extensión GA
az webpubsub restart

Reinicie un webpubsub.

 Extensión GA
az webpubsub service

Comandos para administrar el servicio Webpubsub.

 Extensión GA
az webpubsub service broadcast

Difundir mensajes al centro. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service connection

Comandos para administrar conexiones de servicio Webpubsub.

 Extensión GA
az webpubsub service connection close

Cierre una conexión de cliente específica. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service connection exist

Compruebe si existe una conexión de cliente.

 Extensión GA
az webpubsub service connection send

Enviar un mensaje a la conexión. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service group

Comandos para administrar grupos de servicios Webpubsub.

 Extensión GA
az webpubsub service group add-connection

Agregue una conexión al grupo. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service group add-user

Agregue un usuario al grupo. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service group remove-connection

Quite una conexión del grupo. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service group remove-user

Quite un usuario del grupo. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service group send

Enviar un mensaje al grupo. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service permission

Comandos para administrar los permisos del servicio Webpubsub.

 Extensión GA
az webpubsub service permission check

Compruebe si una conexión tiene permiso para el grupo especificado.

 Extensión GA
az webpubsub service permission grant

Conceda permiso de grupo a la conexión. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service permission revoke

Revoque un permiso de grupo de la conexión. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub service user

Comandos para administrar usuarios del servicio Webpubsub.

 Extensión GA
az webpubsub service user exist

Compruebe si hay conexiones de cliente conectadas para el usuario determinado.

 Extensión GA
az webpubsub service user send

Enviar un mensaje al usuario. Se produce un error si se produce un error en la operación.

 Extensión GA
az webpubsub show

Muestra los detalles de un webpubsub.

 Extensión GA
az webpubsub update

Actualice un webpubsub.

 Extensión GA

az webpubsub create

Cree un webpubsub.

Azure CLI 
az webpubsub create --name
                    --resource-group
                    --sku
                    [--kind]
                    [--location]
                    [--tags]
                    [--unit-count]

Ejemplos

Cree un servicio WebPubSub con la SKU estándar y la unidad 2.

Azure CLI 
az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 2

Cree un web PubSub para Socket.IO con la SKU Premium y la unidad 1.

Azure CLI 
az webpubsub create -n MyWebPubSub -g MyResourceGroup --sku Premium_P1 --unit-count 1 --kind SocketIO

Parámetros requeridos

--name -n

Nombre de Webpubsub.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--sku

Nombre de SKU del servicio webpubsub. Valores permitidos: Free_F1, Standard_S1, Premium_P1.

Parámetros opcionales

--kind

Tipo del servicio webpubsub. Valores permitidos: WebPubSub, SocketIO.

--location -l

Ubicación. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--unit-count

Número de unidades de servicio webpubsub.

Valor predeterminado: 1
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az webpubsub delete

Elimine un webpubsub.

Azure CLI 
az webpubsub delete [--ids]
                    [--name]
                    [--resource-group]
                    [--subscription]

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

--name -n

Nombre de Webpubsub.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az webpubsub list

Enumerar Webpubsub.

Azure CLI 
az webpubsub list [--resource-group]

Parámetros opcionales

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az webpubsub list-skus

Enumere todas las sku disponibles del recurso.

Azure CLI 
az webpubsub list-skus [--ids]
                       [--name]
                       [--resource-group]
                       [--subscription]

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

--name -n

Nombre de Webpubsub.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az webpubsub list-usage

Enumerar las cuotas de uso de recursos por ubicación.

Azure CLI 
az webpubsub list-usage --location

Parámetros requeridos

--location -l

Ubicación. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az webpubsub restart

Reinicie un webpubsub.

Azure CLI 
az webpubsub restart [--ids]
                     [--name]
                     [--resource-group]
                     [--subscription]

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

--name -n

Nombre de Webpubsub.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az webpubsub show

Muestra los detalles de un webpubsub.

Azure CLI 
az webpubsub show [--ids]
                  [--name]
                  [--resource-group]
                  [--subscription]

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

--name -n

Nombre de Webpubsub.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az webpubsub update

Actualice un webpubsub.

Azure CLI 
az webpubsub update [--add]
                    [--force-string]
                    [--ids]
                    [--name]
                    [--remove]
                    [--resource-group]
                    [--set]
                    [--sku]
                    [--subscription]
                    [--tags]
                    [--unit-count]

Ejemplos

Actualice un servicio WebPubSub a la unidad 10.

Azure CLI 
az webpubsub update -n MyWebPubSub -g MyResourceGroup --sku Standard_S1 --unit-count 10

Parámetros opcionales

--add

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>.

Valor predeterminado: []
--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Valor predeterminado: False
--ids

Uno o varios identificadores de recursos (delimitados por espacios). 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".

--name -n

Nombre de Webpubsub.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Valor predeterminado: []
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Valor predeterminado: []
--sku

Nombre de SKU del servicio webpubsub. Valores permitidos: Free_F1, Standard_S1, Premium_P1.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--unit-count

Número de unidades de servicio webpubsub.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.