az iot hub job

Hinweis

Dieser Verweis ist Teil der Azure-iot-Erweiterung für die Azure CLI (Version 2.30.0 oder höher). Die Erweiterung wird beim ersten Ausführen eines Az iot Hub-Auftragsbefehls automatisch installiert. Weitere Informationen zu Erweiterungen

Verwalten von IoT Hub Aufträgen (v2).

Befehle

az iot hub job cancel	Abbrechen eines IoT Hub Auftrags.
az iot hub job create	Erstellen und Planen eines IoT Hub Auftrags für die Ausführung.
az iot hub job list	Listet die historischen Aufträge eines IoT Hub auf.
az iot hub job show	Zeigen Sie Details eines vorhandenen IoT Hub Auftrags an.

az iot hub job cancel

Abbrechen eines IoT Hub Auftrags.

az iot hub job cancel --job-id
                      [--auth-type {key, login}]
                      [--hub-name]
                      [--login]
                      [--resource-group]

Beispiele

Abbrechen eines IoT Hub Auftrags.

az iot hub job cancel --hub-name {iothub_name} --job-id {job_id}

Erforderliche Parameter

--job-id

IoT Hub Auftrags-ID.

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch abgeleitet oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe az configure --defaults iothub-data-auth-type=<auth-type-value>von .

Zulässige Werte: key, login

Standardwert: key

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name bereitgestellt werden, wird die Verbindungszeichenfolge vorrangig verwendet. Erforderlich, wenn --hub-name nicht bereitgestellt wird.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

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.

--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 hub job create

Erstellen und Planen eines IoT Hub Auftrags für die Ausführung.

Beim Planen eines Zwillingsupdateauftrags ist der Twin-Patch ein erforderliches Argument. Beim Planen eines Gerätemethodeauftrags sind der Methodenname und die Nutzlast erforderliche Argumente. BITTE BEACHTEN SIE: Die Verwendung einer benutzerdefinierten Startzeit, die sich in der Vergangenheit befindet, kann dazu führen, dass der Vorgang fehlschlägt.

az iot hub job create --job-id
                      --job-type {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration]
                      [--hub-name]
                      [--interval]
                      [--login]
                      [--mct]
                      [--method-name]
                      [--method-payload]
                      [--method-response-timeout]
                      [--patch]
                      [--query-condition]
                      [--resource-group]
                      [--start]
                      [--ttl]
                      [--wait {false, true}]

Beispiele

Erstellen und planen Sie einen Auftrag, um die Twintags aller Geräte zu aktualisieren.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}'

Terminauftrag planen und blockieren, um das Ergebnis von "abgeschlossen", "fehlgeschlagen" oder "abgebrochen" zu haben. Geben Sie das Abfrageintervall in Sekunden an.

az iot hub job create --job-id {job_id} --job-type scheduleUpdateTwin -n {iothub_name} -q "*" --twin-patch '{"tags": {"deviceType": "Type1, Type2, Type3"}}' --wait --poll-interval 30

Erstellen Sie einen Auftrag, um eine gewünschte Twin-Eigenschaft auf einer Teilmenge von Geräten zu aktualisieren, die für eine beliebige zukünftige Zeit geplant sind.

az iot hub job create --job-id {job_name} --job-type scheduleUpdateTwin -n {iothub_name} --twin-patch '{"properties":{"desired": {"temperatureF": 65}}}' --start-time "2050-01-08T12:19:56.868Z" --query-condition "deviceId IN ['MyDevice1', 'MyDevice2', 'MyDevice3']"

Erstellen und Planen eines Auftrags zum Aufrufen einer Gerätemethode für eine Gruppe von Geräten, die eine Abfragebedingung erfüllen.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -n {iothub_name} --method-name setSyncIntervalSec --method-payload 30 --query-condition "properties.reported.settings.syncIntervalSec != 30"

Erstellen und Planen eines Auftrags zum Aufrufen einer Gerätemethode für alle Geräte.

az iot hub job create --job-id {job_name} --job-type scheduleDeviceMethod -q "*" -n {iothub_name} --method-name setSyncIntervalSec --method-payload '{"version":"1.0"}'

Erforderliche Parameter

--job-id

IoT Hub Auftrags-ID.

--job-type --jt

Der Typ des geplanten Auftrags.

Zulässige Werte: scheduleDeviceMethod, scheduleUpdateTwin

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch abgeleitet oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe az configure --defaults iothub-data-auth-type=<auth-type-value>von .

Zulässige Werte: key, login

Standardwert: key

--duration --poll-duration

Gesamtdauer in Sekunden, in der der Auftragsstatus überprüft wird, wenn --warten-Flag übergeben wird.

Standardwert: 600

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--interval --poll-interval

Intervall in Sekunden, in denen der Auftragsstatus überprüft wird, wenn --Warten-Flag übergeben wird.

Standardwert: 10

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name bereitgestellt werden, wird die Verbindungszeichenfolge vorrangig verwendet. Erforderlich, wenn --hub-name nicht bereitgestellt wird.

