Condividi tramite

az iot du device 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 du device deployment . Altre informazioni sulle estensioni.

Gestione della distribuzione dei dispositivi.

Le distribuzioni applicheranno un aggiornamento compatibile desiderato a un gruppo di dispositivi di destinazione che distribuisce l'aggiornamento tra le classi di dispositivi all'interno del gruppo. I criteri di rollback avviati dal cloud possono essere configurati facoltativamente.

Comandi

Nome Descrizione Tipo Status
az iot du device deployment cancel

Annullare la distribuzione di un sottogruppo di classi di dispositivi.

 Estensione Disponibilità generale
az iot du device deployment create

Creare una distribuzione per un gruppo di dispositivi. La distribuzione verrà eseguita su più cast su ogni sottogruppo di classi di dispositivi all'interno del gruppo di destinazione.

 Estensione Disponibilità generale
az iot du device deployment delete

Eliminare una distribuzione in base al gruppo di dispositivi o al sottogruppo di classi di dispositivi.

 Estensione Disponibilità generale
az iot du device deployment list

Elencare le distribuzioni per un gruppo di dispositivi o un sottogruppo di classi di dispositivi.

 Estensione Disponibilità generale
az iot du device deployment list-devices

Elencare i dispositivi in una distribuzione di sottogruppo di classi di dispositivi insieme al relativo stato. Utile per ottenere un elenco di dispositivi non riusciti.

 Estensione Disponibilità generale
az iot du device deployment retry

Ripetere la distribuzione di un sottogruppo di classi di dispositivi.

 Estensione Disponibilità generale
az iot du device deployment show

Mostra una distribuzione per un gruppo di dispositivi o un sottogruppo di classi di dispositivi, incluso lo stato che descrive in dettaglio il numero di dispositivi nella distribuzione in corso, completati o non riusciti.

 Estensione Disponibilità generale

az iot du device deployment cancel

Annullare la distribuzione di un sottogruppo di classi di dispositivi.

az iot du device deployment cancel --account
                                   --cid
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--resource-group]

Esempio

Annullare la distribuzione del sottogruppo della classe di dispositivi di destinazione.

az iot du device deployment cancel -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

Parametri necessari

--account -n

Nome dell'account di Aggiornamento dispositivi. È possibile configurare il nome dell'account predefinito usando az config set defaults.adu_account=<name>.

--cid --class-id

ID classe dispositivo. Questo viene generato dall'ID modello e dalle proprietà di compatibilità segnalate dall'agente di aggiornamento del dispositivo nell'interfaccia PnP di Aggiornamento dispositivi in hub IoT. Si tratta di un hash SHA1 con codifica esadecimale.

--deployment-id --did

ID distribuzione fornito dal chiamante. Non può contenere più di 73 caratteri, deve essere tutto in minuscolo e non può contenere '&', '^', '[', ']', '{', '}', '|', '', '<', '>', barra, barra rovesciata o virgolette doppie.

--gid --group-id

ID gruppo di dispositivi. Questo viene creato dal valore del tag ADUGroup nel dispositivo gemello del modulo o del modulo gemello di hub IoT connesso o $default per i dispositivi senza tag.

--instance -i

Nome dell'istanza di Aggiornamento dispositivi. È possibile configurare il nome predefinito dell'istanza usando az config set defaults.adu_instance=<name>.

Parametri facoltativi

--resource-group -g

Nome del gruppo di risorse dell'account di Aggiornamento dispositivi. È possibile configurare il gruppo predefinito con az config set defaults.adu_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 du device deployment create

Creare una distribuzione per un gruppo di dispositivi. La distribuzione verrà eseguita su più cast su ogni sottogruppo di classi di dispositivi all'interno del gruppo di destinazione.

az iot du device deployment create --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   --un
                                   --up
                                   --update-version
                                   [--failed-count]
                                   [--failed-percentage]
                                   [--rbun]
                                   [--rbup]
                                   [--rbuv]
                                   [--resource-group]
                                   [--start-time]

Esempio

Creare una distribuzione del gruppo di dispositivi pianificata per l'avvio immediato (rispetto all'ora UTC).

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version}

Creare una distribuzione del gruppo di dispositivi pianificata per l'avvio in base a un valore datetime conforme a iso-8601 desiderato.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --start-time "2022-12-20T01:00:00"

