az iot hub job

  • Reference

Poznámka

Tento odkaz je součástí rozšíření azure-iot pro Azure CLI (verze 2.37.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu úlohy az iot hub . Přečtěte si další informace o rozšířeních.

Správa úloh IoT Hubu (v2)

Příkazy

Name Description Typ Stav
az iot hub job cancel

Zrušení úlohy IoT Hubu

 Rozšíření GA
az iot hub job create

Vytvoření a naplánování úlohy IoT Hubu pro spuštění

 Rozšíření GA
az iot hub job list

Výpis historických úloh ioT Hubu

 Rozšíření GA
az iot hub job show

Zobrazení podrobností o existující úloze IoT Hubu

 Rozšíření GA

az iot hub job cancel

Zrušení úlohy IoT Hubu

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

Příklady

Zrušení úlohy IoT Hubu

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

Povinné parametry

--job-id

ID úlohy IoT Hubu

Volitelné parametry

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login
výchozí hodnota: key
--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub job create

Vytvoření a naplánování úlohy IoT Hubu pro spuštění

Při plánování úlohy aktualizace dvojčete je opravy dvojčete povinný argument. Při plánování úlohy metody zařízení jsou požadované argumenty název metody a datová část. POZNÁMKA: Použití vlastního času spuštění, který je v minulosti, může způsobit selhání operace.

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}]

Příklady

Vytvořte a naplánujte úlohu, která aktualizuje značky dvojčat všech zařízení.

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

Naplánovat úlohu a blokovat výsledek "dokončeno", "selhalo" nebo "zrušeno". Zadejte interval dotazování v sekundách.

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

Vytvořte úlohu pro aktualizaci požadované vlastnosti dvojčete na podmnožině zařízení, která je naplánovaná tak, aby běžela v libovolném budoucím čase.

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']"

Vytvořte a naplánujte úlohu pro vyvolání metody zařízení pro sadu zařízení, která splňují podmínku dotazu.

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"

Vytvořte a naplánujte úlohu, která vyvolá metodu zařízení pro všechna zařízení.

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

Povinné parametry

--job-id

ID úlohy IoT Hubu

--job-type --jt

Typ naplánované úlohy.

přijímané hodnoty: scheduleDeviceMethod, scheduleUpdateTwin

Volitelné parametry

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login
výchozí hodnota: key
--duration --poll-duration

Celková doba trvání v sekundách, kdy se stav úlohy zkontroluje, jestli se předá příznak --wait.

výchozí hodnota: 600
--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--interval --poll-interval

Interval v sekundách, kdy se stav úlohy zkontroluje, jestli se předá příznak --wait.

výchozí hodnota: 10
--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--mct --method-connect-timeout

Maximální počet sekund čekání na připojení zařízení.

výchozí hodnota: 30
--method-name --mn

Cílová metoda pro vyvolání

--method-payload --mp

Datová část JSON, která se má předat metodě. Musí to být cesta k souboru nebo nezpracovaný json.

--method-response-timeout --mrt

Maximální početsekundch

výchozí hodnota: 30
--patch --twin-patch

Požadovaná oprava dvojčete. Zadejte cestu k souboru nebo nezpracovaný kód JSON.

--query-condition -q

Podmínka pro dotaz zařízení pro získání zařízení pro spuštění úlohy. Vyžaduje se, pokud typ úlohy je scheduleDeviceMethod nebo scheduleUpdateTwin. Poznámka: Služba předpona "SELECT * FROM devices WHERE" na vstup.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--start --start-time

Naplánované zahájení úlohy ve formátu data a času ISO 8601. Pokud není k dispozici žádný čas spuštění, úloha se zařadí do fronty pro spuštění asap. Použití vlastního času spuštění, který je v minulosti, může způsobit selhání operace.

--ttl

Maximální doba provádění v sekundách před ukončením úlohy

výchozí hodnota: 3600
--wait -w

Blokovat, dokud nebude vytvořená úloha v dokončeném, neúspěšném nebo zrušeném stavu. Bude pravidelně dotazovat na interval určený parametrem --poll-interval.

přijímané hodnoty: false, true
výchozí hodnota: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub job list

Výpis historických úloh ioT Hubu

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]

Příklady

Zobrazit seznam všech archivovaných úloh během doby uchovávání (maximálně 30 dnů)

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

Výpis všech archivovaných úloh, které promítnou konkrétní vlastnosti

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

Výpis pouze úloh typu aktualizace dvojčete

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

Výpis úloh metod zařízení se stavem Naplánované

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

Výpis úloh exportu zařízení se stavem Dokončeno

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

Volitelné parametry

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login
výchozí hodnota: key
--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--job-status --js

Stav naplánované úlohy.

přijímané hodnoty: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown
--job-type --jt

Typ naplánované úlohy.

přijímané hodnoty: export, import, scheduleDeviceMethod, scheduleUpdateTwin
--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--top

Maximální počet prvků, které se mají vrátit. Použijte -1 pro neomezenou dobu.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az iot hub job show

Zobrazení podrobností o existující úloze IoT Hubu

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

Příklady

Zobrazí podrobnosti o vytvořené úloze.

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

Povinné parametry

--job-id

ID úlohy IoT Hubu

Volitelné parametry

--auth-type

Určuje, jestli má operace automaticky odvodit klíč zásady, nebo použít aktuální relaci Azure AD. Pokud je typ ověřování přihlášení a zadá se název hostitele prostředku, bude vyhledávání prostředků vynecháno, pokud není potřeba. Výchozí nastavení můžete nakonfigurovat pomocí az configure --defaults iothub-data-auth-type=<auth-type-value>.

přijímané hodnoty: key, login
výchozí hodnota: key
--hub-name -n

Název nebo název hostitele služby IoT Hub Vyžaduje se, pokud není zadané --login.

--login -l

Tento příkaz podporuje entitu připojovací řetězec s právy k provedení akce. Použijte k tomu, abyste se vyhnuli přihlášení k relaci prostřednictvím příkazu az login. Pokud jsou připojovací řetězec i název entity zadané připojovací řetězec prioritu. Vyžaduje se, pokud není zadaný název --hub-name.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

přijímané hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
výchozí hodnota: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.