az iot adr ns su software-update

Note

Essa referência faz parte da extensão azure-iot para o CLI do Azure (versão 2.73.0 ou superior). A extensão instalará automaticamente na primeira vez que você executar um comando az iot adr ns su software-update . Saiba mais sobre extensões.

O grupo de comandos 'iot adr ns' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Importar e gerenciar o conteúdo de Atualizações de Software.

Usa o serviceAddress do plano de dados materializado no link atualizações de software do namespace. O link deve concluir o provisionamento antes que esses comandos possam ser executados.

Comandos

Nome Description Tipo Status
az iot adr ns su software-update calculate-hash

Calcule hashes de arquivo de atualização localmente.

Extension Preview
az iot adr ns su software-update catalog

Descubra identificadores de catálogo de Atualizações de Software.

Extension Preview
az iot adr ns su software-update catalog name

Descubra nomes de atualização para um provedor.

Extension Preview
az iot adr ns su software-update catalog name list

Listar nomes de atualização para um provedor.

Extension Preview
az iot adr ns su software-update catalog provider

Descubra provedores de atualização.

Extension Preview
az iot adr ns su software-update catalog provider list

Listar provedores de atualização no catálogo.

Extension Preview
az iot adr ns su software-update catalog version

Descubra versões de atualização para um provedor e um nome.

Extension Preview
az iot adr ns su software-update catalog version list

Listar versões de atualização para um provedor e um nome.

Extension Preview
az iot adr ns su software-update delete

Excluir uma atualização importada.

Extension Preview
az iot adr ns su software-update file

Inspecione arquivos pertencentes a uma atualização importada.

Extension Preview
az iot adr ns su software-update file list

Listar identificadores de arquivo para uma atualização importada.

Extension Preview
az iot adr ns su software-update file show

Mostrar um arquivo de atualização importado.

Extension Preview
az iot adr ns su software-update import

Importe uma atualização para atualizações de software.

Extension Preview
az iot adr ns su software-update init

Crie manifestos de importação de Atualizações de Software localmente.

Extension Preview
az iot adr ns su software-update init v5

Crie um manifesto de importação da versão 5.

Extension Preview
az iot adr ns su software-update list

Listar atualizações importadas para atualizações de software.

Extension Preview
az iot adr ns su software-update operation-status

Inspecione operações assíncronas de Atualizações de Software.

Extension Preview
az iot adr ns su software-update operation-status list

Listar os status de operação de Atualizações de Software retidos.

Extension Preview
az iot adr ns su software-update operation-status show

Mostrar um status de operação de Atualizações de Software.

Extension Preview
az iot adr ns su software-update show

Mostrar uma atualização importada.

Extension Preview
az iot adr ns su software-update stage

Preparar artefatos de atualização local e, opcionalmente, importá-los.

Extension Preview
az iot adr ns su software-update wait

Aguarde uma condição de Atualização de Software importada.

Extension Preview

az iot adr ns su software-update calculate-hash

Versão Prévia

O grupo de comandos 'iot adr ns su software-update' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Calcule hashes de arquivo de atualização localmente.

az iot adr ns su software-update calculate-hash --file-path
                                                [--acquire-policy-token]
                                                [--change-reference]
                                                [--hash-algo {sha256}]

Exemplos

Calcular um hash SHA-256

az iot adr ns su software-update calculate-hash --file-path ./payload.bin

Parâmetros obrigatórios

--file-path -f

Arquivo local para hash. Use --file-path mais de uma vez para vários arquivos.

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.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--hash-algo

Algoritmo de hash criptográfico.

Propriedade Valor
Valor padrão: sha256
Valores aceitos: sha256
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 adr ns su software-update delete

Versão Prévia

O grupo de comandos 'iot adr ns su software-update' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Excluir uma atualização importada.

az iot adr ns su software-update delete --name --namespace --ns
                                        --resource-group
                                        --un --update-name
                                        --up --update-provider
                                        --update-version --uv
                                        [--acquire-policy-token]
                                        [--change-reference]
                                        [--no-wait]
                                        [--yes {false, true}]

Exemplos

Excluir uma versão de atualização sem solicitar

az iot adr ns su software-update delete --ns myNamespace -g myResourceGroup \
  --update-provider Contoso --update-name Thermostat --update-version 1.0 --yes

Parâmetros obrigatórios

--name --namespace --ns -n

