az webpubsub

Nota

Essa referência faz parte da extensão webpubsub para a CLI do Azure (versão 2.39.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az webpubsub . Saiba mais sobre extensões.

Comandos para gerenciar Webpubsub.

Comandos

Name	Description	Tipo	Estado
az webpubsub client	Comandos para gerenciar conexões de cliente.	Extensão	GA
az webpubsub client start	Inicie uma conexão de cliente interativa.	Extensão	GA
az webpubsub create	Crie um Webpubsub.	Extensão	GA
az webpubsub delete	Exclua um Webpubsub.	Extensão	GA
az webpubsub hub	Comandos para gerenciar as configurações do hub Webpubsub.	Extensão	GA
az webpubsub hub create	Crie configurações de hub para o Serviço WebPubSub.	Extensão	GA
az webpubsub hub delete	Exclua as configurações de hub para o Serviço WebPubSub.	Extensão	GA
az webpubsub hub list	Liste todas as configurações de hub para o Serviço WebPubSub.	Extensão	GA
az webpubsub hub show	Mostrar configurações de hub para o Serviço WebPubSub.	Extensão	GA
az webpubsub hub update	Atualize as configurações do hub para o Serviço WebPubSub.	Extensão	GA
az webpubsub key	Comandos para gerenciar chaves Webpubsub.	Extensão	GA
az webpubsub key regenerate	Regenere chaves para um serviço WebPubSub.	Extensão	GA
az webpubsub key show	Mostrar cadeias de caracteres e teclas de conexão para um serviço WebPubSub.	Extensão	GA
az webpubsub list	Lista Webpubsub.	Extensão	GA
az webpubsub list-skus	Liste todos os skus disponíveis do recurso.	Extensão	GA
az webpubsub list-usage	Liste as cotas de uso de recursos por local.	Extensão	GA
az webpubsub network-rule	Comandos para gerenciar regras de rede Webpubsub.	Extensão	GA
az webpubsub network-rule show	Obtenha o controle de acesso à rede do serviço WebPubSub.	Extensão	GA
az webpubsub network-rule update	Atualize o controle de acesso à rede do serviço WebPubSub.	Extensão	GA
az webpubsub replica	Gerencie as configurações da réplica.	Extensão	GA
az webpubsub replica create	Crie uma réplica do Serviço Webpubsub.	Extensão	GA
az webpubsub replica delete	Exclua uma réplica do serviço WebPubSub.	Extensão	GA
az webpubsub replica list	Listar réplicas do serviço Webpubsub.	Extensão	GA
az webpubsub replica show	Mostrar os detalhes de uma réplica.	Extensão	GA
az webpubsub restart	Reinicie um Webpubsub.	Extensão	GA
az webpubsub service	Comandos para gerenciar o serviço Webpubsub.	Extensão	GA
az webpubsub service broadcast	Transmitir mensagens para o hub. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service connection	Comandos para gerenciar conexões de serviço Webpubsub.	Extensão	GA
az webpubsub service connection close	Feche uma conexão de cliente específica. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service connection exist	Verifique se existe conexão com o cliente.	Extensão	GA
az webpubsub service connection send	Envie uma mensagem para a conexão. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service group	Comandos para gerenciar grupos de serviços Webpubsub.	Extensão	GA
az webpubsub service group add-connection	Adicione uma conexão ao grupo. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service group add-user	Adicione um usuário ao grupo. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service group remove-connection	Remova uma conexão do grupo. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service group remove-user	Remova um usuário do grupo. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service group send	Envie uma mensagem para o grupo. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service permission	Comandos para gerenciar permissões de serviço Webpubsub.	Extensão	GA
az webpubsub service permission check	Verifique se uma conexão tem permissão para o grupo especificado.	Extensão	GA
az webpubsub service permission grant	Conceda permissão a um grupo para a conexão. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service permission revoke	Revogar uma permissão de grupo da conexão. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub service user	Comandos para gerenciar usuários do serviço Webpubsub.	Extensão	GA
az webpubsub service user exist	Verifique se há alguma conexão de cliente conectada para determinado usuário.	Extensão	GA
az webpubsub service user send	Envie uma mensagem ao utilizador. O erro é lançado se a operação falhar.	Extensão	GA
az webpubsub show	Mostrar detalhes de um Webpubsub.	Extensão	GA
az webpubsub update	Atualize um Webpubsub.	Extensão	GA

az webpubsub create

Crie um Webpubsub.

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

Exemplos

Crie um serviço WebPubSub com SKU padrão e unidade 2.

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

Crie um Web PubSub para Socket.IO com Premium SKU e unidade 1.

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

Parâmetros Obrigatórios

--name -n

Nome do Webpubsub.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--sku

O nome da sku do serviço webpubsub. Valores permitidos: Free_F1, Standard_S1 Premium_P1.

Parâmetros Opcionais

--kind

O tipo de serviço webpubsub. Valores permitidos: WebPubSub, SocketIO.

--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--unit-count

O número de unidades de serviço webpubsub contagem.

valor predefinido: 1

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az webpubsub delete

Exclua um Webpubsub.

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

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome do Webpubsub.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az webpubsub list

Lista Webpubsub.

az webpubsub list [--resource-group]

Parâmetros Opcionais

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az webpubsub list-skus

Liste todos os skus disponíveis do recurso.

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

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome do Webpubsub.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az webpubsub list-usage

Liste as cotas de uso de recursos por local.

az webpubsub list-usage --location

Parâmetros Obrigatórios

--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az webpubsub restart

Reinicie um Webpubsub.

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

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome do Webpubsub.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az webpubsub show

Mostrar detalhes de um Webpubsub.

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

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome do Webpubsub.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az webpubsub update

Atualize um Webpubsub.

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

Exemplos

Atualize um serviço WebPubSub para a unidade 10.

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

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

valor predefinido: []

--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

valor predefinido: False

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome do Webpubsub.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OR --remove propertyToRemove.

valor predefinido: []

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=<value>.

valor predefinido: []

--sku

O nome da sku do serviço webpubsub. Valores permitidos: Free_F1, Standard_S1 Premium_P1.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes.

--unit-count

O número de unidades de serviço webpubsub contagem.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

valor predefinido: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.