az iot central job

Hinweis

Diese Referenz ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.46.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen zentralen Az iot-Auftragsbefehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen

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	Erweiterung	Allgemein verfügbar
az iot central job get-devices	Abrufen von Auftragsgerätestatus.	Erweiterung	Allgemein verfügbar
az iot central job list	Ruft die Liste der Aufträge für eine IoT Central-Anwendung ab.	Erweiterung	Allgemein verfügbar
az iot central job rerun	Führen Sie einen Auftrag auf allen fehlgeschlagenen Geräten erneut aus.	Erweiterung	Allgemein verfügbar
az iot central job resume	Fortsetzen eines angehaltenen Auftrags.	Erweiterung	Allgemein verfügbar
az iot central job show	Rufen Sie die Details eines Auftrags nach ID ab.	Erweiterung	Allgemein verfügbar
az iot central job stop	Beenden Eines ausgeführten Auftrags.	Erweiterung	Allgemein verfügbar

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 {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]

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:[{}]. 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

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

Zulässige Werte: 2022-07-31

Standardwert: 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.

Zulässige Werte: number, percentage

Standardwert: number

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

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.

Zulässige Werte: number, percentage

Standardwert: number

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

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

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central job get-devices

Abrufen von Auftragsgerätestatus.

az iot central job get-devices --app-id
                               --job-id
                               [--api-version {2022-07-31}]
                               [--central-api-uri]
                               [--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

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

Zulässige Werte: 2022-07-31

Standardwert: 2022-07-31

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

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

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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 {2022-07-31}]
                        [--central-api-uri]
                        [--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

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

Zulässige Werte: 2022-07-31

Standardwert: 2022-07-31

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

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

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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 {2022-07-31}]
                         [--central-api-uri]
                         [--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

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

Zulässige Werte: 2022-07-31

Standardwert: 2022-07-31

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

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

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central job resume

Fortsetzen eines angehaltenen Auftrags.

az iot central job resume --app-id
                          --job-id
                          [--api-version {2022-07-31}]
                          [--central-api-uri]
                          [--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

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

Zulässige Werte: 2022-07-31

Standardwert: 2022-07-31

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

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

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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 {2022-07-31}]
                        [--central-api-uri]
                        [--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

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

Zulässige Werte: 2022-07-31

Standardwert: 2022-07-31

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

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

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az iot central job stop

Beenden Eines ausgeführten Auftrags.

az iot central job stop --app-id
                        --job-id
                        [--api-version {2022-07-31}]
                        [--central-api-uri]
                        [--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

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

Zulässige Werte: 2022-07-31

Standardwert: 2022-07-31

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

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

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc

Standardwert: json

--query

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.