Share via

az iot du update

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

Gerenciamento de atualização de atualização de dispositivo.

Comandos

Name Description Tipo Estado
az iot du update calculate-hash

Calcule a representação em hash base64 de um arquivo.

 Extensão GA
az iot du update delete

Exclua uma versão de atualização específica.

 Extensão GA
az iot du update file

Operações de arquivo de atualização.

 Extensão GA
az iot du update file list

Listar IDs do arquivo de atualização com relação ao provedor de atualização, nome e versão.

 Extensão GA
az iot du update file show

Mostrar os detalhes de um arquivo de atualização específico com relação ao provedor de atualização, nome e versão.

 Extensão GA
az iot du update import

Importe uma nova versão de atualização para a instância de Atualização de Dispositivo.

 Extensão GA
az iot du update init

Utilitário para inicialização de manifesto de importação.

 Extensão Pré-visualizar
az iot du update init v5

Inicialize um manifesto de importação v5 com o estado desejado.

 Extensão Pré-visualizar
az iot du update list

Liste as atualizações que foram importadas para a instância de Atualização de Dispositivo.

 Extensão GA
az iot du update show

Mostrar uma versão de atualização específica.

 Extensão GA
az iot du update stage

Prepare uma atualização para importação para uma instância de destino.

 Extensão Pré-visualizar

az iot du update calculate-hash

Calcule a representação em hash base64 de um arquivo.

az iot du update calculate-hash --file-path
                                [--hash-algo {sha256}]

Exemplos

Calcule a representação base64 de um resumo sha256 para um arquivo de atualização de destino.

az iot du update calculate-hash --file-path /path/to/file

Calcule a representação base64 de um resumo sha256 para vários arquivos de atualização de destino.

az iot du update calculate-hash --file-path /path/to/file1 --file-path /path/to/file2 --file-path /path/to/file3

Parâmetros Obrigatórios

--file-path -f

Caminho local para o arquivo de destino para cálculo de hash. --file-path pode ser usado 1 ou mais vezes.

Parâmetros Opcionais

--hash-algo

Algoritmo criptográfico para usar para hashing.

valores aceites: sha256
valor predefinido: sha256
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 update delete

Exclua uma versão de atualização específica.

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

Exemplos

Exclua uma atualização de destino em relação ao provedor de atualização, nome e versão.

