az iot du device class
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 será instalada automaticamente na primeira vez que você executar um comando az iot du device class. Saiba mais sobre extensões.
Gerenciamento de subgrupos de classe de dispositivo e classe de dispositivo.
Uma classe de dispositivo descreve um conjunto de dispositivos que compartilham um conjunto comum de atributos entre grupos, enquanto um subgrupo de classe de dispositivo é um subconjunto de dispositivos em um grupo que compartilham a mesma ID de classe de dispositivo. As classes de dispositivo são criadas automaticamente quando dispositivos habilitados para Atualização de Dispositivo são conectados ao hub.
Comandos
| Nome | Descrição | Tipo | Estado |
|---|---|---|---|
| az iot du device class delete |
Exclua uma classe de dispositivo ou subgrupo de classe de dispositivo. |
Extension | disponibilidade geral |
| az iot du device class list |
Listar classes de dispositivo ou subgrupos de classe de dispositivo. |
Extension | disponibilidade geral |
| az iot du device class show |
Mostrar detalhes sobre uma classe de dispositivo ou subgrupo de classe de dispositivo, incluindo atualizações instaláveis, a melhor atualização e conformidade de atualização. |
Extension | disponibilidade geral |
| az iot du device class update |
Atualizar uma classe de dispositivo. |
Extension | disponibilidade geral |
az iot du device class delete
Exclua uma classe de dispositivo ou subgrupo de classe de dispositivo.
As classes de dispositivo são criadas automaticamente quando os dispositivos habilitados para Atualização de Dispositivo são conectados ao hub, mas não são limpos automaticamente, pois são referenciados por subgrupos de classe de dispositivo. Se todos os subgrupos de classe de dispositivo de uma classe de dispositivo de destino forem excluídos, a própria classe de dispositivo também poderá ser excluída para remover os registros do sistema e parar de verificar a compatibilidade da classe de dispositivo com novas atualizações. Se um dispositivo for religado, a sua classe de dispositivo será recriada se não existir.
az iot du device class delete --account
--cid --class-id
--instance
[--gid --group-id]
[--resource-group]
[--yes {false, true}]
Exemplos
Exclua uma classe de dispositivo.
az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id}
Exclua uma classe de dispositivo e ignore o prompt de confirmação.
az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} -y
Exclua um subgrupo de classe de dispositivo.
az iot du device class delete -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}
Parâmetros Obrigatórios
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
Id da classe de dispositivo. Isso é gerado a partir da ID do modelo e das propriedades de compat relatadas pelo agente de atualização de dispositivo na interface PnP de Atualização de Dispositivo no Hub IoT. É um hash SHA1 codificado por hex.
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
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.
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.
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
Ignore os prompts do usuário. Indica a aceitação da ação. Usado principalmente para cenários de automação. Predefinição: false.
| Propriedade | Valor |
|---|---|
| Valores aceites: | false, true |
Parâmetros globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot du device class list
Listar classes de dispositivo ou subgrupos de classe de dispositivo.
az iot du device class list --account
--instance
[--filter]
[--gid --group-id]
[--resource-group]
Exemplos
Listar classes de dispositivo dentro de uma instância.
az iot du device class list -n {account_name} -i {instance_name}
Listar classes de dispositivo de instância filtradas por nome amigável.
az iot du device class list -n {account_name} -i {instance_name} --filter "friendlyName eq 'my-favorite-class'"
Listar subgrupos de classe de dispositivo para o grupo.
az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id}
Listar subgrupos de classe de dispositivo para o grupo, filtrados por compatProperties/manufacturer.
az iot du device class list -n {account_name} -i {instance_name} --group-id {device_group_id} --filter "compatProperties/manufacturer eq 'Contoso'"
Parâmetros Obrigatórios
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
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.
Se fornecido com --group-id, suporta filtragem com base em nomes e valores de propriedades compat de classe de dispositivo. Por exemplo, "compatProperties/manufacturer eq 'Contoso'". Caso contrário, suporta filtragem por nome amigável de classe.
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.
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
Parâmetros globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot du device class show
Mostrar detalhes sobre uma classe de dispositivo ou subgrupo de classe de dispositivo, incluindo atualizações instaláveis, a melhor atualização e conformidade de atualização.
az iot du device class show --account
--cid --class-id
--instance
[--best-update {false, true}]
[--gid --group-id]
[--installable-updates {false, true}]
[--resource-group]
[--update-compliance {false, true}]
Exemplos
Mostrar uma classe de dispositivo.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id}
Mostrar atualizações instaláveis para a classe de dispositivo. Esse sinalizador modifica o comando para retornar uma lista.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --installable-updates
Mostrar um subgrupo de classe de dispositivo.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id}
Mostrar a melhor atualização disponível para um subgrupo de classe de dispositivo.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --best-update
Mostrar conformidade de atualização para um subgrupo de classe de dispositivo.
az iot du device class show -n {account_name} -i {instance_name} --class-id {device_class_id} --group-id {device_group_id} --update-compliance
Parâmetros Obrigatórios
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
Id da classe de dispositivo. Isso é gerado a partir da ID do modelo e das propriedades de compat relatadas pelo agente de atualização de dispositivo na interface PnP de Atualização de Dispositivo no Hub IoT. É um hash SHA1 codificado por hex.
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
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.
Sinalizador indicando que o comando deve buscar a melhor atualização disponível para o subgrupo de classe de dispositivo, incluindo uma contagem de quantos dispositivos precisam da atualização. A ID do grupo é necessária para este sinalizador. Uma melhor atualização é 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 aceites: | false, true |
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.
Sinalizador indicando que o comando deve buscar atualizações instaláveis para a classe de dispositivo.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Update Arguments |
| Valores aceites: | false, true |
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
Sinalizador indicando que o comando deve buscar informações de conformidade de atualização do subgrupo de classe de dispositivo, 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. A ID do grupo é necessária para este sinalizador.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Update Arguments |
| Valores aceites: | false, true |
Parâmetros globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
az iot du device class update
Atualizar uma classe de dispositivo.
az iot du device class update --account
--cid --class-id
--instance
[--friendly-name]
[--resource-group]
Exemplos
Atualize o nome amigável da classe de dispositivo.
az iot du device class update -n {account_name} -i {instance_name} --class-id {device_class_id} --friendly-name "EU-region"
Parâmetros Obrigatórios
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
Id da classe de dispositivo. Isso é gerado a partir da ID do modelo e das propriedades de compat relatadas pelo agente de atualização de dispositivo na interface PnP de Atualização de Dispositivo no Hub IoT. É um hash SHA1 codificado por hex.
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
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.
O nome amigável da classe de dispositivo. O nome amigável deve ter de 1 a 100 caracteres e suporta valores alfanuméricos, pontos e traços.
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}.
| Propriedade | Valor |
|---|---|
| Grupo de parâmetros: | Account Identifier Arguments |
Parâmetros globais
Aumente a verbosidade do log para mostrar todos os logs de depuração.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Mostrar esta mensagem de ajuda e sair.
Mostrar apenas erros, suprimindo avisos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |
Formato de saída.
| Propriedade | Valor |
|---|---|
| Valor padrão: | json |
| Valores aceites: | json, jsonc, none, table, tsv, yaml, yamlc |
Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.
Nome ou ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.
Aumente a verbosidade do registro. Use --debug para logs de depuração completos.
| Propriedade | Valor |
|---|---|
| Valor padrão: | False |