Dela via

az iot central scheduled-job

  • Referens

Kommentar

Den här referensen är en del av azure-iot-tillägget för Azure CLI (version 2.46.0 eller senare). Tillägget installeras automatiskt första gången du kör kommandot az iot central scheduled-job . Läs mer om tillägg.

Hantera och konfigurera schemajobb för IoT Central.

Kommandon

Name Description Typ Status
az iot central scheduled-job create

Skapa ett schemalagt jobb med ID.

 Anknytning Allmän tillgänglighet
az iot central scheduled-job delete

Ta bort ett befintligt schemalagt jobb med ID.

 Anknytning Allmän tillgänglighet
az iot central scheduled-job list

Hämta listan över schemalagda jobbdefinitioner i ett program.

 Anknytning Allmän tillgänglighet
az iot central scheduled-job list-runs

Hämta listan över jobbinstanser för en schemalagd jobbdefinition.

 Anknytning Allmän tillgänglighet
az iot central scheduled-job show

Få information om ett schemalagt jobb efter ID.

 Anknytning Allmän tillgänglighet
az iot central scheduled-job update

Uppdatera ett schemalagt jobb efter ID.

 Anknytning Allmän tillgänglighet

az iot central scheduled-job create

Skapa ett schemalagt jobb med ID.

--schedule och --content kan vara infogad json eller filsökväg.

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]

Exempel

Skapa ett schemajobb med namnet

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

Skapa ett schemalagt jobb med namn och batchkonfiguration.

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}

Skapa ett schemalagt jobb med konfiguration av namn och annulleringströskel utan batch.

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}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--content -k

Jobbdatadefinitionen. Ange sökväg till JSON-fil eller råsträngad JSON. Begärandetexten måste innehålla en matris med JobData.

--group-id -g

ID:t för den enhetsgrupp som jobbet ska köras på.

--id --job-id

Unik identifierare för det schemalagda jobbet.

--schedule

Schemat där jobbet ska köras. Ange sökväg till JSON-fil eller råsträngad JSON.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--batch -b

Antalet eller procentandelen enheter som batchbearbetningen görs på.

--batch-type --bt

Ange om batchbearbetning görs på ett antal enheter eller en procentandel av totalsumman.

Godkända värden: number, percentage
Standardvärde: number
--cancellation-threshold --cth

Antalet eller procentandelen enheter som tröskelvärdet för annullering tillämpas på.

--cancellation-threshold-batch --ctb

Om tröskelvärdet för annullering gäller per batch eller för det övergripande jobbet.

Standardvärde: number
--cancellation-threshold-type --ctt

Ange om tröskelvärdet för annullering gäller för ett antal enheter eller en procentandel av totalsumman.

Godkända värden: number, percentage
Standardvärde: number
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--desc --description

Detaljerad beskrivning av jobbet.

--job-name

Jobbets visningsnamn.

--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central scheduled-job delete

Ta bort ett befintligt schemalagt jobb med ID.

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

Exempel

Ta bort ett befintligt schemalagt jobb efter ID

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

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--id --job-id

Unik identifierare för det schemalagda jobbet.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central scheduled-job list

Hämta listan över schemalagda jobbdefinitioner i ett program.

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

Exempel

Hämta listan över schemalagda jobbdefinitioner i ett program

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

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central scheduled-job list-runs

Hämta listan över jobbinstanser för en schemalagd jobbdefinition.

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

Exempel

Hämta listan över jobbinstanser för en schemalagd jobbdefinition

az iot central scheduled-job list-runs --app-id {appid} --job-id {jobId}

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--id --job-id

Unik identifierare för det schemalagda jobbet.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central scheduled-job show

Få information om ett schemalagt jobb efter ID.

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

Exempel

Få information om ett schemalagt jobb efter ID

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

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--id --job-id

Unik identifierare för det schemalagda jobbet.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az iot central scheduled-job update

Uppdatera ett schemalagt jobb efter 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]

Exempel

Uppdatera ett schemajobb med namnet

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

Obligatoriska parametrar

--app-id -n

App-ID för den IoT Central-app som du vill hantera. Du hittar app-ID:t på sidan "Om" för ditt program under hjälpmenyn.

--id --job-id

Unik identifierare för det schemalagda jobbet.

Valfria parametrar

--api-version --av
Inaktuell

Argumentet "api_version" har blivit inaktuellt och tas bort i en framtida version.

Den här kommandoparametern är inaktuell och ignoreras. I den framtida versionen stöder vi endast IoT Central-API:er från den senaste GA-versionen. Om något API inte är GA ännu anropar vi den senaste förhandsversionen.

Godkända värden: 2022-06-30-preview, 2022-07-31
Standardvärde: 2022-07-31
--batch -b

Antalet eller procentandelen enheter som batchbearbetningen görs på.

--batch-type --bt

Ange om batchbearbetning görs på ett antal enheter eller en procentandel av totalsumman.

Godkända värden: number, percentage
Standardvärde: number
--cancellation-threshold --cth

Antalet eller procentandelen enheter som tröskelvärdet för annullering tillämpas på.

--cancellation-threshold-batch --ctb

Om tröskelvärdet för annullering gäller per batch eller för det övergripande jobbet.

--cancellation-threshold-type --ctt

Ange om tröskelvärdet för annullering gäller för ett antal enheter eller en procentandel av totalsumman.

Godkända värden: number, percentage
Standardvärde: number
--central-api-uri --central-dns-suffix

IoT Central DNS-suffixet som är associerat med ditt program.

Standardvärde: azureiotcentral.com
--content -k

Jobbdatadefinitionen. Ange sökväg till JSON-fil eller råsträngad JSON. Begärandetexten måste innehålla en matris med JobData.

--desc --description

Detaljerad beskrivning av jobbet.

--group-id -g

ID:t för den enhetsgrupp som jobbet ska köras på.

--job-name

Jobbets visningsnamn.

--schedule

Schemat där jobbet ska köras. Ange sökväg till JSON-fil eller råsträngad JSON.

--token

Om du föredrar att skicka din begäran utan att autentisera mot Azure CLI kan du ange en giltig användartoken för att autentisera din begäran. Du måste ange typ av nyckel som en del av begäran. Läs mer på https://aka.ms/iotcentraldocsapi.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

Godkända värden: json, jsonc, none, table, tsv, yaml, yamlc
Standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.