az iot du device deployment

  • 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 deployment . Saiba mais sobre extensões.

Gerenciamento de implantação de dispositivos.

As implantações aplicarão uma atualização compatível desejada em relação a um grupo de dispositivos de destino distribuindo a atualização entre as classes de dispositivos dentro do grupo. A política de reversão iniciada na nuvem pode ser configurada opcionalmente.

Comandos

Name Description Tipo Estado
az iot du device deployment cancel

Cancelar a implantação de um subgrupo de classe de dispositivo.

 Extensão GA
az iot du device deployment create

Crie uma implantação para um grupo de dispositivos. A implantação será multicast em cada subgrupo de classe de dispositivo dentro do grupo-alvo.

 Extensão GA
az iot du device deployment delete

Exclua uma implantação por grupo de dispositivos ou subgrupo de classe de dispositivo.

 Extensão GA
az iot du device deployment list

Listar implantações para um grupo de dispositivos ou subgrupo de classe de dispositivo.

 Extensão GA
az iot du device deployment list-devices

Liste dispositivos em uma implantação de subgrupo de classe de dispositivo junto com seu estado. Útil para obter uma lista de dispositivos com falha.

 Extensão GA
az iot du device deployment retry

Repita a implantação de um subgrupo de classe de dispositivo.

 Extensão GA
az iot du device deployment show

Mostrar uma implantação para um grupo de dispositivos ou subgrupo de classe de dispositivo, incluindo status que detalha um detalhamento de quantos dispositivos na implantação estão em andamento, concluídos ou com falha.

 Extensão GA

az iot du device deployment cancel

Cancelar a implantação de um subgrupo de classe de dispositivo.

az iot du device deployment cancel --account
                                   --cid
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--resource-group]

Exemplos

Cancele a implantação do subgrupo de classe de dispositivo de destino.

az iot du device deployment cancel -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

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

--cid --class-id

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.

--deployment-id --did

A ID de implantação fornecida pelo chamador. Isso não pode ter mais de 73 caracteres, deve ser todo minúsculo e não pode conter '&', '^', '[', ']', '{', '}', '|', '', ''<, barra para frente, barra> invertida ou aspas duplas.

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

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

Crie uma implantação para um grupo de dispositivos. A implantação será multicast em cada subgrupo de classe de dispositivo dentro do grupo-alvo.

az iot du device deployment create --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   --un
                                   --up
                                   --update-version
                                   [--failed-count]
                                   [--failed-percentage]
                                   [--rbun]
                                   [--rbup]
                                   [--rbuv]
                                   [--resource-group]
                                   [--start-time]

Exemplos

Crie uma implantação de grupo de dispositivos agendada para iniciar imediatamente (em relação à hora UTC).

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version}

Crie uma implantação de grupo de dispositivos agendada para iniciar em um datetime compatível com iso-8601 desejado.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --start-time "2022-12-20T01:00:00"

Crie uma implantação de grupo de dispositivos agendada para iniciar imediatamente com uma política de reversão iniciada na nuvem definida. A reversão na nuvem é iniciada quando a contagem com falha ou as metas percentuais com falha são atingidas.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --failed-count 10 --failed-percentage 5 --rollback-update-name {rollback_update_name} --rollback-update-provider {rollback_update_provider} --rollback-update-version {rollback_update_version}

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

--deployment-id --did

A ID de implantação fornecida pelo chamador. Isso não pode ter mais de 73 caracteres, deve ser todo minúsculo e não pode conter '&', '^', '[', ']', '{', '}', '|', '', ''<, barra para frente, barra> invertida ou aspas duplas.

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

--un --update-name

O nome da atualização.

--up --update-provider

O provedor de atualização.

--update-version --uv

A versão de atualização.

Parâmetros Opcionais

--failed-count --fc

Inteiro que representa o número de dispositivos com falha em uma implantação antes que ocorra uma reversão iniciada na nuvem. Necessário ao definir a política de reversão.

--failed-percentage --fp

Inteiro que representa a porcentagem de dispositivos com falha em uma implantação antes que ocorra uma reversão iniciada na nuvem. Necessário ao definir a política de reversão.

--rbun --rollback-update-name

O nome da atualização de reversão.

--rbup --rollback-update-provider

