Compartilhar via

az iot edge

Note

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

Gerenciar soluções de IoT no Edge.

Comandos

Nome Description Tipo Status
az iot edge deployment

Gerenciar implantações de IoT Edge em escala.

 Extension GA
az iot edge deployment create

Crie uma implantação de IoT Edge em um Hub IoT de destino.

 Extension GA
az iot edge deployment delete

Excluir uma implantação de IoT Edge.

 Extension GA
az iot edge deployment list

Listar implantações de IoT Edge em um Hub IoT.

 Extension GA
az iot edge deployment show

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

 Extension GA
az iot edge deployment show-metric

Avalie uma métrica do sistema de destino definida em uma implantação de IoT Edge.

 Extension GA
az iot edge deployment update

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

 Extension GA
az iot edge devices

Comandos para gerenciar IoT Edge dispositivos.

 Extension GA
az iot edge devices create

Crie e configure vários dispositivos de borda em um 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 GA
az iot edge set-modules

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

 Extension GA

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 do módulo gêmeo pode ser usada diretamente como o --content 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

Exportar a configuração do módulo gêmeo em um dispositivo de destino.

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

Parâmetros Exigidos

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

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do AD Azure. Se o tipo de autenticação for logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja 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
Valor padrão: key
Valores aceitos: key, login
--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
--hub-name -n

Hub IoT nome ou nome do host. Necessário se --login não for fornecido.

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

Esse comando dá suporte a uma entidade cadeia de conexão com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma entidade cadeia de conexão e um nome forem fornecidos, o cadeia de conexão será priorizado. 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 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 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 desabilitado usando a opção --no-validation.

Observação: após a execução, o comando 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

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

--content -k

IoT Edge conteúdo da implantação. 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 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
--auth-type

Indica se a operação deve derivar automaticamente uma chave de política ou usar a sessão atual do AD Azure. Se o tipo de autenticação for logon e o nome do host do recurso for fornecido, a pesquisa de recursos será ignorada, a menos que seja 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
Valor padrão: key
Valores aceitos: key, login
--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
--hub-name -n

Hub IoT nome ou nome do host. Necessário se --login não for fornecido.

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

Esse comando dá suporte a uma entidade cadeia de conexão com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma entidade cadeia de conexão e um nome forem fornecidos, o cadeia de conexão será priorizado. 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 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