Partilhar via

az iot edge

Note

Esta referência faz parte da extensão azure-iot para o CLI do Azure (versão 2.70.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot edge. Saiba mais sobre extensões.

Gerencie soluções de IoT na borda.

Comandos

Name Description Tipo Status
az iot edge deployment

Gerir implementações de IoT Edge em grande escala.

 Extension disponibilidade geral
az iot edge deployment create

Crie uma implementação IoT Edge num Hub IoT alvo.

 Extension disponibilidade geral
az iot edge deployment delete

Eliminar uma implementação do IoT Edge.

 Extension disponibilidade geral
az iot edge deployment list

Liste implementações de IoT Edge num Hub IoT.

 Extension disponibilidade geral
az iot edge deployment show

Obtenha os detalhes de uma implementação IoT Edge.

 Extension disponibilidade geral
az iot edge deployment show-metric

Avalie uma métrica do sistema-alvo definida numa implementação IoT Edge.

 Extension disponibilidade geral
az iot edge deployment update

Atualize as propriedades especificadas de uma implementação do IoT Edge.

 Extension disponibilidade geral
az iot edge devices

Comandos para gerir dispositivos IoT Edge.

 Extension disponibilidade geral
az iot edge devices create

Crie e configure múltiplos dispositivos edge num Hub IoT.

 Extension Experimental
az iot edge export-modules

Exporte a configuração dos módulos de borda em um único dispositivo de borda.

 Extension disponibilidade geral
az iot edge set-modules

Defina módulos de borda em um único dispositivo.

 Extension disponibilidade geral

az iot edge export-modules

Exporte a configuração dos módulos de borda em um único dispositivo de borda.

A saída de configuração dupla do módulo pode ser usada diretamente como o --conteúdo de "az iot edge set-modules".

az iot edge export-modules --device-id
                           [--acquire-policy-token]
                           [--auth-type {key, login}]
                           [--change-reference]
                           [--hub-name]
                           [--login]
                           [--resource-group]

Exemplos

Configuração dupla do módulo de exportação em um dispositivo de destino.

az iot edge export-modules --hub-name {iothub_name} --device-id {device_id}

Parâmetros Obrigatórios

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

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

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--hub-name -n

Nome do Hub IoT ou nome de host. Obrigatório se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligação tem prioridade. Obrigatório se --hub-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False

az iot edge set-modules

Defina módulos de borda em um único dispositivo.

O conteúdo dos módulos é json e na forma de {"modulesContent":{...}} ou {"content":{"modulesContent":{...}}}.

Por padrão, as propriedades dos módulos do sistema $edgeAgent e $edgeHub são validadas em relação aos esquemas instalados com a extensão IoT. Isso pode ser desativado usando a opção --no-validação.

Nota: Após a execução o comando irá produzir a coleção de módulos aplicados ao dispositivo.

az iot edge set-modules --content
                        --device-id
                        [--acquire-policy-token]
                        [--auth-type {key, login}]
                        [--change-reference]
                        [--hub-name]
                        [--login]
                        [--resource-group]

Exemplos

Teste módulos de borda durante o desenvolvimento, definindo módulos em um dispositivo de destino.

az iot edge set-modules --hub-name {iothub_name} --device-id {device_id} --content ../modules_content.json

Parâmetros Obrigatórios

--content -k

Conteúdo de implementação do IoT Edge. Forneça o caminho do arquivo ou json bruto.

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

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

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do Azure AD. Se o tipo de autenticação for login e o nome de host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que necessário. Você pode configurar o padrão usando az configure --defaults iothub-data-auth-type={auth-type-value}.

Propriedade Valor
Grupo de parâmetros: Access Control Arguments
Default value: key
Valores aceites: key, login
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--hub-name -n

Nome do Hub IoT ou nome de host. Obrigatório se --login não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--login -l

Este comando suporta uma cadeia de ligação de entidade com direitos para executar ações. Use para evitar login de sessão via "az login". Se forem fornecidos tanto uma entidade, cadeia de ligação como o nome, a cadeia de ligação tem prioridade. Obrigatório se --hub-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: 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 subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

Propriedade Valor
Default value: False