Partilhar via

az webpubsub service group

Note

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

Comandos para gerenciar grupos de serviços Webpubsub.

Comandos

Nome Descrição Tipo Estado
az webpubsub service group add-connection

Adicione uma conexão ao grupo. O erro é lançado se a operação falhar.

 Extension disponibilidade geral
az webpubsub service group add-user

Adicione um usuário ao grupo. O erro é lançado se a operação falhar.

 Extension disponibilidade geral
az webpubsub service group remove-connection

Remova uma conexão do grupo. O erro é lançado se a operação falhar.

 Extension disponibilidade geral
az webpubsub service group remove-user

Remova um usuário do grupo. O erro é lançado se a operação falhar.

 Extension disponibilidade geral
az webpubsub service group send

Envie uma mensagem para o grupo. O erro é lançado se a operação falhar.

 Extension disponibilidade geral

az webpubsub service group add-connection

Adicione uma conexão ao grupo. O erro é lançado se a operação falhar.

az webpubsub service group add-connection --connection-id
                                          --group-name
                                          --hub-name
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

Parâmetros Obrigatórios

--connection-id

O ID de conexão.

--group-name

O nome do grupo.

--hub-name

O hub para gerenciar.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do webpubsub.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az webpubsub service group add-user

Adicione um usuário ao grupo. O erro é lançado se a operação falhar.

az webpubsub service group add-user --group-name
                                    --hub-name
                                    --user-id
                                    [--ids]
                                    [--name]
                                    [--resource-group]
                                    [--subscription]

Parâmetros Obrigatórios

--group-name

O nome do grupo.

--hub-name

O hub para gerenciar.

--user-id

O ID do usuário.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do webpubsub.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az webpubsub service group remove-connection

Remova uma conexão do grupo. O erro é lançado se a operação falhar.

az webpubsub service group remove-connection --connection-id
                                             --group-name
                                             --hub-name
                                             [--ids]
                                             [--name]
                                             [--resource-group]
                                             [--subscription]

Parâmetros Obrigatórios

--connection-id

O ID de conexão.

--group-name

O nome do grupo.

--hub-name

O hub para gerenciar.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do webpubsub.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az webpubsub service group remove-user

Remova um usuário do grupo. O erro é lançado se a operação falhar.

az webpubsub service group remove-user --hub-name
                                       --user-id
                                       [--group-name]
                                       [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

Parâmetros Obrigatórios

--hub-name

O hub para gerenciar.

--user-id

O ID do usuário.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--group-name

O nome do grupo.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do webpubsub.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False

az webpubsub service group send

Envie uma mensagem para o grupo. O erro é lançado se a operação falhar.

az webpubsub service group send --group-name
                                --hub-name
                                --payload
                                [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Parâmetros Obrigatórios

--group-name

O nome do grupo.

--hub-name

O hub para gerenciar.

--payload

Uma carga útil de cadeia de caracteres para enviar.

Parâmetros Opcionais

Os parâmetros seguintes são opcionais, mas dependendo do contexto, podem ser necessários um ou mais para que o comando seja executado com sucesso.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome do webpubsub.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros globais
--debug

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

Propriedade Valor
Valor padrão: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Valor padrão: False
--output -o

Formato de saída.

Propriedade Valor
Valor padrão: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Valor padrão: False