az iot edge deployment

  • 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 edge deployment . Altre informazioni sulle estensioni.

Gestire le distribuzioni di IoT Edge su larga scala.

Comandi

Nome Descrizione Tipo Status
az iot edge deployment create

Creare una distribuzione IoT Edge in un hub IoT di destinazione.

 Estensione Disponibilità generale
az iot edge deployment delete

Eliminare una distribuzione di IoT Edge.

 Estensione Disponibilità generale
az iot edge deployment list

Elencare le distribuzioni di IoT Edge in un hub IoT.

 Estensione Disponibilità generale
az iot edge deployment show

Ottenere i dettagli di una distribuzione di IoT Edge.

 Estensione Disponibilità generale
az iot edge deployment show-metric

Valutare una metrica di sistema di destinazione definita in una distribuzione IoT Edge.

 Estensione Disponibilità generale
az iot edge deployment update

Aggiornare le proprietà specificate di una distribuzione di IoT Edge.

 Estensione Disponibilità generale

az iot edge deployment create

Creare una distribuzione IoT Edge in un hub IoT di destinazione.

Il contenuto della distribuzione è json e sotto forma di {"modulesContent":{...}} o {"content":{"modulesContent":{...}}}.

Per impostazione predefinita, le proprietà dei moduli di sistema $edgeAgent e $edgeHub vengono convalidate in base agli schemi installati con l'estensione IoT. Questa convalida è destinata alle distribuzioni di base. Se lo schema corrispondente non è disponibile o il formato di distribuzione di base non viene rilevato, questo passaggio verrà ignorato. La convalida dello schema può essere disabilitata tramite l'opzione --no-validation.

Una distribuzione perimetrale viene classificata come a più livelli se un modulo ha proprietà.desired.* definite. Per qualsiasi dispositivo perimetrale di destinazione di una distribuzione a più livelli, è necessaria prima di tutto una distribuzione di base applicata.

Tutte le distribuzioni a più livelli destinate a un dispositivo devono avere una priorità più alta rispetto alla distribuzione di base per tale dispositivo.

Nota: se il campo properties.desired di un modulo gemello è impostato in una distribuzione a più livelli, properties.desired sovrascriverà le proprietà desiderate per tale modulo in qualsiasi distribuzione con priorità inferiore.

az iot edge deployment create --content
                              --deployment-id
                              [--auth-type {key, login}]
                              [--cl]
                              [--cmq]
                              [--hub-name]
                              [--lab]
                              [--layered {false, true}]
                              [--login]
                              [--metrics]
                              [--no-validation {false, true}]
                              [--pri]
                              [--resource-group]
                              [--target-condition]

Esempio

Creare una distribuzione con etichette (esempio di sintassi bash) che si applica per i dispositivi nella "compilazione 9" e l'ambiente è "test".

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels '{"key0":"value0", "key1":"value1"}' --target-condition "tags.building=9 and tags.environment='test'" --priority 3

Creare una distribuzione con etichette (esempio di sintassi di PowerShell) che si applica per i dispositivi contrassegnati con l'ambiente "dev".

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --labels "{'key':'value'}" --target-condition "tags.environment='dev'"

