az iot du instance

  • Referência

Observação

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

Gerenciamento de instância de atualização de dispositivo.

Comandos

Nome Description Tipo Status
az iot du instance create

Crie uma instância de Atualização de Dispositivo.

 Extensão GA
az iot du instance delete

Exclua uma instância de Atualização de Dispositivo.

 Extensão GA
az iot du instance list

Listar instâncias de Atualização de Dispositivo.

 Extensão GA
az iot du instance show

Mostrar uma instância de Atualização de Dispositivo.

 Extensão GA
az iot du instance update

Atualize uma instância de Atualização de Dispositivo.

 Extensão GA
az iot du instance wait

Bloquear até que um estado de recurso de instância desejado tenha sido atendido.

 Extensão GA

az iot du instance create

Crie uma instância de Atualização de Dispositivo.

Esse comando também pode ser usado para atualizar o estado de uma instância existente.

az iot du instance create --account
                          --instance
                          --iothub-ids
                          [--diagnostics-storage-id]
                          [--enable-diagnostics {false, true}]
                          [--no-wait]
                          [--resource-group]
                          [--tags]

Exemplos

Crie uma instância com configuração mínima.

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id}

Crie uma instância com diagnósticos habilitados, emparelhada com uma conta de armazenamento fornecida pelo usuário. Inclua tags.

az iot du instance create -n {account_name} -i {instance_name} --iothub-ids {iothub_resource_id} --enable-diagnostics --diagnostics-storage-id {storage_account_resource_id} --tags a=b

Parâmetros Exigidos

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

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

--iothub-ids

IDs de recurso do Hub IoT separados por espaço.

Parâmetros Opcionais

--diagnostics-storage-id

ID de recurso da conta de armazenamento fornecida pelo usuário para uso na coleta de logs de diagnóstico.

--enable-diagnostics

Habilita a coleta de logs de diagnóstico.

valores aceitos: false, true
--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--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>.

--tags

Tags de recursos. Conjunto de propriedades em pares chave-valor com o seguinte formato: a=b c=d.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot du instance delete

Exclua uma instância de Atualização de Dispositivo.

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

Exemplos

Exclua uma instância associada à conta de destino.

az iot du instance delete -n {account_name} -i {instance_name}

Exclua uma instância associada à conta de destino e ignore o prompt de confirmação.

az iot du instance delete -n {account_name} -i {instance_name} -y

Parâmetros Exigidos

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

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

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--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

Ignorar prompts do usuário. Indica aceitação da ação. Usado principalmente para cenários de automação. Padrão: falso.

valores aceitos: false, true
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot du instance list

Listar instâncias de Atualização de Dispositivo.

az iot du instance list --account
                        [--resource-group]

Exemplos

Listar instâncias associadas à conta de destino.

az iot du instance list -n {account_name}

Parâmetros Exigidos

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

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot du instance show

Mostrar uma instância de Atualização de Dispositivo.

az iot du instance show --account
                        --instance
                        [--resource-group]

Exemplos

Mostrar os detalhes de uma instância associada à conta de destino.

az iot du instance show -n {account_name} -i {instance_name}

Parâmetros Exigidos

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

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

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

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot du instance update

Atualize uma instância de Atualização de Dispositivo.

Atualmente, as seguintes propriedades de instância podem ser atualizadas - iotHubs, enableDiagnostics, diagnosticStorageProperties e tags.

az iot du instance update --account
                          --instance
                          [--add]
                          [--force-string]
                          [--no-wait]
                          [--remove]
                          [--resource-group]
                          [--set]

Exemplos

Defina um atributo de tag de instância específico.

az iot du instance update -n {account_name} -i {instance_name} --set tags.env='test'

Habilite o diagnóstico e configure uma conta de armazenamento para coleta de logs.

az iot du instance update -n {account_name} -i {instance_name} --set enableDiagnostics=true diagnosticStorageProperties.resourceId={storage_account_resource_id}

Parâmetros Exigidos

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

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

Parâmetros Opcionais

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

valor padrão: []
--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

valor padrão: False
--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

valor padrã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>.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>.

valor padrão: []
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.

az iot du instance wait

Bloquear até que um estado de recurso de instância desejado tenha sido atendido.

az iot du instance wait --account
                        --instance
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--resource-group]
                        [--timeout]
                        [--updated]

Exemplos

Bloqueie até que a instância de destino tenha sido excluída.

az iot du instance wait -n {account_name} -i {instance_name} --deleted

Parâmetros Exigidos

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

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

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor padrão: False
--exists

Aguarde até que o recurso exista.

valor padrão: False
--interval

Intervalo de sondagem em segundos.

valor padrão: 30
--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>.

--timeout

Espera máxima em segundos.

valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.