Compartilhar via

az iot du device group

Note

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

Gerenciamento de grupos de dispositivos.

Um grupo de dispositivos é uma coleção de dispositivos. Grupos de dispositivos fornecem uma maneira de dimensionar as implantações em vários dispositivos. Cada dispositivo pertence a exatamente um grupo de dispositivos por vez. Um grupo de dispositivos é criado automaticamente quando um dispositivo habilitado para Atualização de Dispositivo é conectado ao hub e relata suas propriedades.

Comandos

Nome Description Tipo Status
az iot du device group delete

Exclua um grupo de dispositivos.

 Extension GA
az iot du device group list

Listar grupos de dispositivos em uma instância.

 Extension GA
az iot du device group show

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

 Extension GA

az iot du device group delete

Exclua um grupo de dispositivos.

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

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

Exemplos

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

--account -n

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

Propriedade Valor
Grupo de parâmetros: Account Identifier Arguments
--gid --group-id

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

--instance -i

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

Propriedade Valor
Grupo de parâmetros: Account Identifier Arguments

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.

--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Account Identifier Arguments
--yes -y

Ignore as solicitações do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Padrão: false.

Propriedade Valor
Valores aceitos: false, true
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 du device group list

Listar grupos de dispositivos em 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}

Listar grupos de dispositivos em uma ordem desejada, nesse caso por deviceCount.

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

Parâmetros Exigidos

--account -n

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

Propriedade Valor
Grupo de parâmetros: Account Identifier Arguments
--instance -i

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

Propriedade Valor
Grupo de parâmetros: Account Identifier Arguments

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.

--order-by

Ordena o conjunto de grupos retornado. Você pode solicitar por groupId, deviceCount, createdDateTime, subgroupsWithNewUpdatesAvailableCount, subgroupsWithUpdatesInProgressCount ou subgroupsWithOnLatestUpdateCount.

--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Account Identifier 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.

--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 du device group show

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

az iot du device group show --account
                            --gid --group-id
                            --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 a 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 Exigidos

--account -n

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

Propriedade Valor
Grupo de parâmetros: Account Identifier Arguments
--gid --group-id

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

--instance -i

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

Propriedade Valor
Grupo de parâmetros: Account Identifier Arguments

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.

--best-updates

Sinalizador que indica 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 atualização recomendada é a atualização mais recente que atende a todas as especificações de compatibilidade de uma classe de dispositivo.

Propriedade Valor
Grupo de parâmetros: Update Arguments
Valores aceitos: false, true
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Account Identifier Arguments
--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.

Propriedade Valor
Grupo de parâmetros: Update Arguments
Valores aceitos: false, true
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