Compartilhar via


az iot edge devices

Note

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

Comandos para gerenciar dispositivos IoT Edge.

Comandos

Nome 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

Habilitação

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

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

Essa operação aceita argumentos de dispositivo embutidos ou um arquivo de configuração de dispositivos de borda no formato YAML ou JSON. Os argumentos de comando embutidos (como '--device-auth') terão precedência e substituirão 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 autoassinado 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 personalizadas – contendo dois dispositivos pai com 1 dispositivo filho cada, usando argumentos embutidos. Também especifica o caminho de saída para pacotes de certificado do 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 de dispositivo de borda aninhada simples com uma AC raiz existente, usando autenticação x509 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

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.

--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 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
--cfg --config --config-file

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

--clean -c

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

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--dct --device-config-template

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

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

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

--device -d

Pares key=value separados por espaço correspondentes às propriedades do dispositivo de borda a ser criado. Há suporte para os seguintes valores de chave: id (device_id), deployment (json embutido ou caminho para arquivo), hostname, parent (device_id), edge_agent (URL da imagem) e container_auth (json embutido ou caminho para arquivo). --device pode ser usado 1 ou mais vezes. Examine 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 aceitos: shared_private_key, x509_thumbprint
--hub-name -n

Nome ou nome do host do Hub IoT. 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 cadeia de conexão de entidade com direitos para executar a ação. Use para evitar o logon da sessão por meio de "az login". Se uma cadeia de conexão de entidade e o nome forem fornecidos, a cadeia de conexão tem prioridade. Obrigatório se --hub-name não for fornecido.

Propriedade Valor
Grupo de parâmetros: IoT Hub Identifier Arguments
--out --output-path

Caminho do diretório para os 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
Grupo de parâmetros: 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
Grupo de parâmetros: Root Certificate Arguments
--root-pass --rp

Senha da chave raiz.

Propriedade Valor
Grupo de parâmetros: Root Certificate Arguments
--vis --visualize -v

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

Propriedade Valor
Valor padrão: False
Valores aceitos: false, true
--yes -y

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

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