Creare una distribuzione del gruppo di dispositivi pianificata per iniziare immediatamente con un criterio di rollback definito avviato dal cloud. Il rollback del cloud viene avviato quando vengono soddisfatte le destinazioni di percentuale non riuscite o non riuscite.

az iot du device deployment create -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --update-name {update_name} --update-provider {update_provider} --update-version {update_version} --failed-count 10 --failed-percentage 5 --rollback-update-name {rollback_update_name} --rollback-update-provider {rollback_update_provider} --rollback-update-version {rollback_update_version}

Parametri necessari

--account -n

Nome dell'account di Aggiornamento dispositivi. È possibile configurare il nome dell'account predefinito usando az config set defaults.adu_account=<name>.

--deployment-id --did

ID distribuzione fornito dal chiamante. Non può contenere più di 73 caratteri, deve essere tutto in minuscolo e non può contenere '&', '^', '[', ']', '{', '}', '|', '', '<', '>', barra, barra rovesciata o virgolette doppie.

--gid --group-id

ID gruppo di dispositivi. Questo viene creato dal valore del tag ADUGroup nel dispositivo gemello del modulo o del modulo gemello di hub IoT connesso o $default per i dispositivi senza tag.

--instance -i

Nome dell'istanza di Aggiornamento dispositivi. È possibile configurare il nome predefinito dell'istanza usando az config set defaults.adu_instance=<name>.

--un --update-name

Nome dell'aggiornamento.

--up --update-provider

Provider di aggiornamento.

--update-version --uv

Versione di aggiornamento.

Parametri facoltativi

--failed-count --fc

Numero intero che rappresenta il numero di dispositivi non riusciti in una distribuzione prima che si verifichi un rollback initato nel cloud. Obbligatorio quando si definiscono i criteri di rollback.

--failed-percentage --fp

Numero intero che rappresenta la percentuale di dispositivi non riusciti in una distribuzione prima che si verifichi un rollback initato nel cloud. Obbligatorio quando si definiscono i criteri di rollback.

--rbun --rollback-update-name

Nome dell'aggiornamento del rollback.

--rbup --rollback-update-provider

Provider di aggiornamento del rollback.

--rbuv --rollback-update-version

Versione dell'aggiornamento del rollback.

--resource-group -g

Nome del gruppo di risorse dell'account di Aggiornamento dispositivi. È possibile configurare il gruppo predefinito con az config set defaults.adu_group=<name>.

--start-time

Ora di inizio conforme a iso-8601 per la distribuzione. Se non viene specificato alcun valore, verrà usato il valore corrispondente per utc 'now'.

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 du device deployment delete

Eliminare una distribuzione in base al gruppo di dispositivi o al sottogruppo di classi di dispositivi.

az iot du device deployment delete --account
                                   --deployment-id
                                   --gid
                                   --instance
                                   [--cid]
                                   [--resource-group]
                                   [--yes {false, true}]

Esempio

Eliminare la distribuzione del gruppo di dispositivi di destinazione.

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id}

Eliminare la distribuzione del sottogruppo della classe di dispositivi di destinazione.

az iot du device deployment delete -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

Parametri necessari

--account -n

Nome dell'account di Aggiornamento dispositivi. È possibile configurare il nome dell'account predefinito usando az config set defaults.adu_account=<name>.

--deployment-id --did

ID distribuzione fornito dal chiamante. Non può contenere più di 73 caratteri, deve essere tutto in minuscolo e non può contenere '&', '^', '[', ']', '{', '}', '|', '', '<', '>', barra, barra rovesciata o virgolette doppie.

--gid --group-id

ID gruppo di dispositivi. Questo viene creato dal valore del tag ADUGroup nel dispositivo gemello del modulo o del modulo gemello di hub IoT connesso o $default per i dispositivi senza tag.

--instance -i

Nome dell'istanza di Aggiornamento dispositivi. È possibile configurare il nome predefinito dell'istanza usando az config set defaults.adu_instance=<name>.

Parametri facoltativi

--cid --class-id

ID classe dispositivo. Questo viene generato dall'ID modello e dalle proprietà di compatibilità segnalate dall'agente di aggiornamento del dispositivo nell'interfaccia PnP di Aggiornamento dispositivi in hub IoT. Si tratta di un hash SHA1 con codifica esadecimale.

--resource-group -g

