az iot edge

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

Gerencie soluções de IoT na borda.

Comandos

Name Description Tipo Estado
az iot edge deployment

Gerencie implantações do IoT Edge em escala.

Extensão GA
az iot edge deployment create

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

Extensão GA
az iot edge deployment delete

Exclua uma implantação do IoT Edge.

Extensão GA
az iot edge deployment list

Liste implantações do IoT Edge em um Hub IoT.

Extensão GA
az iot edge deployment show

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

Extensão GA
az iot edge deployment show-metric

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

Extensão GA
az iot edge deployment update

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

Extensão GA
az iot edge devices

Comandos para gerenciar dispositivos IoT Edge.

Extensão GA
az iot edge devices create

Crie e configure vários dispositivos de borda em um Hub IoT.

Extensão Experimental
az iot edge export-modules

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

Extensão GA
az iot edge set-modules

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

Extensão 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 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
                           [--auth-type {key, login}]
                           [--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

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

valores aceites: key, login
valor predefinido: key
--hub-name -n

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

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--resource-group -g

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

--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 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
                        [--auth-type {key, login}]
                        [--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 implantação do IoT Edge. Forneça o caminho do arquivo ou json bruto.

--device-id -d

ID do dispositivo de destino.

Parâmetros Opcionais

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

valores aceites: key, login
valor predefinido: key
--hub-name -n

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

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o login da sessão via "az login". Se uma cadeia de conexão de entidade e um nome forem fornecidos, a cadeia de conexão terá prioridade. Obrigatório se --hub-name não for fornecido.

--resource-group -g

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

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