Share via

az iot du instance

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

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

Comandos

Name Description Tipo Estado
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

Bloqueie até que um estado de recurso de instância desejado tenha sido atingido.

 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 o diagnóstico habilitado, emparelhado 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 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>.

--iothub-ids

Ids de recursos do Hub IoT separados por espaço.

Parâmetros Opcionais

--diagnostics-storage-id

O usuário forneceu o ID do recurso da conta de armazenamento para uso na coleta de logs de diagnóstico.

--enable-diagnostics

Permite a coleta de logs de diagnóstico.

valores aceites: false, true
--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: 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. Saco de propriedades em pares chave-valor com o seguinte formato: a=b c=d.

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

--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: 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

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

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

--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 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 diagnósticos 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 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

--add

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

valor predefinido: []
--force-string

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

valor predefinido: False
--no-wait

Não espere que a operação de longa duração termine.

valor predefinido: False
--remove

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

valor predefinido: []
--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 ser definido. Exemplo: --set property1.property2=<value>.

valor predefinido: []
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 instance wait

Bloqueie até que um estado de recurso de instância desejado tenha sido atingido.

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

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

valor predefinido: 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 predefinido: False
--exists

Aguarde até que o recurso exista.

valor predefinido: False
--interval

Intervalo de sondagem em segundos.

valor predefinido: 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 predefinido: 3600
--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

valor predefinido: False
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.