Nome del gruppo di risorse dell'account di Aggiornamento dispositivi. È possibile configurare il gruppo predefinito con az config set defaults.adu_group=<name>.

--yes -y

Ignorare le richieste dell'utente. Indica l'accettazione dell'azione. Usato principalmente per gli scenari di automazione. Valore predefinito: false.

Valori accettati: false, true
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 du device deployment list

Elencare le distribuzioni per un gruppo di dispositivi o un sottogruppo di classi di dispositivi.

az iot du device deployment list --account
                                 --gid
                                 --instance
                                 [--cid]
                                 [--order-by]
                                 [--resource-group]

Esempio

Elencare le distribuzioni per un gruppo di dispositivi.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id}

Elencare le distribuzioni per un gruppo di dispositivi ordinando i risultati in base a startDateTime decrescente.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --order-by "startDateTime desc"

Elencare le distribuzioni per un sottogruppo di classi di dispositivi.

az iot du device deployment list -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id}

Parametri necessari

--account -n

Nome dell'account di Aggiornamento dispositivi. È possibile configurare il nome dell'account predefinito usando az config set defaults.adu_account=<name>.

--gid --group-id

ID gruppo di dispositivi. Questo viene creato dal valore del tag ADUGroup nel dispositivo gemello del modulo o del modulo gemello di hub IoT connesso o $default per i dispositivi senza tag.

--instance -i

Nome dell'istanza di Aggiornamento dispositivi. È possibile configurare il nome predefinito dell'istanza usando az config set defaults.adu_instance=<name>.

Parametri facoltativi

--cid --class-id

ID classe dispositivo. Questo viene generato dall'ID modello e dalle proprietà di compatibilità segnalate dall'agente di aggiornamento del dispositivo nell'interfaccia PnP di Aggiornamento dispositivi in hub IoT. Si tratta di un hash SHA1 con codifica esadecimale.

--order-by

Ordina il set di distribuzioni restituite. È possibile ordinare per startDateTime [desc/asc].

--resource-group -g

Nome del gruppo di risorse dell'account di Aggiornamento dispositivi. È possibile configurare il gruppo predefinito con az config set defaults.adu_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 du device deployment list-devices

Elencare i dispositivi in una distribuzione di sottogruppo di classi di dispositivi insieme al relativo stato. Utile per ottenere un elenco di dispositivi non riusciti.

az iot du device deployment list-devices --account
                                         --cid
                                         --deployment-id
                                         --gid
                                         --instance
                                         [--filter]
                                         [--resource-group]

Esempio

Elencare i dispositivi in una distribuzione di sottogruppi di classi di dispositivi.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Elencare i dispositivi in un filtro di distribuzione di sottogruppi della classe di dispositivo in base a deviceId e deviceState.

az iot du device deployment list-devices -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --filter "deviceId eq 'd0' and deviceState eq 'InProgress'"

Parametri necessari

--account -n

Nome dell'account di Aggiornamento dispositivi. È possibile configurare il nome dell'account predefinito usando az config set defaults.adu_account=<name>.

--cid --class-id

ID classe dispositivo. Questo viene generato dall'ID modello e dalle proprietà di compatibilità segnalate dall'agente di aggiornamento del dispositivo nell'interfaccia PnP di Aggiornamento dispositivi in hub IoT. Si tratta di un hash SHA1 con codifica esadecimale.

--deployment-id --did

ID distribuzione fornito dal chiamante. Non può contenere più di 73 caratteri, deve essere tutto in minuscolo e non può contenere '&', '^', '[', ']', '{', '}', '|', '', '<', '>', barra, barra rovesciata o virgolette doppie.

--gid --group-id

ID gruppo di dispositivi. Questo viene creato dal valore del tag ADUGroup nel dispositivo gemello del modulo o del modulo gemello di hub IoT connesso o $default per i dispositivi senza tag.

--instance -i

Nome dell'istanza di Aggiornamento dispositivi. È possibile configurare il nome predefinito dell'istanza usando az config set defaults.adu_instance=<name>.

Parametri facoltativi

--filter

Limita il set di stati del dispositivo di distribuzione restituiti. È possibile filtrare in base a deviceId e moduleId e/o deviceState.

--resource-group -g

Nome del gruppo di risorse dell'account di Aggiornamento dispositivi. È possibile configurare il gruppo predefinito con az config set defaults.adu_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 du device deployment retry

