Freigeben über

az iot central job

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). Die Erweiterung wird automatisch installiert, wenn Sie einen az iot zentralen Auftrag Befehl ausführen. Learn more about extensions.

Verwalten und Konfigurieren von Aufträgen für eine IoT Central-Anwendung.

Befehle

Name Beschreibung Typ Status
az iot central job create

Erstellen und Ausführen eines Auftrags über die Auftragsdefinition

 Extension GA
az iot central job get-devices

Abrufen von Auftragsgerätestatus.

 Extension GA
az iot central job list

Ruft die Liste der Aufträge für eine IoT Central-Anwendung ab.

 Extension GA
az iot central job rerun

Führen Sie einen Auftrag auf allen fehlgeschlagenen Geräten erneut aus.

 Extension GA
az iot central job resume

Fortsetzen eines angehaltenen Auftrags.

 Extension GA
az iot central job show

Rufen Sie die Details eines Auftrags nach ID ab.

 Extension GA
az iot central job stop

Beenden Eines ausgeführten Auftrags.

 Extension GA

az iot central job create

Erstellen und Ausführen eines Auftrags über die Auftragsdefinition

az iot central job create --app-id
                          --content
                          --group-id
                          --job-id
                          [--api-version --av {2022-07-31}]
                          [--batch]
                          [--batch-type --bt {number, percentage}]
                          [--cancellation-threshold --cth]
                          [--cancellation-threshold-batch --ctb]
                          [--cancellation-threshold-type --ctt {number, percentage}]
                          [--central-api-uri --central-dns-suffix]
                          [--desc --description]
                          [--job-name]
                          [--token]

Beispiele

Erstellen eines Auftrags mit Namen

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

Erstellen Sie einen Auftrag mit Name und 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}

Erstellen Sie einen Auftrag mit Namens- und Abbruchschwellenkonfiguration ohne 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}

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--content -k

Die Auftragsdatendefinition. Geben Sie Pfad zu JSON-Datei oder unformatierter JSON-Datei an. [Dateipfadbeispiel:./path/to/file.json] [Beispiel für stringified JSON:[{Job Data JSON}]. Der Anforderungstext muss ein Array von JobData enthalten.

--group-id -g

Die ID der Gerätegruppe, auf der der Auftrag ausgeführt werden soll.

--job-id -j

Eindeutiger Bezeichner für den Auftrag.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-07-31
--batch -b

Die Anzahl oder der Prozentsatz der Geräte, auf denen die Batchverarbeitung erfolgt.

--batch-type --bt

Geben Sie an, ob die Batchverarbeitung auf einer Reihe von Geräten oder einem Prozentsatz der Summe erfolgt.

Eigenschaft Wert
Standardwert: number
Zulässige Werte: number, percentage
--cancellation-threshold --cth

Die Anzahl oder der Prozentsatz der Geräte, auf denen der Abbruchschwellenwert angewendet wird.

--cancellation-threshold-batch --ctb

Gibt an, ob der Abbruchschwellenwert pro Batch oder auf den Gesamtauftrag angewendet wird.

Eigenschaft Wert
Standardwert: number
--cancellation-threshold-type --ctt

Geben Sie an, ob der Abbruchschwellenwert für eine Anzahl von Geräten oder einen Prozentsatz der Summe gilt.

Eigenschaft Wert
Standardwert: number
Zulässige Werte: number, percentage
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--desc --description

Detaillierte Beschreibung des Auftrags.

--job-name

Anzeigename des Auftrags.

--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central job get-devices

Abrufen von Auftragsgerätestatus.

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

Beispiele

Abrufen der Liste einzelner Gerätestatus nach Auftrags-ID

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--job-id -j

Eindeutiger Bezeichner für den Auftrag.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central job list

Ruft die Liste der Aufträge für eine IoT Central-Anwendung ab.

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

Beispiele

Auflisten von Aufträgen in einer Anwendung

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central job rerun

Führen Sie einen Auftrag auf allen fehlgeschlagenen Geräten erneut aus.

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

Beispiele

Erneutes Ausführen eines Auftrags

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--job-id -j

Eindeutiger Bezeichner für den Auftrag.

--rerun-id

Eindeutiger Bezeichner für die Erneutes Ausführen.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central job resume

Fortsetzen eines angehaltenen Auftrags.

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

Beispiele

Fortsetzen eines Auftrags

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--job-id -j

Eindeutiger Bezeichner für den Auftrag.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central job show

Rufen Sie die Details eines Auftrags nach ID ab.

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

Beispiele

Abrufen von Auftragsdetails

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--job-id -j

Eindeutiger Bezeichner für den Auftrag.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az iot central job stop

Beenden Eines ausgeführten Auftrags.

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

Beispiele

Beenden eines Auftrags

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

Erforderliche Parameter

--app-id -n

Die App-ID der IoT Central-App, die Sie verwalten möchten. Sie finden die App-ID auf der Seite "Info" für Ihre Anwendung im Hilfemenü.

--job-id -j

Eindeutiger Bezeichner für den Auftrag.

Optionale Parameter

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-version --av
Als veraltet markiert

Das Argument "api_version" ist veraltet und wird in einer zukünftigen Version entfernt.

Die API-Version für den angeforderten Vorgang.

Eigenschaft Wert
Standardwert: 2022-07-31
Zulässige Werte: 2022-07-31
--central-api-uri --central-dns-suffix

Das IoT Central DNS-Suffix, das Ihrer Anwendung zugeordnet ist.

Eigenschaft Wert
Standardwert: azureiotcentral.com
--token

Wenn Sie Ihre Anforderung lieber übermitteln möchten, ohne sich für die Azure CLI zu authentifizieren, können Sie ein gültiges Benutzertoken angeben, um Ihre Anforderung zu authentifizieren. Sie müssen den Schlüsseltyp als Teil der Anforderung angeben. Weitere Informationen finden Sie unter https://aka.ms/iotcentraldocsapi.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Output format.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False