Creare una distribuzione a più livelli che si applica per i dispositivi contrassegnati con l'ambiente "dev". Sia le metriche utente che il contenuto dei moduli definiti inline (esempio di sintassi di PowerShell). Si noti che questo è in formato di distribuzione a più livelli come proprietà.desired.* è stato definito.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content "{'modulesContent':{'`$edgeAgent':{
  'properties.desired.modules.mymodule0':{ }},'`$edgeHub':{'properties.desired.routes.myroute0':'FROM /messages/* INTO `$upstream'}}}"
--target-condition "tags.environment='dev'" --priority 10 --metrics "{'queries':{'mymetrik':'SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200'}}"

Creare una distribuzione a più livelli che si applica per i dispositivi nella "compilazione 9" e nell'ambiente "test". Sia le metriche utente che il contenuto dei moduli definiti inline (esempio di sintassi bash). Si noti che questo è in formato di distribuzione a più livelli come proprietà.desired.* è stato definito.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content '{"modulesContent":{"$edgeAgent":{"properties.desired.modules.mymodule0":{ }},"$edgeHub":{"properties.desired.routes.myroute0":"FROM /messages/* INTO $upstream"}}}' --target-condition "tags.building=9 and tags.environment='test'" --metrics '{"queries":{"mymetrik":"SELECT deviceId from devices where properties.reported.lastDesiredStatus.code = 200"}}'

Creare una distribuzione valida per i dispositivi in 'building 9' e environment 'test'. Sia le metriche utente che il contenuto dei moduli definiti dal file.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --metrics ./metrics_content.json

Creare una distribuzione la cui definizione proviene dal file con input indipendente dalla shell di etichette e metriche.

az iot edge deployment create -d {deployment_name} -n {iothub_name} --content ./modules_content.json --target-condition "tags.building=9 and tags.environment='test'" --custom-labels key0=value0 key1=value1 --custom-metric-queries mymetric1="select deviceId from devices where tags.location='US'" mymetric2="select *"

Parametri necessari

--content -k

Contenuto della distribuzione di IoT Edge. Specificare il percorso del file o il codice JSON non elaborato.

--deployment-id -d

Nome della distribuzione 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
--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 distribuzione di destinazione. Usare il formato seguente: '{"key0":"value0", "key1":"value1"}'. È consigliabile usare --custom-labels anziché --labels.

--layered

Le distribuzioni a più livelli consentono di definire le proprietà desiderate in $edgeAgent, $edgeHub e moduli utente che verranno sovrapposti a una distribuzione di base. Le proprietà specificate in una distribuzione a più livelli verranno unite con le proprietà della distribuzione di base. Le proprietà con lo stesso percorso verranno sovrascritte in base alla priorità di distribuzione. Questa opzione è un alias per --no-validation.

Valori accettati: false, true
Valore predefinito: False
--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 utente della distribuzione di IoT Edge. Specificare il percorso del file o il codice JSON non elaborato. Le metriche utente sono sotto forma di {"query":{...}} o {"metrics":{"querys":{...}}}. È consigliabile usare --custom-metric-queries anziché --metrics.

--no-validation

Disabilita la convalida dello schema lato client per la creazione della distribuzione perimetrale.

Valori accettati: false, true
Valore predefinito: False
--pri --priority

Peso della distribuzione 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 distribuzione perimetrale. Le distribuzioni senza condizione di destinazione non saranno destinate a alcun dispositivo. 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 edge deployment delete

Eliminare una distribuzione di IoT Edge.

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

Parametri necessari

--deployment-id -d

Nome della distribuzione 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 edge deployment list

Elencare le distribuzioni di IoT Edge in un hub IoT.

az iot edge deployment 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 distribuzioni da restituire. Per impostazione predefinita, vengono restituite tutte le distribuzioni.

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 edge deployment show

Ottenere i dettagli di una distribuzione di IoT Edge.

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

Parametri necessari

--deployment-id -d

Nome della distribuzione 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 edge deployment show-metric

Valutare una metrica di sistema di destinazione definita in una distribuzione IoT Edge.

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

Esempio

Valutare la metrica di sistema 'appliedCount'

az iot edge deployment show-metric -m appliedCount -d {deployment_name} -n {iothub_name} --mt system

Valutare la metrica utente "myCustomMetric"

az iot edge deployment show-metric -m myCustomMetric -d {deployment_name} -n {iothub_name}

Parametri necessari

--deployment-id -d

Nome della distribuzione 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 edge deployment update

Aggiornare le proprietà specificate di una distribuzione di IoT Edge.

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

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

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

Esempio

Modificare le etichette e la condizione di destinazione di una distribuzione perimetrale esistente

az iot edge deployment update -d {deployment_name} -n {iothub_name} --set labels='{"purpose":"dev", "owners":"IoTEngineering"}' targetCondition='tags.building=9'

Parametri necessari

--deployment-id -d

Nome della distribuzione 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.