Ripetere la distribuzione di un sottogruppo di classi di dispositivi.

az iot du device deployment retry --account
                                  --cid
                                  --deployment-id
                                  --gid
                                  --instance
                                  [--resource-group]

Esempio

Ripetere la distribuzione del sottogruppo della classe di dispositivi di destinazione.

az iot du device deployment retry -n {account_name} -i {instance_name} --deployment-id {deployment_id} --group-id {device_group_id} --class-id {device_class_id}

Parametri necessari

--account -n

Nome dell'account di Aggiornamento dispositivi. È possibile configurare il nome dell'account predefinito usando az config set defaults.adu_account=<name>.

--cid --class-id

ID classe dispositivo. Questo viene generato dall'ID modello e dalle proprietà di compatibilità segnalate dall'agente di aggiornamento del dispositivo nell'interfaccia PnP di Aggiornamento dispositivi in hub IoT. Si tratta di un hash SHA1 con codifica esadecimale.

--deployment-id --did

ID distribuzione fornito dal chiamante. Non può contenere più di 73 caratteri, deve essere tutto in minuscolo e non può contenere '&', '^', '[', ']', '{', '}', '|', '', '<', '>', barra, barra rovesciata o virgolette doppie.

--gid --group-id

ID gruppo di dispositivi. Questo viene creato dal valore del tag ADUGroup nel dispositivo gemello del modulo o del modulo gemello di hub IoT connesso o $default per i dispositivi senza tag.

--instance -i

Nome dell'istanza di Aggiornamento dispositivi. È possibile configurare il nome predefinito dell'istanza usando az config set defaults.adu_instance=<name>.

Parametri facoltativi

--resource-group -g

Nome del gruppo di risorse dell'account di Aggiornamento dispositivi. È possibile configurare il gruppo predefinito con az config set defaults.adu_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 du device deployment show

Mostra una distribuzione per un gruppo di dispositivi o un sottogruppo di classi di dispositivi, incluso lo stato che descrive in dettaglio il numero di dispositivi nella distribuzione in corso, completati o non riusciti.

az iot du device deployment show --account
                                 --deployment-id
                                 --gid
                                 --instance
                                 [--cid]
                                 [--resource-group]
                                 [--status {false, true}]

Esempio

Visualizzare una distribuzione per un gruppo di dispositivi.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id}

Visualizzare lo stato di una distribuzione di un gruppo di dispositivi.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --deployment-id {deployment_id} --status

Visualizzare una distribuzione per un sottogruppo di classi di dispositivi.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id}

Visualizzare lo stato della distribuzione di un sottogruppo di classi di dispositivi.

az iot du device deployment show -n {account_name} -i {instance_name} --group-id {device_group_id} --class-id {device_class_id} --deployment-id {deployment_id} --status

Parametri necessari

--account -n

Nome dell'account di Aggiornamento dispositivi. È possibile configurare il nome dell'account predefinito usando az config set defaults.adu_account=<name>.

--deployment-id --did

ID distribuzione fornito dal chiamante. Non può contenere più di 73 caratteri, deve essere tutto in minuscolo e non può contenere '&', '^', '[', ']', '{', '}', '|', '', '<', '>', barra, barra rovesciata o virgolette doppie.

--gid --group-id

ID gruppo di dispositivi. Questo viene creato dal valore del tag ADUGroup nel dispositivo gemello del modulo o del modulo gemello di hub IoT connesso o $default per i dispositivi senza tag.

--instance -i

Nome dell'istanza di Aggiornamento dispositivi. È possibile configurare il nome predefinito dell'istanza usando az config set defaults.adu_instance=<name>.

Parametri facoltativi

--cid --class-id

ID classe dispositivo. Questo viene generato dall'ID modello e dalle proprietà di compatibilità segnalate dall'agente di aggiornamento del dispositivo nell'interfaccia PnP di Aggiornamento dispositivi in hub IoT. Si tratta di un hash SHA1 con codifica esadecimale.

--resource-group -g

Nome del gruppo di risorse dell'account di Aggiornamento dispositivi. È possibile configurare il gruppo predefinito con az config set defaults.adu_group=<name>.

--status

Ottiene lo stato di una distribuzione, inclusa una suddivisione del numero di dispositivi nella distribuzione in corso, completati o non riusciti.

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