Nome do namespace do Registro de Dispositivo.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--un --update-name

Nome da atualização.

--up --update-provider

Atualizar o provedor.

--update-version --uv

Atualizar versão.

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.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--no-wait

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

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

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 adr ns su software-update import

Versão Prévia

O grupo de comandos 'iot adr ns su software-update' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Importe uma atualização para atualizações de software.

Importa um manifesto v5 de uma URL acessível por leitura. Quando --size ou --hashes é omitido, a CLI transmite o manifesto para calcular seu tamanho e hash SHA-256.

az iot adr ns su software-update import --name --namespace --ns
                                        --resource-group
                                        --url
                                        [--acquire-policy-token]
                                        [--change-reference]
                                        [--enable-scan {false, true}]
                                        [--file]
                                        [--friendly-name]
                                        [--hashes]
                                        [--no-wait]
                                        [--size]

Exemplos

Importar um manifesto e um arquivo de conteúdo

az iot adr ns su software-update import --ns myNamespace -g myResourceGroup \
  --url "https://storage.example/manifest.json?<sas>" \
  --file filename=payload.bin url="https://storage.example/payload.bin?<sas>"

Parâmetros obrigatórios

--name --namespace --ns -n

Nome do namespace do Registro de Dispositivo.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--url

URL acessível para leitura do manifesto de importação de atualização.

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.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--enable-scan

Solicite verificação de malware para a atualização importada.

Propriedade Valor
Valores aceitos: false, true
--file

Atualize os metadados de arquivo como filename=FILE_NAME url=READ_ACCESSIBLE_URL. --file pode ser usado mais de uma vez.

--friendly-name

Nome amigável associado à atualização importada.

--hashes

Hashes de manifesto como pares key=value. Um valor sha256 é necessário. Calculado de --url quando omitido.

--no-wait

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

Propriedade Valor
Valor padrão: False
--size

Importar o tamanho do manifesto em bytes. Calculado de --url quando omitido.

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 adr ns su software-update list

Versão Prévia

O grupo de comandos 'iot adr ns su software-update' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Listar atualizações importadas para atualizações de software.

az iot adr ns su software-update list --name --namespace --ns
                                      --resource-group
                                      [--filter]
                                      [--search]

Exemplos

Listar todas as atualizações importadas

az iot adr ns su software-update list --ns myNamespace -g myResourceGroup

Listar atualizações implantáveis

az iot adr ns su software-update list --ns myNamespace -g myResourceGroup --filter "isDeployable eq true"

Parâmetros obrigatórios

--name --namespace --ns -n

Nome do namespace do Registro de Dispositivo.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

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.

--filter

Filtrar atualizações por propriedades de serviço com suporte.

Propriedade Valor
Grupo de parâmetros: Filter Arguments
--search

Solicite atualizações que correspondam a uma expressão de pesquisa de texto livre.

Propriedade Valor
Grupo de parâmetros: Filter 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 adr ns su software-update show

Versão Prévia

O grupo de comandos 'iot adr ns su software-update' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Mostrar uma atualização importada.

az iot adr ns su software-update show --name --namespace --ns
                                      --resource-group
                                      --un --update-name
                                      --up --update-provider
                                      --update-version --uv

Exemplos

Mostrar uma versão de atualização

az iot adr ns su software-update show --ns myNamespace -g myResourceGroup \
  --update-provider Contoso --update-name Thermostat --update-version 1.0

Parâmetros obrigatórios

--name --namespace --ns -n

Nome do namespace do Registro de Dispositivo.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--un --update-name

Nome da atualização.

--up --update-provider

Atualizar o provedor.

--update-version --uv

Atualizar versã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 adr ns su software-update stage

Versão Prévia

O grupo de comandos 'iot adr ns su software-update' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Preparar artefatos de atualização local e, opcionalmente, importá-los.

Valida os tamanhos de conteúdo do manifesto local e hashes SHA-256, carrega cada manifesto e seus arquivos para Armazenamento do Azure e reutiliza blobs em etapas correspondentes. As referências de arquivo devem nomear arquivos no mesmo diretório que o manifesto. Sem --then-import, nenhuma URL sas é gerada ou retornada. Com --then-import, novas URLs SAS somente leitura são geradas e todos os manifestos são enviados em uma solicitação de importação.

