Condividi tramite

az iot hub device-twin

  • Riferimento

Nota

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

Gestire la configurazione del dispositivo gemello IoT.

Comandi

Nome Descrizione Tipo Status
az iot hub device-twin list

Elencare i dispositivi gemelli in un hub IoT.

 Estensione Disponibilità generale
az iot hub device-twin replace

Sostituire la definizione del dispositivo gemello con json di destinazione.

 Estensione Disponibilità generale
az iot hub device-twin show

Ottenere una definizione del dispositivo gemello.

 Estensione Disponibilità generale
az iot hub device-twin update

Aggiornare le proprietà e i tag desiderati del dispositivo gemello.

 Estensione Disponibilità generale

az iot hub device-twin list

Elencare i dispositivi gemelli in un hub IoT.

Questo comando equivale alla query dell'hub iot con la query "select * from devices" per tutti i dispositivi e "select * from devices where capabilities.iotEdge = true" per i dispositivi perimetrali.

az iot hub device-twin list [--auth-type {key, login}]
                            [--edge-enabled {false, true}]
                            [--hub-name]
                            [--login]
                            [--resource-group]
                            [--top]

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
--edge-enabled --ee

Flag che indica l'abilitazione dei bordi.

Valori accettati: false, true
Valore predefinito: False
--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.

--resource-group -g

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

--top

Numero massimo di elementi da restituire. Usare -1 per un numero illimitato.

Valore predefinito: 1000
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.

az iot hub device-twin replace

Sostituire la definizione del dispositivo gemello con json di destinazione.

Immettere direttamente json o usare un percorso di file.

az iot hub device-twin replace --device-id
                               --json
                               [--auth-type {key, login}]
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Esempio

Sostituire il dispositivo gemello con il contenuto del file.

az iot hub device-twin replace -d {device_id} -n {iothub_name} -j ../mydevicetwin.json

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

--json -j

Json per sostituire un gemello esistente con . Specificare il percorso del file o il codice JSON non elaborato.

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
--etag -e

Tag Etag o tag di entità corrispondente all'ultimo stato della risorsa. Se non viene specificato alcun etag, viene usato il valore '*'.

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

--resource-group -g

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

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.

az iot hub device-twin show

Ottenere una definizione del dispositivo gemello.

az iot hub device-twin show --device-id
                            [--auth-type {key, login}]
                            [--hub-name]
                            [--login]
                            [--resource-group]

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

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

--resource-group -g

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

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.

az iot hub device-twin update

Aggiornare le proprietà e i tag desiderati del dispositivo gemello.

Specificare gli argomenti --desired o --tags per il comportamento PATCH. Entrambi i parametri supportano json inline o un percorso di file per il contenuto JSON. L'utilizzo degli argomenti di aggiornamento generico (ad esempio --set) rifletterà il comportamento PUT e sarà deprecato.

az iot hub device-twin update --device-id
                              [--add]
                              [--auth-type {key, login}]
                              [--desired]
                              [--etag]
                              [--force-string]
                              [--hub-name]
                              [--login]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--tags]

Esempio

Applicare patch alle proprietà desiderate del dispositivo gemello.

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"conditions":{"temperature":{"warning":70, "critical":100}}}'

Applicare patch ai tag del dispositivo gemello.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags '{"country": "USA"}'

Applicare patch ai tag del dispositivo gemello con il contenuto del file JSON.

az iot hub device-twin update -n {iothub_name} -d {device_id} --tags /path/to/file

Rimozione di patch della proprietà desiderata 'critical' dall'elemento padre 'temperature'

az iot hub device-twin update -n {iothub_name} -d {device_id} --desired '{"condition":{"temperature":{"critical": null}}}'

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

Parametri facoltativi

--add

Aggiungere un oggetto a un elenco di oggetti specificando un percorso e coppie chiave-valore. Esempio: --add property.listProperty <key=value, string or JSON string>.

Valore predefinito: []
--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
--desired

Proprietà desiderate del dispositivo gemello.

--etag -e

Tag Etag o tag di entità corrispondente all'ultimo stato della risorsa. Se non viene specificato alcun etag, viene usato il valore '*'.

--force-string

Quando si usa 'set' o 'add', mantenere i valori letterali stringa anziché tentare di eseguire la conversione in JSON.

Valore predefinito: False
--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.

--remove

Rimuovere una proprietà o un elemento da un elenco. Esempio: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Valore predefinito: []
--resource-group -g

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

--set

Aggiornare un oggetto specificando un percorso di proprietà e un valore da impostare. Esempio: --set property1.property2=<value>.

Valore predefinito: []
--tags

Tag gemelli.

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.