Condividi tramite

az iot hub job

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

Gestire i processi di hub IoT (v2).

Comandi

Nome Descrizione Tipo Status
az iot hub job cancel

Annullare un processo di hub IoT.

 Estensione Disponibilità generale
az iot hub job create

Creare e pianificare un processo hub IoT per l'esecuzione.

 Estensione Disponibilità generale
az iot hub job list

Elencare i processi cronologici di un hub IoT.

 Estensione Disponibilità generale
az iot hub job show

Mostra i dettagli di un processo di hub IoT esistente.

 Estensione Disponibilità generale

az iot hub job cancel

Annullare un processo di hub IoT.

az iot hub job cancel --job-id
                      [--auth-type {key, login}]
                      [--hub-name]
                      [--login]
                      [--resource-group]

Esempio

Annullare un processo di hub IoT.

az iot hub job cancel --hub-name {iothub_name} --job-id {job_id}

Parametri necessari

--job-id

hub IoT ID processo.

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 job create

Creare e pianificare un processo hub IoT per l'esecuzione.

Quando si pianifica un processo di aggiornamento del gemello, la patch del gemello è un argomento obbligatorio. Quando si pianifica un processo del metodo del dispositivo, il nome del metodo e il payload sono argomenti obbligatori. NOTA: l'uso di un'ora di inizio personalizzata precedente potrebbe causare l'esito negativo dell'operazione.

az iot hub job create --job-id
                      --job-type {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration]
                      [--hub-name]
                      [--interval]
                      [--login]
                      [--mct]
                      [--method-name]
                      [--method-payload]
                      [--method-response-timeout]
                      [--patch]
                      [--query-condition]
                      [--resource-group]
                      [--start]
                      [--ttl]
                      [--wait {false, true}]

Esempio

Creare e pianificare un processo per aggiornare i tag gemelli di tutti i dispositivi.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}'

Pianificare il processo e il blocco per il risultato di "completed", "failed" o "cancelled". Specificare l'intervallo di polling in secondi.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}' --wait --poll-interval 30

Creare un processo per aggiornare una proprietà del gemello desiderata in un subset di dispositivi, pianificata per l'esecuzione in un momento futuro arbitrario.

az iot hub job create --job-id {job_name} --job-type scheduleUpdateTwin -n {iothub_name} --twin-patch '{"properties":{"desired": {"temperatureF": 65}}}' --start-time "2050-01-08T12:19:56.868Z" --query-condition "deviceId IN ['MyDevice1', 'MyDevice2', 'MyDevice3']"

Creare e pianificare un processo per richiamare un metodo del dispositivo per un set di dispositivi che soddisfano una condizione di query.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -n {iothub_name} --method-name setSyncIntervalSec --method-payload 30 --query-condition "properties.reported.settings.syncIntervalSec != 30"

Creare e pianificare un processo per richiamare un metodo dispositivo per tutti i dispositivi.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -q "*" -n {iothub_name} --method-name setSyncIntervalSec --method-payload '{"version":"1.0"}'

Parametri necessari

--job-id

hub IoT ID processo.

--job-type --jt

Tipo di processo pianificato.

Valori accettati: scheduleDeviceMethod, scheduleUpdateTwin

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
--duration --poll-duration

Durata totale in secondi in cui lo stato del processo verrà controllato se viene passato il flag --wait.

Valore predefinito: 600
--hub-name -n

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

--interval --poll-interval

Intervallo in secondi in cui lo stato del processo verrà controllato se viene passato il flag --wait.

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

--mct --method-connect-timeout

Numero massimo di secondi di attesa sulla connessione del dispositivo.

Valore predefinito: 30
--method-name --mn

Metodo di destinazione per la chiamata.

--method-payload --mp

Payload JSON da passare al metodo. Deve essere il percorso del file o il codice JSON non elaborato.

--method-response-timeout --mrt

Numero massimo di secondi di attesa per il risultato del metodo del dispositivo.

Valore predefinito: 30
--patch --twin-patch

Patch del gemello desiderato. Specificare il percorso del file o il codice JSON non elaborato.

--query-condition -q

Condizione per la query del dispositivo per ottenere i dispositivi su cui eseguire il processo. Obbligatorio se il tipo di processo è scheduleDeviceMethod o scheduleUpdateTwin. Nota: il servizio anteporrà il prefisso "SELECT * FROM devices WHERE" all'input.

--resource-group -g

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

--start --start-time

Inizio pianificato del processo in formato data ISO 8601. Se non viene specificata alcuna ora di inizio, il processo viene accodato per l'esecuzione asap. L'uso di un'ora di inizio personalizzata precedente può causare l'esito negativo dell'operazione.

--ttl

Tempo massimo di esecuzione in secondi, prima che il processo venga terminato.

Valore predefinito: 3600
--wait -w

Blocca fino a quando il processo creato non è stato completato, non riuscito o annullato. Eseguirà regolarmente il polling dell'intervallo specificato da --poll-interval.

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

Elencare i processi cronologici di un hub IoT.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type {export, import, scheduleDeviceMethod, scheduleUpdateTwin}]
                    [--login]
                    [--resource-group]
                    [--top]

Esempio

Elencare tutti i processi archiviati entro il periodo di conservazione (massimo 30 giorni).

az iot hub job list --hub-name {iothub_name}

Elencare tutte le proprietà specifiche dei processi archiviati

az iot hub job list --hub-name {iothub_name} --query "[*].[jobId,type,status,startTime,endTime]"

Elencare solo i processi di tipo gemello di aggiornamento

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod

Elencare i processi del metodo del dispositivo con stato "pianificato"

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod --job-status scheduled

Elencare i processi di esportazione dei dispositivi con stato "completato"

az iot hub job list --hub-name {iothub_name} --job-type export --job-status completed

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.

--job-status --js

Stato di un processo pianificato.

Valori accettati: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

Tipo di processo pianificato.

Valori accettati: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--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.

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

Mostra i dettagli di un processo di hub IoT esistente.

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

Esempio

Visualizzare i dettagli di un processo creato.

az iot hub job show --hub-name {iothub_name} --job-id {job_id}

Parametri necessari

--job-id

hub IoT ID processo.

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.