az iot central scheduled-job

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 az iot central scheduled-job . Přečtěte si další informace o rozšířeních.

Správa a konfigurace úlohy plánu IoT Central

Příkazy

Name Description Typ Stav
az iot central scheduled-job create

Vytvořte naplánovanou úlohu podle ID.

Rozšíření GA
az iot central scheduled-job delete

Odstraňte existující naplánovanou úlohu podle ID.

Rozšíření GA
az iot central scheduled-job list

Získejte seznam definic naplánovaných úloh v aplikaci.

Rozšíření GA
az iot central scheduled-job list-runs

Získejte seznam instancí úloh pro definici naplánované úlohy.

Rozšíření GA
az iot central scheduled-job show

Získejte podrobnosti o naplánované úloze podle ID.

Rozšíření GA
az iot central scheduled-job update

Aktualizujte naplánovanou úlohu podle ID.

Rozšíření GA

az iot central scheduled-job create

Vytvořte naplánovanou úlohu podle ID.

--schedule a --content můžou být vložené soubory JSON nebo cesta k souboru.

az iot central scheduled-job create --app-id
                                    --content
                                    --group-id
                                    --id
                                    --schedule
                                    [--api-version {2022-06-30-preview, 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 plánu s názvem

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule {jobScheduleJSONPatch} --content {jobDataJSONPath}

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

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --batch {jobBatchValue} --batch-type {jobBatchType}

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

az iot central scheduled-job create --app-id {appid} --job-id {jobId} --group-id {groupId} --job-name {displayName} --schedule	{jobScheduleJSONPatch} --content {jobDataJSONPath} --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. Text požadavku musí obsahovat pole JobData.

--group-id -g

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

--id --job-id

Jedinečný identifikátor naplánované úlohy.

--schedule

Plán, ve kterém se má úloha spustit. Zadejte cestu k souboru JSON nebo nezpracovaného řetězci JSON.

Volitelné parametry

--api-version --av
Zastaralé

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

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 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řijímané hodnoty: number, percentage
výchozí hodnota: 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.

výchozí hodnota: 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řijímané hodnoty: number, percentage
výchozí hodnota: number
--central-api-uri --central-dns-suffix

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

výchozí hodnota: 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ř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 central scheduled-job delete

Odstraňte existující naplánovanou úlohu podle ID.

az iot central scheduled-job delete --app-id
                                    --id
                                    [--api-version {2022-06-30-preview, 2022-07-31}]
                                    [--central-api-uri]
                                    [--token]

Příklady

Odstranění existující naplánované úlohy podle ID

az iot central scheduled-job delete --app-id {appid} --id {scheduledJobId}

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.

--id --job-id

Jedinečný identifikátor naplánované úlohy.

Volitelné parametry

--api-version --av
Zastaralé

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

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 2022-07-31
--central-api-uri --central-dns-suffix

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

výchozí hodnota: 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ř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 central scheduled-job list

Získejte seznam definic naplánovaných úloh v aplikaci.

az iot central scheduled-job list --app-id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--token]

Příklady

Získání seznamu definic naplánovaných úloh v aplikaci

az iot central scheduled-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.

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 2022-07-31
--central-api-uri --central-dns-suffix

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

výchozí hodnota: 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ř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 central scheduled-job list-runs

Získejte seznam instancí úloh pro definici naplánované úlohy.

az iot central scheduled-job list-runs --app-id
                                       --id
                                       [--api-version {2022-06-30-preview, 2022-07-31}]
                                       [--central-api-uri]
                                       [--token]

Příklady

Získání seznamu instancí úloh pro definici naplánované úlohy

az iot central scheduled-job list-runs --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.

--id --job-id

Jedinečný identifikátor naplánované úlohy.

Volitelné parametry

--api-version --av
Zastaralé

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

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 2022-07-31
--central-api-uri --central-dns-suffix

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

výchozí hodnota: 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ř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 central scheduled-job show

Získejte podrobnosti o naplánované úloze podle ID.

az iot central scheduled-job show --app-id
                                  --id
                                  [--api-version {2022-06-30-preview, 2022-07-31}]
                                  [--central-api-uri]
                                  [--token]

Příklady

Získání podrobností o naplánované úloze podle ID

az iot central scheduled-job show --app-id {appid} --id {scheduledJobId}

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.

--id --job-id

Jedinečný identifikátor naplánované úlohy.

Volitelné parametry

--api-version --av
Zastaralé

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

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 2022-07-31
--central-api-uri --central-dns-suffix

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

výchozí hodnota: 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ř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 central scheduled-job update

Aktualizujte naplánovanou úlohu podle ID.

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

Příklady

Aktualizace úlohy plánu s názvem

az iot central scheduled-job update --app-id {appid} --job-id {jobId} --job-name {displayName}

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.

--id --job-id

Jedinečný identifikátor naplánované úlohy.

Volitelné parametry

--api-version --av
Zastaralé

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

Tento parametr příkazu je zastaralý a bude ignorován. V budoucí verzi budeme podporovat pouze rozhraní API IoT Central z nejnovější verze GA. Pokud ještě některé rozhraní API není obecně dostupné, zavoláme nejnovější verzi Preview.

přijímané hodnoty: 2022-06-30-preview, 2022-07-31
výchozí hodnota: 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řijímané hodnoty: number, percentage
výchozí hodnota: 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.

--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řijímané hodnoty: number, percentage
výchozí hodnota: number
--central-api-uri --central-dns-suffix

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

výchozí hodnota: azureiotcentral.com
--content -k

Definice dat úlohy. Zadejte cestu k souboru JSON nebo nezpracovaného řetězci JSON. Text požadavku musí obsahovat pole JobData.

--desc --description

Podrobný popis úlohy

--group-id -g

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

--job-name

Zobrazovaný název úlohy.

--schedule

Plán, ve kterém se má úloha spustit. Zadejte cestu k souboru JSON nebo nezpracovaného řetězci JSON.

--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ř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.