az iot du device group

  • Referência

Nota

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

Gestão de grupos de dispositivos.

Um grupo de dispositivos é uma coleção de dispositivos. Os grupos de dispositivos fornecem uma maneira de dimensionar implantações para muitos dispositivos. Cada dispositivo pertence exatamente a um grupo de dispositivos de cada vez. Um grupo de dispositivos é criado automaticamente quando um dispositivo habilitado para Atualização de Dispositivo é conectado ao hub e relata suas propriedades.

Comandos

Name Description Tipo Estado
az iot du device group delete

Excluir um grupo de dispositivos.

 Extensão GA
az iot du device group list

Listar grupos de dispositivos dentro de uma instância.

 Extensão GA
az iot du device group show

Mostrar detalhes sobre um grupo de dispositivos, incluindo a melhor atualização e conformidade de atualização.

 Extensão GA

az iot du device group delete

Excluir um grupo de dispositivos.

Os grupos de dispositivos não são limpos automaticamente, mas são mantidos para fins de histórico. Esta operação pode ser usada se não houver necessidade para o grupo ou necessidade de reter o histórico para ele. Se um dispositivo for conectado novamente para um grupo depois que o grupo foi excluído, ele será recriado automaticamente sem histórico.

az iot du device group delete --account
                              --gid
                              --instance
                              [--resource-group]
                              [--yes {false, true}]

Exemplos

Excluir um grupo de dispositivos.

az iot du device group delete -n {account_name} -i {instance_name} --group-id {device_group_id}

Exclua um grupo de dispositivos ignorando o prompt de confirmação.

az iot du device group delete -n {account_name} -i {instance_name} --group-id {device_group_id} -y

Parâmetros Obrigatórios

--account -n

Nome da conta de Atualização de Dispositivo. Você pode configurar o nome da conta padrão usando az config set defaults.adu_account=<name>.

--gid --group-id

Id do grupo de dispositivos. Isso é criado a partir do valor da tag ADUGroup no dispositivo/módulo gêmeo ou $default do Hub IoT conectado para dispositivos sem tag.

--instance -i

Nome da instância de Atualização de Dispositivo. Você pode configurar o nome da instância padrão usando az config set defaults.adu_instance=<name>.

Parâmetros Opcionais

--resource-group -g

Nome do grupo de recursos da conta de Atualização de Dispositivo. Você pode configurar o grupo padrão usando az config set defaults.adu_group=<name>.

--yes -y

Ignore os prompts do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Predefinição: false.

valores aceites: false, true
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 iot du device group list

Listar grupos de dispositivos dentro de uma instância.

az iot du device group list --account
                            --instance
                            [--order-by]
                            [--resource-group]

Exemplos

Listar grupos de dispositivos.

az iot du device group list -n {account_name} -i {instance_name}

Liste grupos de dispositivos na ordem desejada, neste caso por deviceCount.

az iot du device group list -n {account_name} -i {instance_name} --order-by deviceCount

Parâmetros Obrigatórios

--account -n

Nome da conta de Atualização de Dispositivo. Você pode configurar o nome da conta padrão usando az config set defaults.adu_account=<name>.

--instance -i

Nome da instância de Atualização de Dispositivo. Você pode configurar o nome da instância padrão usando az config set defaults.adu_instance=<name>.

Parâmetros Opcionais

--order-by

Ordena que o conjunto de grupos seja devolvido. Você pode ordenar por groupId, deviceCount, createdDateTime, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount ou subgroupsWithOnLatestUpdateCount.

--resource-group -g

Nome do grupo de recursos da conta de Atualização de Dispositivo. Você pode configurar o grupo padrão usando az config set defaults.adu_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 iot du device group show

Mostrar detalhes sobre um grupo de dispositivos, incluindo a melhor atualização e conformidade de atualização.

az iot du device group show --account
                            --gid
                            --instance
                            [--best-updates {false, true}]
                            [--resource-group]
                            [--update-compliance {false, true}]

Exemplos

Mostrar um grupo de dispositivos.

az iot du device group show -n {account_name} -i {instance_name} --group-id {device_group_id}

Mostrar as melhores atualizações disponíveis para um grupo de dispositivos. Esse sinalizador modifica o comando para retornar uma lista.

az iot du device group show -n {account_name} -i {instance_name} --group-id {device_group_id} --best-updates

Mostrar conformidade de atualização para um grupo de dispositivos.

az iot du device group show -n {account_name} -i {instance_name} --group-id {device_group_id} --update-compliance

Parâmetros Obrigatórios

--account -n

Nome da conta de Atualização de Dispositivo. Você pode configurar o nome da conta padrão usando az config set defaults.adu_account=<name>.

--gid --group-id

Id do grupo de dispositivos. Isso é criado a partir do valor da tag ADUGroup no dispositivo/módulo gêmeo ou $default do Hub IoT conectado para dispositivos sem tag.

--instance -i

Nome da instância de Atualização de Dispositivo. Você pode configurar o nome da instância padrão usando az config set defaults.adu_instance=<name>.

Parâmetros Opcionais

--best-updates

Sinalizador indicando que o comando deve buscar as melhores atualizações disponíveis para o grupo de dispositivos, incluindo uma contagem de quantos dispositivos precisam de cada atualização. Uma melhor atualização é a atualização mais recente que atende a todas as especificações de compatibilidade de uma classe de dispositivo.

valores aceites: false, true
--resource-group -g

Nome do grupo de recursos da conta de Atualização de Dispositivo. Você pode configurar o grupo padrão usando az config set defaults.adu_group=<name>.

--update-compliance

Sinalizador indicando que o comando deve buscar informações de conformidade de atualização do grupo de dispositivos, como quantos dispositivos estão em sua atualização mais recente, quantos precisam de novas atualizações e quantos estão em andamento ao receber uma nova atualização.

valores aceites: false, true
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.