O provedor de atualização de reversão.

--rbuv --rollback-update-version

A versão de atualização de reversão.

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

--start-time

A hora de início da implantação em conformidade com a ISO-8601. Se nenhum valor for fornecido, o valor correspondente para UTC 'agora' será usado.

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

Exclua uma implantação por grupo de dispositivos ou subgrupo de classe de dispositivo.

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

Exemplos

Exclua a implantação do grupo de dispositivos de destino.

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

Exclua a implantação do subgrupo de classe de dispositivo de destino.

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

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

--deployment-id --did

A ID de implantação fornecida pelo chamador. Isso não pode ter mais de 73 caracteres, deve ser todo minúsculo e não pode conter '&', '^', '[', ']', '{', '}', '|', '', ''<, barra para frente, barra> invertida ou aspas duplas.

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

--cid --class-id

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.

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

Listar implantações para um grupo de dispositivos ou subgrupo de classe de dispositivo.

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

Exemplos

Listar implantações para um grupo de dispositivos.

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

Liste implantações para um grupo de dispositivos ordenando resultados por startDateTime decrescente.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --order-by "startDateTime desc"

Listar implantações para um subgrupo de classe de dispositivo.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id}

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

--cid --class-id

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.

--order-by

Ordena o conjunto de implantações retornadas. Você pode encomendar por startDateTime [desc/asc].

--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 deployment list-devices

Liste dispositivos em uma implantação de subgrupo de classe de dispositivo junto com seu estado. Útil para obter uma lista de dispositivos com falha.

az iot du device deployment list-devices --account
                                         --cid
                                         --deployment-id
                                         --gid
                                         --instance
                                         [--filter]
                                         [--resource-group]

Exemplos

Listar dispositivos em uma implantação de subgrupo de classe de dispositivo.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Liste dispositivos em uma filtragem de implantação de subgrupo de classe de dispositivo por deviceId e deviceState.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --filter "deviceId eq 'd0' and deviceState eq 'InProgress'"

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

--cid --class-id

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.

--deployment-id --did

A ID de implantação fornecida pelo chamador. Isso não pode ter mais de 73 caracteres, deve ser todo minúsculo e não pode conter '&', '^', '[', ']', '{', '}', '|', '', ''<, barra para frente, barra> invertida ou aspas duplas.

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

--filter

Restringe o conjunto de estados do dispositivo de implantação retornados. Você pode filtrar deviceId e moduleId e/ou deviceState.

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

Repita a implantação de um subgrupo de classe de dispositivo.

az iot du device deployment retry --account
                                  --cid
                                  --deployment-id
                                  --gid
                                  --instance
                                  [--resource-group]

Exemplos

Tente novamente a implantação do subgrupo da classe de dispositivo de destino.

az iot du device deployment retry -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

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

--cid --class-id

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.

--deployment-id --did

A ID de implantação fornecida pelo chamador. Isso não pode ter mais de 73 caracteres, deve ser todo minúsculo e não pode conter '&', '^', '[', ']', '{', '}', '|', '', ''<, barra para frente, barra> invertida ou aspas duplas.

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

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

Mostrar uma implantação para um grupo de dispositivos ou subgrupo de classe de dispositivo, incluindo status que detalha um detalhamento de quantos dispositivos na implantação estão em andamento, concluídos ou com falha.

az iot du device deployment show --account
                                 --deployment-id
                                 --gid
                                 --instance
                                 [--cid]
                                 [--resource-group]
                                 [--status {false, true}]

Exemplos

Mostrar uma implantação para um grupo de dispositivos.

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

Mostrar o status de uma implantação de grupo de dispositivos.

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

Mostrar uma implantação para um subgrupo de classe de dispositivo.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Mostrar o status de uma implantação de subgrupo de classe de dispositivo.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --status

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

--deployment-id --did

A ID de implantação fornecida pelo chamador. Isso não pode ter mais de 73 caracteres, deve ser todo minúsculo e não pode conter '&', '^', '[', ']', '{', '}', '|', '', ''<, barra para frente, barra> invertida ou aspas duplas.

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

--cid --class-id

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.

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

--status

Obtém o status de uma implantação, incluindo um detalhamento de quantos dispositivos na implantação estão em andamento, concluídos ou falharam.

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.