az iot hub configuration

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 hub configuration . Altre informazioni sulle estensioni.

Gestione della configurazione della gestione automatica dei dispositivi IoT su larga scala.

Comandi

Nome	Descrizione	Tipo	Stato
az iot hub configuration create	Creare una configurazione di gestione automatica dei dispositivi IoT in un hub IoT di destinazione.	Estensione	Disponibilità generale
az iot hub configuration delete	Eliminare una configurazione del dispositivo IoT.	Estensione	Disponibilità generale
az iot hub configuration list	Elencare le configurazioni di gestione automatica dei dispositivi IoT in un hub IoT.	Estensione	Disponibilità generale
az iot hub configuration show	Ottenere i dettagli di una configurazione di gestione automatica dei dispositivi IoT.	Estensione	Disponibilità generale
az iot hub configuration show-metric	Valutare un utente o una metrica di sistema di destinazione definita in una configurazione del dispositivo IoT.	Estensione	Disponibilità generale
az iot hub configuration update	Aggiornare le proprietà specificate di una configurazione di gestione automatica dei dispositivi IoT.	Estensione	Disponibilità generale

az iot hub configuration create

Creare una configurazione di gestione automatica dei dispositivi IoT in un hub IoT di destinazione.

Il contenuto della configurazione è json e leggermente varia in base alla finalità del dispositivo o del modulo.

Le configurazioni dei dispositivi sono sotto forma di {"deviceContent":{...}} o {"content":{"deviceContent":{...}}}

Le configurazioni dei moduli sono sotto forma di {"moduleContent":{...}} o {"content":{"moduleContent":{...}}}

Le configurazioni possono essere definite con le metriche fornite dall'utente per la valutazione su richiesta. Le metriche utente sono json e sotto forma di {"query":{...}} o {"metrics":{"querys":{...}}}.

Nota: la condizione di destinazione per i moduli deve iniziare con "from devices.modules where".

az iot hub configuration create --config-id
                                --content
                                [--auth-type {key, login}]
                                [--cl]
                                [--cmq]
                                [--hub-name]
                                [--lab]
                                [--login]
                                [--metrics]
                                [--pri]
                                [--resource-group]
                                [--target-condition]

Esempio

Creare una configurazione del dispositivo con priorità 3 che si applica in condizioni quando un dispositivo viene contrassegnato nella compilazione 9 e l'ambiente è "test".

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Creare una configurazione del dispositivo con etichette e fornire metriche utente inline (esempio di sintassi bash).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "tags.building=9" --labels '{"key0":"value0", "key1":"value1"}' --priority 10 --metrics '{"metrics": {"queries": {"mymetric": "select deviceId from devices where tags.location='US'"}}}'

Creare una configurazione del modulo con etichette e fornire metriche utente inline (esempio di sintassi cmd)

az iot hub configuration create -c {config_name} -n {iothub_name} --content module_content.json --target-condition "from devices.modules where tags.building=9" --labels "{\"key0\":\"value0\", \"key1\":\"value1\"}" --metrics "{\"metrics\": {\"queries\": {\"mymetric\": \"select moduleId from devices.modules where tags.location='US'\"}}}"

Creare una configurazione del modulo con contenuto e metriche utente inline (esempio di sintassi di PowerShell).

az iot hub configuration create -c {config_name} -n {iothub_name} --content '{\"moduleContent\": {\"properties.desired.chillerWaterSettings\": {\"temperature\": 38, \"pressure\": 78}}}' --target-condition "from devices.modules where tags.building=9" --priority 1 --metrics '{\"metrics\": {\"queries\": {\"mymetric\":\"select moduleId from devices.modules where tags.location=''US''\"}}}'

Creare una configurazione del dispositivo con uno stile di input alternativo di etichette e metriche (indipendente dalla shell).

az iot hub configuration create -c {config_name} -n {iothub_name} --content device_content.json --target-condition "from devices.modules where tags.building=9" --custom-labels key0="value0" key1="value1" --priority 10 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Parametri necessari

--config-id -c

