Compartilhar via

az iot hub consumer-group

Observação

Esse grupo de comandos tem comandos definidos na CLI do Azure e em pelo menos uma extensão. Instale cada extensão para se beneficiar de seus recursos estendidos. Saiba mais sobre extensões.

Gerencie os grupos de consumidores do hub de eventos de um hub IoT.

Comandos

Nome Description Tipo Status
az iot hub consumer-group create

Crie um grupo de consumidores do hub de eventos.

 Core GA
az iot hub consumer-group create (azure-iot extensão)

Crie um grupo de consumidores do hub de eventos.

 Extension GA
az iot hub consumer-group delete

Excluir um grupo de consumidores do hub de eventos.

 Core GA
az iot hub consumer-group delete (azure-iot extensão)

Excluir um grupo de consumidores do hub de eventos.

 Extension GA
az iot hub consumer-group list

Listar grupos de consumidores do hub de eventos.

 Core GA
az iot hub consumer-group list (azure-iot extensão)

Listar grupos de consumidores do hub de eventos.

 Extension GA
az iot hub consumer-group show

Obtenha os detalhes de um grupo de consumidores do hub de eventos.

 Core GA
az iot hub consumer-group show (azure-iot extensão)

Obtenha os detalhes de um grupo de consumidores do hub de eventos.

 Extension GA

az iot hub consumer-group create

Editar

Crie um grupo de consumidores do hub de eventos.

az iot hub consumer-group create --hub-name
                                 --name
                                 [--event-hub-name]
                                 [--resource-group]

Exemplos

Crie um grupo de consumidores 'cg1' no ponto de extremidade do hub de eventos padrão.

az iot hub consumer-group create --hub-name MyIotHub --name cg1

Crie um grupo de consumidores 'cg1' no ponto de extremidade do hub de eventos de monitoramento de operação 'operationsMonitoringEvents'.

az iot hub consumer-group create --hub-name MyIotHub --event-hub-name operationsMonitoringEvents --name cg1

Parâmetros Exigidos

--hub-name

Nome do Hub IoT.

--name -n

Nome do grupo de consumidores do hub de eventos.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--event-hub-name

Nome do ponto de extremidade do hub de eventos.

Propriedade Valor
Valor padrão: events
--resource-group -g

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

Parâmetros Globais
--debug

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

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

Mostre esta mensagem de ajuda e saia.

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

--subscription

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

--verbose

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

Propriedade Valor
Valor padrão: False

az iot hub consumer-group create (azure-iot extensão)

Crie um grupo de consumidores do hub de eventos.

az iot hub consumer-group create --hub-name
                                 --name
                                 [--event-hub-name]
                                 [--resource-group]

Exemplos

Crie um grupo de consumidores 'cg1' no ponto de extremidade do hub de eventos padrão.

az iot hub consumer-group create --hub-name MyIotHub --name cg1

Crie um grupo de consumidores 'cg1' no ponto de extremidade do hub de eventos de monitoramento de operação 'operationsMonitoringEvents'.

az iot hub consumer-group create --hub-name MyIotHub --event-hub-name operationsMonitoringEvents --name cg1

Parâmetros Exigidos

--hub-name

Nome do Hub IoT.

--name -n

Nome do grupo de consumidores do hub de eventos.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--event-hub-name

Nome do ponto de extremidade do hub de eventos.

Propriedade Valor
Valor padrão: events
--resource-group -g

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

Parâmetros Globais
--debug

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

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

Mostre esta mensagem de ajuda e saia.

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

--subscription

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

--verbose

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

Propriedade Valor
Valor padrão: False

az iot hub consumer-group delete

Editar

Excluir um grupo de consumidores do hub de eventos.

az iot hub consumer-group delete [--event-hub-name]
                                 [--hub-name]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--event-hub-name

Nome do ponto de extremidade do hub de eventos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Valor padrão: events
--hub-name

Nome do Hub IoT.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Nome do grupo de consumidores do hub de eventos.

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 assinatura. 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 de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

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

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

Propriedade Valor
Valor padrão: False

az iot hub consumer-group delete (azure-iot extensão)

Excluir um grupo de consumidores do hub de eventos.

az iot hub consumer-group delete [--event-hub-name]
                                 [--hub-name]
                                 [--ids]
                                 [--name]
                                 [--resource-group]
                                 [--subscription]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--event-hub-name

Nome do ponto de extremidade do hub de eventos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Valor padrão: events
--hub-name

Nome do Hub IoT.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Nome do grupo de consumidores do hub de eventos.

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 assinatura. 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 de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

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

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

Propriedade Valor
Valor padrão: False

az iot hub consumer-group list

Editar

Listar grupos de consumidores do hub de eventos.

az iot hub consumer-group list [--event-hub-name]
                               [--hub-name]
                               [--ids]
                               [--resource-group]
                               [--subscription]

Exemplos

Listar grupos de consumidores do hub de eventos. (autogenerated)

az iot hub consumer-group list --hub-name MyHub

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--event-hub-name

Nome do ponto de extremidade do hub de eventos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Valor padrão: events
--hub-name

Nome do Hub IoT.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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 assinatura. 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 de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

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

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

Propriedade Valor
Valor padrão: False

az iot hub consumer-group list (azure-iot extensão)

Listar grupos de consumidores do hub de eventos.

az iot hub consumer-group list [--event-hub-name]
                               [--hub-name]
                               [--ids]
                               [--resource-group]
                               [--subscription]

Exemplos

Listar grupos de consumidores do hub de eventos. (autogenerated)

az iot hub consumer-group list --hub-name MyHub

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--event-hub-name

Nome do ponto de extremidade do hub de eventos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Valor padrão: events
--hub-name

Nome do Hub IoT.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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 assinatura. 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 de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

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

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

Propriedade Valor
Valor padrão: False

az iot hub consumer-group show

Editar

Obtenha os detalhes de um grupo de consumidores do hub de eventos.

az iot hub consumer-group show [--event-hub-name]
                               [--hub-name]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

Exemplos

Obtenha os detalhes de um grupo de consumidores do hub de eventos. (autogenerated)

az iot hub consumer-group show --hub-name MyHub --name MyEventHubConsumerGroup

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--event-hub-name

Nome do ponto de extremidade do hub de eventos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Valor padrão: events
--hub-name

Nome do Hub IoT.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Nome do grupo de consumidores do hub de eventos.

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 assinatura. 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 de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

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

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

Propriedade Valor
Valor padrão: False

az iot hub consumer-group show (azure-iot extensão)

Obtenha os detalhes de um grupo de consumidores do hub de eventos.

az iot hub consumer-group show [--event-hub-name]
                               [--hub-name]
                               [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]

Exemplos

Obtenha os detalhes de um grupo de consumidores do hub de eventos. (autogenerated)

az iot hub consumer-group show --hub-name MyHub --name MyEventHubConsumerGroup

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem se tornar obrigatórios para que o comando seja executado com sucesso.

--event-hub-name

Nome do ponto de extremidade do hub de eventos.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Valor padrão: events
--hub-name

Nome do Hub IoT.

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

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de 'ID do recurso'. Você deve fornecer --ids ou outros argumentos de 'ID de recurso'.

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

Nome do grupo de consumidores do hub de eventos.

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 assinatura. 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 de log para mostrar todos os logs de depuração.

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

Mostre esta mensagem de ajuda e saia.

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

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

Propriedade Valor
Valor padrão: False