az iot edge devices

Nota

Questo riferimento fa parte dell'estensione azure-iot per l'interfaccia della riga di comando di Azure (versione 2.37.0 o successiva). L'estensione installerà automaticamente la prima volta che si esegue un comando az iot edge devices . Altre informazioni sulle estensioni.

Comandi per gestire i dispositivi IoT Edge.

Comandi

Nome	Descrizione	Tipo	Stato
az iot edge devices create	Creare e configurare più dispositivi perimetrali in un hub IoT.	Estensione	Sperimentale

az iot edge devices create

Sperimentale

Questo comando è sperimentale e in fase di sviluppo. Livelli di riferimento e supporto: https://aka.ms/CLI_refstatus

Creare e configurare più dispositivi perimetrali in un hub IoT.

Questa operazione accetta argomenti di dispositivo inline o un file di configurazione dei dispositivi perimetrali in formato YAML o JSON. Gli argomenti dei comandi inline (ad esempio '--device-auth') avranno la precedenza ed eseguiranno l'override delle proprietà del file di configurazione, se disponibili. Un file di configurazione di esempio è disponibile qui: https://aka.ms/aziotcli-edge-devices-config Esaminare esempi e descrizioni dei parametri per informazioni dettagliate su come usare completamente questa operazione.

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}]

Esempio

Creare un paio di dispositivi perimetrali usando l'autenticazione con chiave simmetrica (impostazione predefinita)

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

Creare un elenco semplice di dispositivi perimetrali usando l'autenticazione con certificato autofirmato con varie configurazioni delle proprietà edge, usando argomenti inline.

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}

Eliminare tutte le identità dei dispositivi esistenti in un hub e creare nuovi dispositivi in base a un file di configurazione (con barre di stato e output di visualizzazione).

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

Creare un gruppo di dispositivi perimetrali annidati con distribuzioni di moduli personalizzati, contenenti 2 dispositivi padre con 1 dispositivo figlio, usando argomenti inline. Specifica anche il percorso di output per i bundle di certificati del 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

Creare una semplice configurazione del dispositivo perimetrale annidata con una CA radice esistente, usando l'autenticazione x509 e specificare un percorso di output del bundle del dispositivo personalizzato.

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

Parametri facoltativi

--auth-type

Indica se l'operazione deve derivare automaticamente una chiave di criteri o usare la sessione di Azure AD corrente. Se il tipo di autenticazione è login e viene specificato il nome host della risorsa, la ricerca della risorsa verrà ignorata a meno che non sia necessario. È possibile configurare l'impostazione predefinita usando az configure --defaults iothub-data-auth-type=<auth-type-value>.

valori accettati: key, login

valore predefinito: key

--cfg --config --config-file

Percorso del file di configurazione dei dispositivi. File di configurazione di esempio: https://aka.ms/aziotcli-edge-devices-config.

--clean -c

Elimina tutti i dispositivi nell'hub di destinazione prima di creare nuovi dispositivi.

valori accettati: false, true

valore predefinito: False

--dct --device-config-template

Percorso del file config.toml di IoT Edge da usare come base per le configurazioni dei dispositivi perimetrali.

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

Agente perimetrale predefinito per i dispositivi Edge creati se non specificato singolarmente.

--device -d

Coppie chiave=valore separate da spazi corrispondenti alle proprietà del dispositivo perimetrale da creare. Sono supportati i valori di chiave seguenti: id (device_id), deployment (json inline o percorso del file), hostname, parent (device_id), edge_agent (URL immagine) e container_auth (json inline o percorso del file). --device può essere usato 1 o più volte. Esaminare gli esempi della Guida per l'utilizzo completo dei parametri. Questi parametri fanno riferimento anche ai valori corrispondenti nel file di configurazione di esempio: https://aka.ms/aziotcli-edge-devices-config.

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

Meccanismo di autorizzazione da dispositivo a hub.

valori accettati: shared_private_key, x509_thumbprint

--hub-name -n

hub IoT nome o nome host. Obbligatorio se non viene specificato --login.

--login -l

Questo comando supporta un'entità stringa di connessione con diritti per eseguire l'azione. Usare per evitare l'accesso di sessione tramite "az login". Se vengono forniti sia un stringa di connessione di entità che un nome, il stringa di connessione ha priorità. Obbligatorio se --hub-name non è specificato.

--out --output-path

Percorso della directory per i bundle di configurazione del dispositivo di output. Se questo valore non viene specificato, non verrà creato alcun output di file.

--rc --root-cert

Percorso del certificato della chiave pubblica radice per firmare certificati del dispositivo perimetrale annidati.

--resource-group -g

Nome del gruppo di risorse. È possibile configurare il gruppo predefinito con az configure --defaults group=<name>.

--rk --root-key

Percorso della chiave privata radice per firmare certificati del dispositivo perimetrale annidati.

--root-pass --rp

Password della chiave radice.

--vis --visualize -v

Mostra le visualizzazioni dei dispositivi e lo stato di avanzamento di varie attività (creazione del dispositivo, impostazione padre, aggiornamento delle configurazioni e così via).

valori accettati: false, true

valore predefinito: False

--yes -y

Non richiedere conferma quando si usa l'opzione --clean per eliminare i dispositivi hub esistenti.

valori accettati: false, true

valore predefinito: False

Parametri globali

--debug

Aumenta il livello di dettaglio della registrazione per mostrare tutti i log di debug.

--help -h

Visualizza questo messaggio della guida ed esce.

--only-show-errors

Mostra solo gli errori, eliminando gli avvisi.

--output -o

Formato di output.

valori accettati: json, jsonc, none, table, tsv, yaml, yamlc

valore predefinito: json

--query

Stringa di query JMESPath. Per altre informazioni ed esempi, vedere http://jmespath.org/.

--subscription

Nome o ID della sottoscrizione. È possibile configurare la sottoscrizione predefinita usando az account set -s NAME_OR_ID.

--verbose

Aumenta il livello di dettaglio della registrazione. Usare --debug per log di debug completi.