az iot hub 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 Hub-Auftrag Befehl ausführen. Learn more about extensions.

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

Befehle

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

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

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

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

Eigenschaft	Wert
Parameter group:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--hub-name -n

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

Eigenschaft	Wert
Parameter group:	IoT Hub Identifier Arguments

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

Eigenschaft	Wert
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

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

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 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 --jt {scheduleDeviceMethod, scheduleUpdateTwin}
                      [--auth-type {key, login}]
                      [--duration --poll-duration]
                      [--hub-name]
                      [--interval --poll-interval]
                      [--login]
                      [--mct --method-connect-timeout]
                      [--method-name --mn]
                      [--method-payload --mp]
                      [--method-response-timeout --mrt]
                      [--patch --twin-patch]
                      [--query-condition]
                      [--resource-group]
                      [--start --start-time]
                      [--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.

Eigenschaft	Wert
Zulässige Werte:	scheduleDeviceMethod, scheduleUpdateTwin

Optionale Parameter

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

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

Eigenschaft	Wert
Parameter group:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--duration --poll-duration

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

Eigenschaft	Wert
Standardwert:	600

--hub-name -n

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

Eigenschaft	Wert
Parameter group:	IoT Hub Identifier Arguments

--interval --poll-interval

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

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

Eigenschaft	Wert
Parameter group:	IoT Hub Identifier Arguments

--mct --method-connect-timeout

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

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

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

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

Eigenschaft	Wert
Standardwert:	False
Zulässige Werte:	false, true

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 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 --js {cancelled, completed, enqueued, failed, queued, running, scheduled, unknown}]
                    [--job-type --jt {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

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

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

Eigenschaft	Wert
Parameter group:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--hub-name -n

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

Eigenschaft	Wert
Parameter group:	IoT Hub Identifier Arguments

--job-status --js

Der Status eines geplanten Auftrags.

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

--job-type --jt

Der Typ des geplanten Auftrags.

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

Eigenschaft	Wert
Parameter group:	IoT Hub Identifier Arguments

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

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

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

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

Eigenschaft	Wert
Parameter group:	Access Control Arguments
Standardwert:	key
Zulässige Werte:	key, login

--hub-name -n

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

Eigenschaft	Wert
Parameter group:	IoT Hub Identifier Arguments

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

Eigenschaft	Wert
Parameter group:	IoT Hub Identifier Arguments

--resource-group -g

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

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