Partilhar via

az webpubsub service group

  • Referência

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 service group . Saiba mais sobre extensões.

Comandos para gerenciar grupos de serviços Webpubsub.

Comandos

Name Description Tipo Estado
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 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

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

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

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

--group-name

O nome do grupo.

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

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