--mct --method-connect-timeout

Maximale Anzahl von Sekunden, die auf die Geräteverbindung warten.

Standardwert: 30

--method-name --mn

Zielmethode für Aufrufe.

--method-payload --mp

Json-Nutzlast, die an die Methode übergeben werden soll. Muss Dateipfad oder unformatierte JSON sein.

--method-response-timeout --mrt

Maximale Anzahl von Sekunden, die auf das Ergebnis der Gerätemethode warten.

Standardwert: 30

--patch --twin-patch

Der gewünschte Zwillingspatch. Geben Sie Dateipfad oder unformatierte JSON an.

--query-condition -q

Bedingung für die Geräteabfrage, um Geräte zum Ausführen des Auftrags abzurufen. Erforderlich, wenn der Auftragstyp "scheduleDeviceMethod" oder "scheduleUpdateTwin" ist. Hinweis: Der Dienst präfix "SELECT * FROM devices WHERE " to the input.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--start --start-time

Der geplante Start des Auftrags im Datumsformat ISO 8601. Wenn keine Startzeit bereitgestellt wird, wird der Auftrag für die Asap-Ausführung in die Warteschlange gestellt. Die Verwendung einer benutzerdefinierten Startzeit, die sich in der Vergangenheit befindet, kann dazu führen, dass der Vorgang fehlschlägt.

--ttl

Maximale Ausführungszeit in Sekunden, bevor der Auftrag beendet wird.

Standardwert: 3600

--wait -w

Blockieren Sie, bis sich der erstellte Auftrag in einem abgeschlossenen, fehlgeschlagenen oder abgebrochenen Zustand befindet. Wird regelmäßig nach --poll-Intervall angegebenen Intervallen abfragen.

Zulässige Werte: false, true

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.

--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 hub job list

Listet die historischen Aufträge eines IoT Hub auf.

az iot hub job list [--auth-type {key, login}]
                    [--hub-name]
                    [--job-status {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type {export, import, scheduleDeviceMethod, scheduleUpdateTwin}]
                    [--login]
                    [--resource-group]
                    [--top]

Beispiele

Listet alle archivierten Aufträge innerhalb des Aufbewahrungszeitraums auf (max. 30 Tage).

az iot hub job list --hub-name {iothub_name}

Alle archivierten Aufträge auflisten, die bestimmte Eigenschaften projizieren

az iot hub job list --hub-name {iothub_name} --query "[*].[jobId,type,status,startTime,endTime]"

Nur Zweitypaufträge auflisten

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod

Listen von Gerätemethodenaufträgen, die den Status "geplant" haben

az iot hub job list --hub-name {iothub_name} --job-type scheduleDeviceMethod --job-status scheduled

Auflisten von Geräteexportaufträgen, die den Status "abgeschlossen" haben

az iot hub job list --hub-name {iothub_name} --job-type export --job-status completed

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch abgeleitet oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe az configure --defaults iothub-data-auth-type=<auth-type-value>von .

Zulässige Werte: key, login

Standardwert: key

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--job-status --js

Der Status eines geplanten Auftrags.

Zulässige Werte: cancelled, completed, enqueued, failed, queued, running, scheduled, unknown

--job-type --jt

Der Typ des geplanten Auftrags.

Zulässige Werte: export, import, scheduleDeviceMethod, scheduleUpdateTwin

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name bereitgestellt werden, wird die Verbindungszeichenfolge vorrangig verwendet. Erforderlich, wenn --hub-name nicht bereitgestellt wird.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--top

Maximale Anzahl von Elementen, die zurückgegeben werden sollen. Verwenden Sie -1 für unbegrenzte Zeit.

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.

--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 hub job show

Zeigen Sie Details eines vorhandenen IoT Hub Auftrags an.

az iot hub job show --job-id
                    [--auth-type {key, login}]
                    [--hub-name]
                    [--login]
                    [--resource-group]

Beispiele

Zeigen Sie die Details eines erstellten Auftrags an.

az iot hub job show --hub-name {iothub_name} --job-id {job_id}

Erforderliche Parameter

--job-id

IoT Hub Auftrags-ID.

Optionale Parameter

--auth-type

Gibt an, ob der Vorgang einen Richtlinienschlüssel automatisch abgeleitet oder die aktuelle Azure AD-Sitzung verwenden soll. Sie können die Standardeinstellung mithilfe az configure --defaults iothub-data-auth-type=<auth-type-value>von .

Zulässige Werte: key, login

Standardwert: key

--hub-name -n

IoT Hub Name. Erforderlich, wenn die Anmeldung nicht bereitgestellt wird.

--login -l

Dieser Befehl unterstützt eine Entitätsverbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Verwenden Sie die Verwendung, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entitätsverbindungszeichenfolge als auch ein Name bereitgestellt werden, wird die Verbindungszeichenfolge vorrangig verwendet. Erforderlich, wenn --hub-name nicht bereitgestellt wird.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

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.

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