Nome della configurazione del dispositivo di destinazione. Sono consentiti caratteri minuscoli e i caratteri speciali seguenti: [-+%_*!'].

--content -k

Contenuto della configurazione del dispositivo. 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

--cl --custom-labels

Stile di input alternativo (coppie chiave=valore separate da spazio) per --labels e destinato a sostituirlo in futuro. Esempio di formato: key1=value1 key2="this is my value".

--cmq --custom-metric-queries

Stile di input alternativo (coppie chiave=valore separate da spazio) per --metrics e destinato a sostituirlo in futuro. Esempio di formato: metric1="select deviceId dai dispositivi in cui tags.location='US'" metric2="select *".

--hub-name -n

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

--lab --labels

Mappa delle etichette da applicare alla configurazione di destinazione. È consigliabile usare --custom-labels anziché --labels. Esempio di formato: {"key0":"value0", "key1":"value1"}.

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

--metrics -m

Definizioni delle metriche di configurazione del dispositivo. Specificare il percorso del file o il codice JSON non elaborato. È consigliabile usare --custom-metric-queries anziché --metrics.

--pri --priority

Peso della configurazione del dispositivo in caso di regole concorrenti (vittoria più alta).

valore predefinito: 0

--resource-group -g

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

--target-condition --tc -t

Condizione di destinazione a cui si applica una configurazione del dispositivo o del modulo. Le configurazioni senza condizione di destinazione non saranno destinate a alcun dispositivo o modulo. Usare il formato seguente: "tags.environment='test'".

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 configuration delete

Eliminare una configurazione del dispositivo IoT.

az iot hub configuration delete --config-id
                                [--auth-type {key, login}]
                                [--etag]
                                [--hub-name]
                                [--login]
                                [--resource-group]

Parametri necessari

--config-id -c

Nome della configurazione del dispositivo di destinazione. Sono consentiti caratteri minuscoli e i caratteri speciali seguenti: [-+%_*!'].

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 configuration list

Elencare le configurazioni di gestione automatica dei dispositivi IoT in un hub IoT.

az iot hub configuration list [--auth-type {key, login}]
                              [--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

--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 configurazioni da restituire. Per impostazione predefinita, vengono restituite tutte le configurazioni.

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 configuration show

Ottenere i dettagli di una configurazione di gestione automatica dei dispositivi IoT.

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

Parametri necessari

--config-id -c

Nome della configurazione del dispositivo di destinazione. Sono consentiti caratteri minuscoli e i caratteri speciali seguenti: [-+%_*!'].

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 configuration show-metric

Valutare un utente o una metrica di sistema di destinazione definita in una configurazione del dispositivo IoT.

az iot hub configuration show-metric --config-id
                                     --metric-id
                                     [--auth-type {key, login}]
                                     [--hub-name]
                                     [--login]
                                     [--metric-type {system, user}]
                                     [--resource-group]

Esempio

Valutare la metrica 'warningLimit' definita dall'utente

az iot hub configuration show-metric -m warningLimit -c {configuration_name} -n {iothub_name}

Valutare la metrica "appliedCount" del sistema

az iot hub configuration show-metric --metric-id appliedCount -c {configuration_name} -n {iothub_name} --metric-type system

Parametri necessari

--config-id -c

Nome della configurazione del dispositivo di destinazione. Sono consentiti caratteri minuscoli e i caratteri speciali seguenti: [-+%_*!'].

--metric-id -m

Metrica di destinazione per la valutazione.

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.

--metric-type --mt

Indica la raccolta di metriche da usare per cercare una metrica.

valori accettati: system, user

valore predefinito: user

--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 configuration update

Aggiornare le proprietà specificate di una configurazione di gestione automatica dei dispositivi IoT.

Usare --set seguito dalle assegnazioni di proprietà per l'aggiornamento di una configurazione.

Nota: il contenuto della configurazione non è modificabile. Le proprietà di configurazione che possono essere aggiornate sono "labels", "metrics", "priority" e "targetCondition".

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

Esempio

Modificare la priorità di una configurazione del dispositivo e aggiornarne la condizione di destinazione

az iot hub configuration update -c {configuration_name} -n {iothub_name} --set priority=10 targetCondition="tags.building=43 and tags.environment='dev'"

Parametri necessari

--config-id -c

Nome della configurazione del dispositivo di destinazione. Sono consentiti caratteri minuscoli e i caratteri speciali seguenti: [-+%_*!'].

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

--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: []

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.