az iot hub job

  • Referenz

Hinweis

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

Verwalten von IoT Hub-Aufträgen (v2).

Befehle

Name Beschreibung Typ Status
az iot hub job cancel

Abbrechen eines IoT Hub-Auftrags.

 Durchwahl Allgemein verfügbar
az iot hub job create

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

 Durchwahl Allgemein verfügbar
az iot hub job list

Listet die historischen Aufträge eines IoT Hub auf.

 Durchwahl Allgemein verfügbar
az iot hub job show

Zeigen Sie Details eines vorhandenen IoT Hub-Auftrags an.

 Durchwahl Allgemein verfügbar

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 ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Wenn der Authentifizierungstyp login ist und der Ressourcenhost bereitgestellt wird, wird die Ressourcensuche übersprungen, es sei denn, dies ist erforderlich. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type=<auth-type-value>.

Zulässige Werte: key, login
Standardwert: key
--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--login -l

Dieser Befehl unterstützt eine Entität Verbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Wird verwendet, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben 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.

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

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

Bei der Planung eines Zwillingsupdateauftrags ist der Twin-Patch ein erforderliches Argument. Beim Planen eines Gerätemethodenauftrags sind der Methodenname und die Nutzlast erforderliche Argumente. HINWEIS: 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 Zwillingstags 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"}}'

Auftrag planen und blockieren für Das Ergebnis von "abgeschlossen", "fehlgeschlagen" oder "abgebrochen". Geben Sie das Abrufintervall 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 Zwillingseigenschaft auf einer Teilmenge von Geräten zu aktualisieren, die für die Ausführung zu einem beliebigen zukünftigen Zeitpunkt geplant ist.

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 Sie einen Auftrag, um eine Gerätemethode für eine Gruppe von Geräten aufzurufen, 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 Sie einen Auftrag, um eine Gerätemethode für alle Geräte aufzurufen.

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 ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Wenn der Authentifizierungstyp login ist und der Ressourcenhost bereitgestellt wird, wird die Ressourcensuche übersprungen, es sei denn, dies ist erforderlich. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type=<auth-type-value>.

Zulässige Werte: key, login
Standardwert: key
--duration --poll-duration

Gesamtdauer in Sekunden, in der der Auftragsstatus überprüft wird, wenn das Flag "-wait" übergeben wird.

Standardwert: 600
--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--interval --poll-interval

Das Intervall in Sekunden, in dem der Auftragsstatus überprüft wird, wenn das Flag "-wait" übergeben wird.

Standardwert: 10
--login -l

Dieser Befehl unterstützt eine Entität Verbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Wird verwendet, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben wird.

--mct --method-connect-timeout

Maximale Anzahl von Sekunden, die bei der Geräteverbindung gewartet werden sollen.

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, um auf das Ergebnis der Gerätemethode zu warten.

Standardwert: 30
--patch --twin-patch

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

--query-condition -q

Bedingung für Geräteabfrage zum Abrufen von Geräten zum Ausführen des Auftrags. Erforderlich, wenn der Auftragstyp "scheduleDeviceMethod" oder "scheduleUpdateTwin" lautet. Hinweis: Der Dienst präfix "SELECT * FROM devices WHERE" wird der Eingabe vorangestellt.

--resource-group -g

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

--start --start-time

Der geplante Anfang des Auftrags im ISO 8601-Datums-/Uhrzeitformat. Wenn keine Startzeit angegeben wird, wird der Auftrag für die Asap-Ausführung in die Warteschlange gestellt. Die Verwendung einer benutzerdefinierten Startzeit, die in der Vergangenheit liegt, 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, bis sich der erstellte Auftrag in einem abgeschlossenen, fehlgeschlagenen oder abgebrochenen Zustand befindet. Fragt regelmäßig nach Intervallen ab, die durch "--poll-interval" angegeben sind.

Zulässige Werte: false, true
Standardwert: False
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 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

Alle archivierten Aufträge innerhalb des Aufbewahrungszeitraums auflisten (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 Aktualisieren von Twin-Typ-Aufträgen auflisten

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

Auflisten von Gerätemethodenaufträgen mit status "geplant"

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

Auflisten von Geräteexportaufträgen mit status "abgeschlossen"

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 ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Wenn der Authentifizierungstyp login ist und der Ressourcenhost bereitgestellt wird, wird die Ressourcensuche übersprungen, es sei denn, dies ist erforderlich. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type=<auth-type-value>.

Zulässige Werte: key, login
Standardwert: key
--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben 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ät Verbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Wird verwendet, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben wird.

--resource-group -g

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

--top

Maximale Anzahl der zurückzugebenden Elemente. Verwenden Sie -1 für unbegrenzt.

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 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 ableiten oder die aktuelle Azure AD-Sitzung verwenden soll. Wenn der Authentifizierungstyp login ist und der Ressourcenhost bereitgestellt wird, wird die Ressourcensuche übersprungen, es sei denn, dies ist erforderlich. Sie können die Standardeinstellung mithilfe von az configure --defaults iothub-data-auth-type=<auth-type-value>.

Zulässige Werte: key, login
Standardwert: key
--hub-name -n

IoT Hub-Name oder Hostname. Erforderlich, wenn --login nicht angegeben wird.

--login -l

Dieser Befehl unterstützt eine Entität Verbindungszeichenfolge mit Rechten zum Ausführen von Aktionen. Wird verwendet, um die Sitzungsanmeldung über "az login" zu vermeiden. Wenn sowohl eine Entität Verbindungszeichenfolge als auch ein Name angegeben werden, hat die Verbindungszeichenfolge Vorrang. Erforderlich, wenn --hub-name nicht angegeben 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.

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.