az iot central job

Poznámka:

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

Správa a konfigurace úloh pro aplikaci IoT Central

Příkazy

Name	Description	Typ	Stav
az iot central job create	Vytvořte a spusťte úlohu prostřednictvím její definice úlohy.	Rozšíření	GA
az iot central job get-devices	Získejte stav zařízení úloh.	Rozšíření	GA
az iot central job list	Získejte seznam úloh pro aplikaci IoT Central.	Rozšíření	GA
az iot central job rerun	Znovu spusťte úlohu na všech neúspěšných zařízeních.	Rozšíření	GA
az iot central job resume	Obnovení zastavené úlohy	Rozšíření	GA
az iot central job show	Získejte podrobnosti o úloze podle ID.	Rozšíření	GA
az iot central job stop	Zastavte spuštěnou úlohu.	Rozšíření	GA

az iot central job create

Vytvořte a spusťte úlohu prostřednictvím její definice úlohy.

az iot central job create --app-id
                          --content
                          --group-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--batch]
                          [--batch-type {number, percentage}]
                          [--cancellation-threshold]
                          [--cancellation-threshold-batch]
                          [--cancellation-threshold-type {number, percentage}]
                          [--central-api-uri]
                          [--desc]
                          [--job-name]
                          [--token]

Příklady

Vytvoření úlohy s názvem

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath}

Vytvořte úlohu s názvem a konfigurací dávky.

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

Vytvořte úlohu s konfigurací prahové hodnoty názvu a zrušení bez dávky.

az iot central job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {jobName} --content {creationJSONPath} --cancellation-threshold {jobCancellationThresholdValue} --cancellation-threshold-type {jobCancellationThresholdType} --description {jobDesc}

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

--content -k

Definice dat úlohy. Zadejte cestu k souboru JSON nebo nezpracovaného řetězci JSON. [Příklad cesty k souboru:./path/to/file.json] [Příklad stringifikovaného JSON:[{}]. Text požadavku musí obsahovat pole JobData.

--group-id -g

ID skupiny zařízení, na které se má úloha spustit.

--job-id -j

Jedinečný identifikátor úlohy.

Volitelné parametry

--api-version --av

Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Verze rozhraní API požadované operace.

Přípustné hodnoty: 2022-07-31

Default value: 2022-07-31

--batch -b

Počet nebo procento zařízení, na kterých se dávkování provádí.

--batch-type --bt

Určete, jestli se dávkování provádí na počtu zařízení nebo procento z celkového počtu.

Přípustné hodnoty: number, percentage

Default value: number

--cancellation-threshold --cth

Počet nebo procento zařízení, na kterých se použije prahová hodnota zrušení.

--cancellation-threshold-batch --ctb

Určuje, jestli prahová hodnota zrušení platí pro každou dávku nebo pro celkovou úlohu.

Default value: number

--cancellation-threshold-type --ctt

Určete, jestli se prahová hodnota zrušení vztahuje na počet zařízení nebo procento celkového počtu zařízení.

Přípustné hodnoty: number, percentage

Default value: number

--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

Default value: azureiotcentral.com

--desc --description

Podrobný popis úlohy

--job-name

Zobrazovaný název úlohy.

--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: 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 central job get-devices

Získejte stav zařízení úloh.

az iot central job get-devices --app-id
                               --job-id
                               [--api-version {2022-07-31}]
                               [--central-api-uri]
                               [--token]

Příklady

Získání seznamu jednotlivých stavů zařízení podle ID úlohy

az iot central job get-devices --app-id {appid} --job-id {jobId}

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

--job-id -j

Jedinečný identifikátor úlohy.

Volitelné parametry

--api-version --av

Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Verze rozhraní API požadované operace.

Přípustné hodnoty: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

Default value: azureiotcentral.com

--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: 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 central job list

Získejte seznam úloh pro aplikaci IoT Central.

az iot central job list --app-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Příklady

Výpis úloh v aplikaci

az iot central job list --app-id {appid}

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

Volitelné parametry

--api-version --av

Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Verze rozhraní API požadované operace.

Přípustné hodnoty: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

Default value: azureiotcentral.com

--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: 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 central job rerun

Znovu spusťte úlohu na všech neúspěšných zařízeních.

az iot central job rerun --app-id
                         --job-id
                         --rerun-id
                         [--api-version {2022-07-31}]
                         [--central-api-uri]
                         [--token]

Příklady

Opětovné spuštění úlohy

az iot central job rerun --app-id {appid} --job-id {jobId} --rerun-id {rerunId}

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

--job-id -j

Jedinečný identifikátor úlohy.

--rerun-id

Jedinečný identifikátor pro opětovné spuštění.

Volitelné parametry

--api-version --av

Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Verze rozhraní API požadované operace.

Přípustné hodnoty: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

Default value: azureiotcentral.com

--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: 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 central job resume

Obnovení zastavené úlohy

az iot central job resume --app-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--central-api-uri]
                          [--token]

Příklady

Obnovení úlohy

az iot central job resume --app-id {appid} --job-id {jobId}

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

--job-id -j

Jedinečný identifikátor úlohy.

Volitelné parametry

--api-version --av

Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Verze rozhraní API požadované operace.

Přípustné hodnoty: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

Default value: azureiotcentral.com

--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: 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 central job show

Získejte podrobnosti o úloze podle ID.

az iot central job show --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Příklady

Získání podrobností o úloze

az iot central job show --app-id {appid} --job-id {jobId}

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

--job-id -j

Jedinečný identifikátor úlohy.

Volitelné parametry

--api-version --av

Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Verze rozhraní API požadované operace.

Přípustné hodnoty: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

Default value: azureiotcentral.com

--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: 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 central job stop

Zastavte spuštěnou úlohu.

az iot central job stop --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--token]

Příklady

Zastavení úlohy

az iot central job stop --app-id {appid} --job-id {jobId}

Povinné parametry

--app-id -n

ID aplikace IoT Central, kterou chcete spravovat. ID aplikace najdete na stránce O aplikaci v nabídce nápovědy.

--job-id -j

Jedinečný identifikátor úlohy.

Volitelné parametry

--api-version --av

Zastaralé

Argument api_version je zastaralý a v budoucí verzi se odebere.

Verze rozhraní API požadované operace.

Přípustné hodnoty: 2022-07-31

Default value: 2022-07-31

--central-api-uri --central-dns-suffix

Přípona DNS IoT Central přidružená k vaší aplikaci.

Default value: azureiotcentral.com

--token

Pokud chcete žádost odeslat bez ověřování v Azure CLI, můžete zadat platný token uživatele pro ověření vaší žádosti. Jako součást požadavku musíte zadat typ klíče. Další informace najdete na adrese https://aka.ms/iotcentraldocsapi.

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řípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc

Default value: 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.