az iot du update delete -n {account_name} -i {instance_name} --update-provider {provider_name} --update-name {update_name} --update-version {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>.

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

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

Importe uma nova versão de atualização para a instância de Atualização de Dispositivo.

Este comando suporta a --defer capacidade. Quando usado, o comando armazenará a carga útil do objeto destinada a ser enviada ao Azure em um cache local. O próximo uso deste comando sem --defer combinará a nova carga útil de solicitação com os objetos armazenados em cache enviando-os juntos.

Após o êxito, a entrada de cache local correspondente será limpa. Se ocorrer uma falha, o conteúdo armazenado em cache não será removido. Use az cache comandos para gerenciar entradas de cache local de forma independente.

O suporte de adiamento destina-se principalmente a atualizações com várias etapas de referência, de modo que as atualizações pai e filho possam ser enviadas juntas.

az iot du update import --account
                        --instance
                        --url
                        [--defer]
                        [--file]
                        [--friendly-name]
                        [--hashes]
                        [--no-wait]
                        [--resource-group]
                        [--size]

Exemplos

Importe uma atualização com dois arquivos relacionados e sem etapas de referência, fornecendo explicitamente o valor de hash do manifesto e o tamanho do manifesto em bytes.

az iot du update import -n {account_name} -i {instance_name} --hashes sha256={hash_value} --size {size_in_bytes} --url {manifest_location} --file filename={file1_name} url={file1_url} --file filename={file2_name} url={file2_url}

Importe uma atualização com dois arquivos relacionados e sem etapas de referência, permitindo que a CLI calcule o valor e o tamanho do hash do manifesto de importação em bytes.

az iot du update import -n {account_name} -i {instance_name} --url {manifest_location} --file filename={file1_name} url={file1_url} --file filename={file2_name} url={file2_url}

Importe uma atualização pai com duas etapas de referência de atualização filhas, onde todos os três manifestos de importação têm um arquivo relacionado. Permita que a CLI calcule o valor e o tamanho do hash em bytes para todos. Esta operação contará com a capacidade '--defer'.

az iot du update import -n {account_name} -i {instance_name} --url {parent_manifest_location} --file filename={parent_file_name} url={parent_file_url} --defer

az iot du update import -n {account_name} -i {instance_name} --url {child1_manifest_location} --file filename={child1_file_name} url={child1_file_url} --defer

az iot du update import -n {account_name} -i {instance_name} --url {child2_manifest_location} --file filename={child2_file_name} url={child2_file_url}

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

--url

Local roteável a partir do qual o manifesto de importação pode ser baixado pela Atualização de Dispositivo para o Hub IoT. Normalmente, trata-se de um URL de blob protegido por SAS somente leitura com uma expiração definida para pelo menos 3 horas.

Parâmetros Opcionais

--defer

Armazene temporariamente o objeto no cache local em vez de enviar para o Azure. Use az cache comandos para visualizar/limpar.

--file

Pares chave=valor separados por espaço correspondentes às propriedades do arquivo de metadados de manifesto de importação. As chaves necessárias incluem nome do arquivo e url. --file pode ser usado 1 ou mais vezes.

--friendly-name

Nome amigável associado à definição de atualização.

--hashes

Pares chave=valor separados por espaço, onde a chave é o algoritmo de hash usado e o valor é o hash do arquivo de manifesto de importação codificado em base64. Pelo menos uma entrada sha256 é necessária. Se não for fornecido, será calculado a partir do url fornecido.

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

--size

Tamanho do ficheiro em número de bytes. Se não for fornecido, será calculado a partir do url fornecido.

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

Liste as atualizações que foram importadas para a instância de Atualização de Dispositivo.

Ao listar provedores de atualização, somente o sinalizador --by-provider precisa ser fornecido, além dos argumentos de pesquisa de instância comum. Ao listar nomes de atualização, o provedor de atualização deve ser fornecido. Ao listar versões de atualização, o provedor de atualização e o nome da atualização devem ser fornecidos.

az iot du update list --account
                      --instance
                      [--by-provider {false, true}]
                      [--filter]
                      [--resource-group]
                      [--search]
                      [--un]
                      [--up]

Exemplos

Liste todas as atualizações.

az iot du update list -n {account_name} -i {instance_name}

Liste todas as atualizações que satisfaçam um critério de pesquisa de texto livre, neste caso o provedor de atualizações da Contoso.

az iot du update list -n {account_name} -i {instance_name} --search 'Contoso'

Liste todas as atualizações que satisfazem um filtro odata, neste caso filtrando para atualizações não implantáveis.

az iot du update list -n {account_name} -i {instance_name} --filter 'isDeployable eq false'

Liste todos os provedores de atualização.

az iot du update list -n {account_name} -i {instance_name} --by-provider

Liste todos os nomes de atualização por provedor de atualização.

az iot du update list -n {account_name} -i {instance_name} --update-provider {provider_name}

Liste todas as versões de atualização por provedor de atualização e nome da atualização.

az iot du update list -n {account_name} -i {instance_name} --update-provider {provider_name} --update-name {update_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

--by-provider

Sinalizador que indica que o conjunto de resultados deve ser restrito a provedores de atualização.

valores aceites: false, true
--filter

Restringe o conjunto de atualizações retornadas por valores de propriedade. Suportado ao listar atualizações sem restrições ou ao listar por versã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>.

--search

Solicite atualizações correspondentes a uma expressão de pesquisa de texto livre. Suportado ao listar atualizações sem restrições.

--un --update-name

O nome da atualização.

--up --update-provider

O provedor de atualização.

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

Mostrar uma versão de atualização específica.

az iot du update show --account
                      --instance
                      --un
                      --up
                      --update-version
                      [--resource-group]

Exemplos

Mostrar uma atualização específica em relação ao provedor de atualização, nome e versão.

az iot du update show -n {account_name} -i {instance_name} --update-provider {provider_name} --update-name {update_name} --update-version {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>.

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

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

Pré-visualizar

Este comando está em pré-visualização e em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

Prepare uma atualização para importação para uma instância de destino.

O preparo de uma atualização refere-se à aceleração das etapas de pré-requisito de importação de uma atualização para uma instância de destino. Para um determinado manifesto de importação, o processo determinará arquivos relevantes, enviá-los-á para um contêiner de armazenamento desejado, gerará URIs SAS e cobrirá outras etapas de preparação para uma importação bem-sucedida.

Este comando depende de uma organização baseada em convenção de arquivos de atualização. Espera-se que todos os arquivos de atualização de um manifesto de destino estejam no mesmo diretório em que o manifesto de importação reside.

O acesso baseado em chave é usado para carregar artefatos de blob e gerar URIs SAS de 3 horas de duração com acesso de leitura.

Se --then-import o sinalizador for fornecido, o comando importará a atualização em estágios. Caso contrário, o resultado desta operação é um comando import a ser executado para obter o mesmo resultado em um momento posterior.

Este comando limpará e atualizará qualquer entrada de cache local para a instância de destino.

az iot du update stage --account
                       --instance
                       --manifest-path
                       --storage-account
                       --storage-container
                       [--friendly-name]
                       [--overwrite {false, true}]
                       [--resource-group]
                       [--storage-subscription]
                       [--then-import {false, true}]

Exemplos

Prepare uma atualização independente. Espera-se que os arquivos de atualização residam no mesmo diretório do manifesto. O comando import resultante pode ser executado posteriormente para iniciar a importação da atualização em estágios antes da expiração do token SAS.

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --manifest-path /path/to/manifest.json

Prepare uma atualização independente. Após o preparo, importe a atualização para a instância usando um nome amigável desejado.

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --manifest-path /path/to/manifest.json --then-import --friendly-name myAptUpdate

Prepare uma atualização com várias referências. Os arquivos de atualização serão carregados em um contêiner de blob de armazenamento residente em uma assinatura diferente da conta de atualização.

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --storage-subscription {storage_account_subscription} --manifest-path /path/to/parent/parent.manifest.json --manifest-path /path/to/leaf1/leaf1.manifest.json --manifest-path /path/to/leaf2/leaf2.manifest.json

Prepare uma atualização de várias referências, substituindo blobs existentes, se eles existirem. Após o preparamento, importe a atualização para a instância.

az iot du update stage -n {account_name} -i {instance_name} --storage-account {storage_account_name} --storage-container {storage_container_name} --manifest-path /path/to/parent/parent.manifest.json --manifest-path /path/to/leaf1/leaf1.manifest.json --manifest-path /path/to/leaf2/leaf2.manifest.json --then-import --overwrite

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

--manifest-path

Caminho do arquivo local para o manifesto de importação que deve ser preparado. Pode ser usado 1 ou mais vezes.

--storage-account

Nome da conta de armazenamento desejada para preparar artefatos de manifesto de importação.

--storage-container

Nome do contêiner de armazenamento desejado para preparar artefatos de manifesto de importação.

Parâmetros Opcionais

--friendly-name

Nome amigável associado à definição de atualização.

--overwrite

Sinalizador que indica se os blobs existentes devem ser substituídos se existir um conflito.

valores aceites: false, true
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>.

--storage-subscription

Assinatura de conta de armazenamento desejada para artefatos de manifesto de importação de estágio. Aplicável quando as contas de armazenamento e atualização de dispositivo estão em assinaturas diferentes.

--then-import

Sinalizador que indica se a atualização deve ser importada após o preparo.

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.