Condividi tramite

az iot hub digital-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 digital-twin . Altre informazioni sulle estensioni.

Modificare e interagire con il gemello digitale di un dispositivo hub IoT.

Comandi

Nome Descrizione Tipo Status
az iot hub digital-twin invoke-command

Richiamare un comando a livello di radice o componente di un dispositivo gemello digitale.

 Estensione Disponibilità generale
az iot hub digital-twin show

Mostrare il gemello digitale di un dispositivo hub IoT.

 Estensione Disponibilità generale
az iot hub digital-twin update

Aggiornare le proprietà di lettura/scrittura di un dispositivo gemello digitale tramite la specifica della patch JSON.

 Estensione Disponibilità generale

az iot hub digital-twin invoke-command

Richiamare un comando a livello di radice o componente di un dispositivo gemello digitale.

az iot hub digital-twin invoke-command --cn
                                       --device-id
                                       [--component-path]
                                       [--connect-timeout]
                                       [--hub-name]
                                       [--login]
                                       [--payload]
                                       [--resource-group]
                                       [--response-timeout]

Esempio

In generale, richiamare il comando che accetta un payload che include determinate proprietà usando JSON inline.

az iot hub digital-twin invoke-command --command-name {command_name} -n {iothub_name} -d {device_id} --payload '{"property_name": "property_value"}'

Richiamare il comando di livello radice "reboot" che accetta un payload denominato "delay" conforme al modello DTDL https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/samples/TemperatureController.json.

az iot hub digital-twin invoke-command --command-name reboot -n {iothub_name} -d {device_id} --payload 5

Richiamare il comando "getMaxMinReport" nel componente "thermostat1" che non accetta input.

az iot hub digital-twin invoke-command --cn getMaxMinReport -n {iothub_name} -d {device_id} --component-path thermostat1

Parametri necessari

--cn --command-name

Nome del comando di Gemelli digitali.

--device-id -d

ID dispositivo di destinazione.

Parametri facoltativi

--component-path

Percorso del componente gemello digitale. Ad esempio: termostato1.

--connect-timeout --cto

Intervallo di tempo massimo, in secondi, che hub IoT tenterà di connettersi al dispositivo.

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

--payload

Input del payload JSON per il comando. Specificare il percorso del file o il codice JSON inline.

Valore predefinito: {}
--resource-group -g

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

--response-timeout --rto

Intervallo di tempo massimo, in secondi, che il comando del gemello digitale attenderà il risultato.

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 digital-twin show

Mostrare il gemello digitale di un dispositivo hub IoT.

az iot hub digital-twin show --device-id
                             [--hub-name]
                             [--login]
                             [--resource-group]

Esempio

Mostrare il dispositivo di destinazione gemello digitale.

az iot hub digital-twin show -n {iothub_name} -d {device_id}

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

Parametri facoltativi

--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 digital-twin update

Aggiornare le proprietà di lettura/scrittura di un dispositivo gemello digitale tramite la specifica della patch JSON.

Attualmente le operazioni sono limitate all'aggiunta, alla sostituzione e alla rimozione.

az iot hub digital-twin update --device-id
                               --json-patch
                               [--etag]
                               [--hub-name]
                               [--login]
                               [--resource-group]

Esempio

Aggiornare un gemello digitale tramite la specifica della patch JSON.

az iot hub digital-twin update --hub-name {iothub_name} --device-id {device_id} --json-patch '{"op":"add", "path":"/thermostat1/targetTemperature", "value": 54}'

Aggiornare un gemello digitale tramite la specifica della patch JSON.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch '[
  {"op":"remove", "path":"/thermostat1/targetTemperature"},
  {"op":"add", "path":"/thermostat2/targetTemperature", "value": 22}
]'

Aggiornare una proprietà del gemello digitale tramite la specifica della patch JSON definita in un file.

az iot hub digital-twin update -n {iothub_name} -d {device_id} --json-patch ./my/patch/document.json

Parametri necessari

--device-id -d

ID dispositivo di destinazione.

--json-patch --patch

Specifica di aggiornamento descritta da JSON-patch. Le operazioni sono limitate all'aggiunta, alla sostituzione e alla rimozione. Specificare il percorso del file o il codice JSON inline.

Parametri facoltativi

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