Compartilhar via


az iot du instance

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

Nome Description Tipo Status
az iot du instance create

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

Extension GA
az iot du instance delete

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

Extension GA
az iot du instance list

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

Extension GA
az iot du instance show

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

Extension GA
az iot du instance update

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

Extension GA
az iot du instance wait

Bloqueie até que um estado de recurso de instância desejado seja atendido.

Extension 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. Incluir marcas.

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

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

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

--diagnostics-storage-id

ID de recurso da conta de armazenamento fornecida pelo usuário para uso na coleção de logs de diagnóstico.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
--enable-diagnostics

Habilita a coleção de logs de diagnóstico.

Propriedade Valor
Valores aceitos: false, true
--no-wait

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

Propriedade Valor
Valor padrão: False
--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
--tags

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

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

--no-wait

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

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

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

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

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

Exemplos

Defina um atributo de marca 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 a coleção 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 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.

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
--force-string

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: False
--no-wait

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

Propriedade Valor
Valor padrão: False
--remove

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
--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
--set

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Valor padrão: []
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 instance wait

Bloqueie até que um estado de recurso de instância desejado seja 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 seja 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 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.

--created

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--custom

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
--deleted

Aguarde até ser excluído.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--exists

Aguarde até que o recurso exista.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
--interval

Intervalo de sondagem em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 30
--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
--timeout

Espera máxima em segundos.

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: 3600
--updated

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

Propriedade Valor
Grupo de parâmetros: Wait Condition Arguments
Valor padrão: False
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