az iot central job

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 ett az iot central job-kommando . Läs mer om tillägg.

Hantera och konfigurera jobb för ett IoT Central-program.

Kommandon

Name	Description	Typ	Status
az iot central job create	Skapa och köra ett jobb via dess jobbdefinition.	Anknytning	Allmän tillgänglighet
az iot central job get-devices	Hämta status för jobbenhet.	Anknytning	Allmän tillgänglighet
az iot central job list	Hämta listan över jobb för ett IoT Central-program.	Anknytning	Allmän tillgänglighet
az iot central job rerun	Kör ett jobb igen på alla misslyckade enheter.	Anknytning	Allmän tillgänglighet
az iot central job resume	Återuppta ett stoppat jobb.	Anknytning	Allmän tillgänglighet
az iot central job show	Hämta information om ett jobb efter ID.	Anknytning	Allmän tillgänglighet
az iot central job stop	Stoppa ett jobb som körs.	Anknytning	Allmän tillgänglighet

az iot central job create

Skapa och köra ett jobb via dess jobbdefinition.

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]

Exempel

Skapa ett jobb med namn

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

Skapa ett jobb med namn och batchkonfiguration.

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

Skapa ett jobb med konfiguration av namn och tröskelvärde för annullering utan batch.

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}

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. [Exempel på filsökväg:./path/to/file.json] [Exempel på strängifierad 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å.

--job-id -j

Unik identifierare för jobbet.

Valfria parametrar

--api-version --av

Inaktuell

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

API-versionen för den begärda åtgärden.

Godkända värden: 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 job get-devices

Hämta status för jobbenhet.

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

Exempel

Hämta listan över enskilda enhetsstatusar efter jobb-ID

az iot central job get-devices --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.

--job-id -j

Unik identifierare för jobbet.

Valfria parametrar

--api-version --av

Inaktuell

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

API-versionen för den begärda åtgärden.

Godkända värden: 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 job list

Hämta listan över jobb för ett IoT Central-program.

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

Exempel

Lista jobb i ett program

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

API-versionen för den begärda åtgärden.

Godkända värden: 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 job rerun

Kör ett jobb igen på alla misslyckade enheter.

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

Exempel

Kör ett jobb igen

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

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.

--job-id -j

Unik identifierare för jobbet.

--rerun-id

Unik identifierare för omkörningen.

Valfria parametrar

--api-version --av

Inaktuell

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

API-versionen för den begärda åtgärden.

Godkända värden: 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 job resume

Återuppta ett stoppat jobb.

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

Exempel

Återuppta ett jobb

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

--job-id -j

Unik identifierare för jobbet.

Valfria parametrar

--api-version --av

Inaktuell

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

API-versionen för den begärda åtgärden.

Godkända värden: 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 job show

Hämta information om ett jobb efter ID.

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

Exempel

Hämta information om jobbet

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

--job-id -j

Unik identifierare för jobbet.

Valfria parametrar

--api-version --av

Inaktuell

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

API-versionen för den begärda åtgärden.

Godkända värden: 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 job stop

Stoppa ett jobb som körs.

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

Exempel

Stoppa ett jobb

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

--job-id -j

Unik identifierare för jobbet.

Valfria parametrar

--api-version --av

Inaktuell

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

API-versionen för den begärda åtgärden.

Godkända värden: 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.