az iot adr ns su software-update stage --manifest-path
                                       --name --namespace --ns
                                       --resource-group
                                       --storage-account
                                       --storage-container
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--enable-scan {false, true}]
                                       [--friendly-name]
                                       [--no-wait]
                                       [--overwrite {false, true}]
                                       [--sas-expiry-hours]
                                       [--storage-prefix]
                                       [--storage-subscription]
                                       [--then-import {false, true}]

Exemplos

Preparar uma única atualização sem importá-la

az iot adr ns su software-update stage --ns myNamespace -g myResourceGroup \
  --manifest-path ./manifest.json --storage-account mystorage \
  --storage-container updates

Preparar e importar uma atualização de várias referências

az iot adr ns su software-update stage --ns myNamespace -g myResourceGroup \
  --manifest-path ./root.json --manifest-path ./leaf.json \
  --storage-account /subscriptions/<sub>/resourceGroups/<rg>/providers/Microsoft.Storage/storageAccounts/mystorage \
  --storage-container updates --then-import --enable-scan

Parâmetros obrigatórios

--manifest-path

Caminho do manifesto de importação local. Use --manifest-path mais de uma vez para uma atualização de várias referências, com o manifesto raiz primeiro.

--name --namespace --ns -n

Nome do namespace do Registro de Dispositivo.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--storage-account

Nome da conta de armazenamento ou ID de recurso do ARM usada para preparar artefatos.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
--storage-container

Contêiner de blob usado para preparar artefatos.

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

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--enable-scan

Solicite verificação de malware quando --then-import for usado.

Propriedade Valor
Valores aceitos: false, true
--friendly-name

Nome amigável aplicado ao primeiro manifesto raiz.

--no-wait

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

Propriedade Valor
Valor padrão: False
--overwrite

Substitua blobs preparados cujo conteúdo difere dos artefatos locais.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
Valor padrão: False
Valores aceitos: false, true
--sas-expiry-hours

Tempo de vida sas somente leitura usado por --then-import. O padrão é de 4 horas.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
Valor padrão: 4
--storage-prefix

Prefixo de nome do blob. O padrão é "deviceupdate".

Propriedade Valor
Grupo de parâmetros: Storage Arguments
--storage-subscription

Assinatura da conta de armazenamento. Use quando a conta de armazenamento estiver em uma assinatura diferente e for especificada pelo nome.

Propriedade Valor
Grupo de parâmetros: Storage Arguments
--then-import

Importe todos os manifestos em etapas em uma solicitação após o upload.

Propriedade Valor
Valor padrão: False
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 adr ns su software-update wait

Versão Prévia

O grupo de comandos 'iot adr ns su software-update' está em versão prévia e em desenvolvimento. Níveis de referência e suporte: https://aka.ms/CLI_refstatus

Aguarde uma condição de Atualização de Software importada.

O modelo de Atualização de Software não tem status de ciclo de vida. Sem um predicado de espera explícito, um GET bem-sucedido significa que a atualização importada está materializada e pronta.

az iot adr ns su software-update wait --name --namespace --ns
                                      --resource-group
                                      --un --update-name
                                      --up --update-provider
                                      --update-version --uv
                                      [--acquire-policy-token]
                                      [--change-reference]
                                      [--created]
                                      [--custom]
                                      [--deleted]
                                      [--exists]
                                      [--interval]
                                      [--timeout]
                                      [--updated]

Exemplos

Aguarde até que exista uma atualização importada

az iot adr ns su software-update wait --ns myNamespace -g myResourceGroup \
  --update-provider Contoso --update-name Thermostat --update-version 1.0

Parâmetros obrigatórios

--name --namespace --ns -n

Nome do namespace do Registro de Dispositivo.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--un --update-name

Nome da atualização.

--up --update-provider

Atualizar o provedor.

--update-version --uv

Atualizar versão.

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.

--acquire-policy-token

Adquirir um token Azure Policy automaticamente para essa operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

A ID de referência de alteração relacionada para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--created

Aguarde até que a atualização de software exista. As atualizações de software não têm provisionamentoState.

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

Aguarde até que uma expressão JMESPath personalizada seja avaliada como true.

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

Aguarde até que o recurso seja 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
--timeout

Orçamento de sondagem em segundos, incluindo tempo GET. Um GET a bordo é limitado por tempos limite de transporte e não pode ser interrompido por este prazo de sondagem.

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

Aguarde até que a atualização de software exista. As atualizações de software não têm provisionamentoState.

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