az iot edge devices

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). A extensão será instalada automaticamente na primeira vez que você executar um comando az iot edge devices. Learn more about extensions.

Comandos para gerenciar dispositivos IoT Edge.

Comandos

Name	Description	Tipo	Status
az iot edge devices create	Crie e configure vários dispositivos de borda em um Hub IoT.	Extension	Experimental

az iot edge devices create

Experimental

Este comando é experimental e está em desenvolvimento. Níveis de referência e de apoio: https://aka.ms/CLI_refstatus

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

Esta operação aceita argumentos de dispositivo embutidos ou um arquivo de configuração de dispositivos de borda no formato YAML ou JSON. O comando inline args (como '--device-auth') terá precedência e substituirá as propriedades do arquivo de configuração se forem fornecidos. Um arquivo de configuração de exemplo pode ser encontrado aqui: https://aka.ms/aziotcli-edge-devices-config Revise exemplos e descrições de parâmetros para obter detalhes sobre como utilizar totalmente essa operação.

az iot edge devices create [--auth-type {key, login}]
                           [--cfg --config --config-file]
                           [--clean {false, true}]
                           [--dct --device-config-template]
                           [--dea --default-agent --default-edge-agent]
                           [--device]
                           [--device-auth --device-auth-type {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out --output-path]
                           [--rc --root-cert]
                           [--resource-group]
                           [--rk --root-key]
                           [--root-pass --rp]
                           [--vis --visualize {false, true}]
                           [--yes {false, true}]

Exemplos

Criar alguns dispositivos de borda usando autenticação de chave simétrica (padrão)

az iot edge devices create -n {hub_name} --device id=device_1 --device id=device_2

Crie uma lista simples de dispositivos de borda usando autenticação de certificado autoassinada com várias configurações de propriedade de borda, usando argumentos embutidos.

az iot edge devices create -n {hub_name} --device-auth x509_thumbprint --default-edge-agent "mcr.microsoft.com/azureiotedge-agent:1.4"
--device id=device_1 hostname={FQDN}
--device id=device_2 edge_agent={agent_image}
--device id=parent hostname={FQDN} edge_agent={agent_image} container_auth={path_or_json_string}

Exclua todas as identidades de dispositivo existentes em um hub e crie novos dispositivos com base em um arquivo de configuração (com barras de progresso e saída de visualização).

az iot edge devices create -n {hub_name} --cfg path/to/config_yml_or_json -c -v

Crie um grupo de dispositivos de borda aninhados com implantações de módulo personalizado - contendo 2 dispositivos pai com 1 dispositivo filho cada, usando argumentos embutidos. Também especifica o caminho de saída para pacotes de certificados de dispositivo.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--device id=parent_1 deployment=/path/to/parentDeployment_1.json
--device id=child_1 parent=parent_1 deployment=/path/to/child_deployment_1.json
--device id=parent_2 deployment=/path/to/parentDeployment_2.json
--device id=child_2 parent=parent_2 deployment=/path/to/child_deployment_2.json

Crie uma configuração simples de dispositivo de borda aninhada com uma CA raiz existente, usando x509 auth, e especifique um caminho de saída de pacote de dispositivo personalizado.

az iot edge devices create -n {hub_name} --out {device_bundle_path}
--root-cert "root_cert.pem" --root-key "root_key.pem" --device-auth x509_thumbprint
--device id=parent1
--device id=child1 parent=parent1

Parâmetros Opcionais

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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
Parameter group:	Access Control Arguments
Default value:	key
Valores aceites:	key, login

--cfg --config --config-file

Caminho para o arquivo de configuração de dispositivos. Exemplo de arquivo de configuração: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Exclui todos os dispositivos no hub de destino antes de criar novos dispositivos.

Propriedade	Valor
Default value:	False
Valores aceites:	false, true

--dct --device-config-template

Caminho para o arquivo config.toml do IoT Edge a ser usado como base para configurações de dispositivos de borda.

--dea --default-agent --default-edge-agent

Agente de borda padrão para dispositivos de Borda criados, se não especificado individualmente.

--device -d

Pares chave=valor separados por espaço correspondentes às propriedades do dispositivo de borda a ser criado. Os seguintes valores de chave são suportados: id (device_id), deployment (inline json ou caminho para o arquivo), hostname, parent (device_id), edge_agent (URL da imagem) e container_auth (inline json ou caminho para o arquivo). --dispositivo pode ser usado 1 ou mais vezes. Revise exemplos de ajuda para uso completo de parâmetros - esses parâmetros também se referem aos valores correspondentes em nosso arquivo de configuração de exemplo: https://aka.ms/aziotcli-edge-devices-config.

--device-auth --device-auth-type

Mecanismo de autorização de dispositivo para hub.

Propriedade	Valor
Valores aceites:	shared_private_key, x509_thumbprint

--hub-name -n

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

Propriedade	Valor
Parameter group:	IoT Hub Identifier Arguments

--login -l

Este comando suporta uma cadeia de conexão de entidade com direitos para executar a ação. Use para evitar login de 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.

Propriedade	Valor
Parameter group:	IoT Hub Identifier Arguments

--out --output-path

Caminho do diretório para pacotes de configuração do dispositivo de saída. Se esse valor não for especificado, nenhuma saída de arquivo será criada.

--rc --root-cert

Caminho para o certificado de chave pública raiz para assinar certificados de dispositivo de borda aninhados.

Propriedade	Valor
Parameter group:	Root Certificate Arguments

--resource-group -g

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

--rk --root-key

Caminho para a chave privada raiz para assinar certificados de dispositivo de borda aninhados.

Propriedade	Valor
Parameter group:	Root Certificate Arguments

--root-pass --rp

Senha da chave de root.

Propriedade	Valor
Parameter group:	Root Certificate Arguments

--vis --visualize -v

Mostra visualizações de dispositivos e progresso de várias tarefas (criação de dispositivos, configuração de pais, atualização de configurações, etc).

Propriedade	Valor
Default value:	False
Valores aceites:	false, true

--yes -y

Não solicite confirmação quando --clean switch for usado para excluir dispositivos de hub existentes.

Propriedade	Valor
Default value:	False
Valores aceites:	false, true

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

Output format.

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