az iot edge devices

  • Referência

Observação

Essa referência faz parte da extensão azure-iot para a CLI do Azure (versão 2.46.0 ou superior). A extensão será instalada 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.

 Extensão Habilitação

az iot edge devices create

Habilitação

Esse 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 args 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]
                           [--clean {false, true}]
                           [--dct]
                           [--dea]
                           [--device]
                           [--device-auth {shared_private_key, x509_thumbprint}]
                           [--hub-name]
                           [--login]
                           [--out]
                           [--rc]
                           [--resource-group]
                           [--rk]
                           [--root-pass]
                           [--vis {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 personalizadas - 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 de dispositivo de borda aninhada simples com uma autoridade de certificação raiz existente, usando autenticação x509, e especifique um caminho de saída de pacote de dispositivos 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

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

Valores aceitos: key, login
Valor padrão: key
--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.

Valores aceitos: false, true
Valor padrão: False
--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 especificado individualmente.

--device -d

Pares de 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 (json embutido ou caminho para o arquivo), hostname, parent (device_id), edge_agent (URL da imagem) e container_auth (json embutido 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 a seus 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.

Valores aceitos: shared_private_key, x509_thumbprint
--hub-name -n

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

--login -l

Esse comando oferece suporte a uma cadeia de conexão de entidade com direitos para executar ações. 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.

--out --output-path

Caminho do diretório para pacotes de configuração de 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.

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

--root-pass --rp

Senha da chave de root.

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

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

Não solicite confirmação quando a opção --clean for usada para excluir dispositivos de hub existentes.

Valores aceitos: false, true
Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--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 o detalhamento do log. Use --debug para logs de depuração completos.