Jobs - Create Scheduled Job

Referenz

Dienst:: IoT Hub

API-Version:: 2021-04-12

Erstellt einen neuen Auftrag zum Planen von Zwillingsupdates oder direkten Methoden für die IoT Hub zu einem geplanten Zeitpunkt. Weitere Informationen finden Sie unter https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.

PUT https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}?api-version=2021-04-12

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	string	Der eindeutige Bezeichner des Auftrags.
api-version	query	True	string	Version der Api.

Anforderungstext

Name	Typ	Beschreibung
cloudToDeviceMethod	CloudToDeviceMethod	Der Methodentyp und die Parameter. Dies ist erforderlich, wenn der Auftragstyp cloudToDeviceMethod ist.
jobId	string	Der eindeutige Bezeichner des Auftrags.
maxExecutionTimeInSeconds	integer	Die maximale Ausführungszeit in Sekunden.
queryCondition	string	Die Bedingung für Geräte, die den Auftrag ausführen. Dies ist erforderlich, wenn der Auftragstyp updateTwin oder cloudToDeviceMethod lautet.
startTime	string	Das Startdatum und die Uhrzeit des Auftrags im ISO 8601-Standard.
type	enum: unknown export import backup readDeviceProperties writeDeviceProperties updateDeviceConfiguration rebootDevice factoryResetDevice firmwareUpdate scheduleDeviceMethod scheduleUpdateTwin restoreFromBackup failoverDataCopy	Der Auftragstyp.
updateTwin	Twin	Die Statusinformationen für ein Gerät oder Modul. Dies wird implizit erstellt und gelöscht, wenn die entsprechende Geräte-/Modulidentität im IoT Hub erstellt oder gelöscht wird.

Antworten

Name	Typ	Beschreibung
200 OK	JobResponse	OK.

Definitionen

Name	Beschreibung
CloudToDeviceMethod	Die Parameter zum Ausführen einer direkten Methode auf dem Gerät.
DeviceCapabilities	Die status von Funktionen, die auf dem Gerät aktiviert sind.
DeviceJobStatistics	Die Auftragsstatistiken zur Ausführung status.
JobRequest
JobResponse
Twin	Die Statusinformationen für ein Gerät oder Modul. Dies wird implizit erstellt und gelöscht, wenn die entsprechende Geräte-/Modulidentität im IoT Hub erstellt oder gelöscht wird.
TwinProperties	Die gewünschten und gemeldeten Eigenschaften des Zwillings. Die maximale Tiefe des Objekts beträgt 10.
X509Thumbprint

CloudToDeviceMethod

Die Parameter zum Ausführen einer direkten Methode auf dem Gerät.

Name	Typ	Beschreibung
connectTimeoutInSeconds	integer
methodName	string	Der Name der zu auszuführenden Methode.
payload	object	Die JSON-formatierte direkte Methodennutzlast mit einer Größe von bis zu 128 KB.
responseTimeoutInSeconds	integer

DeviceCapabilities

Die status von Funktionen, die auf dem Gerät aktiviert sind.

Name	Typ	Beschreibung
iotEdge	boolean	Die -Eigenschaft, die bestimmt, ob das Gerät ein Edgegerät ist oder nicht.

DeviceJobStatistics

Die Auftragsstatistiken zur Ausführung status.

Name	Typ	Beschreibung
deviceCount	integer	Die Anzahl der Geräte, auf die der Auftrag abzielt.
failedCount	integer	Die Anzahl der fehlgeschlagenen Aufträge.
pendingCount	integer	Die Anzahl der ausstehenden (geplanten) Aufträge.
runningCount	integer	Die Anzahl der ausgeführten Aufträge.
succeededCount	integer	Die Anzahl der erfolgreichen Aufträge.

JobRequest

Name	Typ	Beschreibung
cloudToDeviceMethod	CloudToDeviceMethod	Der Methodentyp und die Parameter. Dies ist erforderlich, wenn der Auftragstyp cloudToDeviceMethod ist.
jobId	string	Der eindeutige Bezeichner des Auftrags.
maxExecutionTimeInSeconds	integer	Die maximale Ausführungszeit in Sekunden.
queryCondition	string	Die Bedingung für Geräte, die den Auftrag ausführen. Dies ist erforderlich, wenn der Auftragstyp updateTwin oder cloudToDeviceMethod lautet.
startTime	string	Das Startdatum und die Uhrzeit des Auftrags im ISO 8601-Standard.
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	Der Auftragstyp.
updateTwin	Twin	Die Statusinformationen für ein Gerät oder Modul. Dies wird implizit erstellt und gelöscht, wenn die entsprechende Geräte-/Modulidentität im IoT Hub erstellt oder gelöscht wird.

JobResponse

Name	Typ	Beschreibung
cloudToDeviceMethod	CloudToDeviceMethod	Der Methodentyp und die Parameter. Dies ist erforderlich, wenn der Auftragstyp cloudToDeviceMethod ist.
createdTime	string	System generiert. Wird bei der Erstellung ignoriert. Das Erstellungsdatum und die Uhrzeit des Auftrags.
deviceJobStatistics	DeviceJobStatistics	Die Details zur Auftragsausführung status.
endTime	string	System generiert. Wird bei der Erstellung ignoriert. Das Enddatum und die Uhrzeit des Auftrags in UTC.
failureReason	string	Der Grund für den Fehler, wenn ein Fehler aufgetreten ist.
jobId	string	System generiert. Wird bei der Erstellung ignoriert. Der eindeutige Bezeichner des Auftrags.
maxExecutionTimeInSeconds	integer	Die maximale Ausführungszeit in Sekunden.
queryCondition	string	Die Geräteabfragebedingung.
startTime	string	Startdatum und -uhrzeit des geplanten Auftrags in UTC.
status	enum: cancelled completed enqueued failed queued running scheduled unknown	System generiert. Wird bei der Erstellung ignoriert. Der Status des Auftrags.
statusMessage	string	Die status Meldung des Auftrags.
type	enum: backup export factoryResetDevice failoverDataCopy firmwareUpdate import readDeviceProperties rebootDevice restoreFromBackup scheduleDeviceMethod scheduleUpdateTwin unknown updateDeviceConfiguration writeDeviceProperties	Der Auftragstyp.
updateTwin	Twin	Die Statusinformationen für ein Gerät oder Modul. Dies wird implizit erstellt und gelöscht, wenn die entsprechende Geräte-/Modulidentität im IoT Hub erstellt oder gelöscht wird.

Twin

Die Statusinformationen für ein Gerät oder Modul. Dies wird implizit erstellt und gelöscht, wenn die entsprechende Geräte-/Modulidentität im IoT Hub erstellt oder gelöscht wird.

Name	Typ	Beschreibung
authenticationType	enum: certificateAuthority none sas selfSigned	Der vom Gerät verwendete Authentifizierungstyp.
capabilities	DeviceCapabilities	Die status von Funktionen, die auf dem Gerät aktiviert sind.
cloudToDeviceMessageCount	integer	Die Anzahl der gesendeten Cloud-zu-Gerät-Nachrichten.
connectionState	enum: Connected Disconnected	Der Verbindungsstatus des Geräts.
deviceEtag	string	Die Zeichenfolge, die ein ETag für das Gerät gemäß RFC7232 darstellt.
deviceId	string	Der eindeutige Bezeichner des Geräts in der Identitätsregistrierung des IoT Hub. Dabei handelt es sich um eine Zeichenfolge mit 7-Bit-Alphanumerischen ASCII-Zeichen (bis zu 128 Zeichen lang), wobei die Groß-/Kleinschreibung beachtet wird. und die folgenden Sonderzeichen {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}.
deviceScope	string	Der Bereich des Geräts.
etag	string	Die Zeichenfolge, die gemäß RFC7232 ein ETag für den Gerätezwilligen darstellt.
lastActivityTime	string	Das Datum und die Uhrzeit, zu dem das Gerät zuletzt eine Nachricht hergestellt oder empfangen oder gesendet hat. Datum und Uhrzeit werden in ISO8601 datetime-Format in UTC angegeben, z. B. 2015-01-28T16:24:48.789Z. Dieser Wert wird nicht aktualisiert, wenn das Gerät das HTTP/1-Protokoll zum Ausführen von Messagingvorgängen verwendet.
moduleId	string	Der eindeutige Bezeichner des Moduls in der Identitätsregistrierung des IoT Hub. Dabei handelt es sich um eine Zeichenfolge mit 7-Bit-Alphanumerischen ASCII-Zeichen (bis zu 128 Zeichen lang), wobei die Groß-/Kleinschreibung beachtet wird. und die folgenden Sonderzeichen {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}.
parentScopes	string[]	Die Bereiche der Edgegeräte der oberen Ebene, falls zutreffend. Nur für Edgegeräte verfügbar.
properties	TwinProperties	Die gewünschten und gemeldeten Eigenschaften des Zwillings.
status	enum: disabled enabled	Die aktivierte status des Geräts. Wenn er deaktiviert ist, kann das Gerät keine Verbindung mit dem Dienst herstellen.
statusReason	string	Der Grund für die aktuelle status des Geräts, falls vorhanden.
statusUpdateTime	string	Das Datum und die Uhrzeit der letzten Aktualisierung des status des Geräts.
tags	object	Die Auflistung von Schlüssel-Wert-Paaren, die vom Lösungs-Back-End gelesen und geschrieben werden. Sie sind für Geräte-Apps nicht sichtbar. Sie sind UTF-8-codiert, beachten Groß-/Kleinschreibung und eine Länge von bis zu 1 KB. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die Werte sind JSON-Objekte mit einer Länge von bis zu 4 KB.
version	integer	Die Version für den Gerätezwillen, einschließlich Tags und gewünschten Eigenschaften
x509Thumbprint	X509Thumbprint	Der X509-Fingerabdruck des Geräts.

TwinProperties

Die gewünschten und gemeldeten Eigenschaften des Zwillings. Die maximale Tiefe des Objekts beträgt 10.

Name	Typ	Beschreibung
desired	object	Die Auflistung der gewünschten Schlüssel-Wert-Paare der Eigenschaft. Die Schlüssel sind UTF-8-codiert, beachten Groß-/Kleinschreibung und eine Länge von bis zu 1 KB. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gewünschten Porpertywerte sind JSON-Objekte mit einer Länge von bis zu 4 KB.
reported	object	Die Auflistung der gemeldeten Eigenschafts-Schlüssel-Wert-Paare. Die Schlüssel sind UTF-8-codiert, beachten Groß-/Kleinschreibung und eine Länge von bis zu 1 KB. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gemeldeten Eigenschaftswerte sind JSON-Objekte mit einer Länge von bis zu 4 KB.

X509Thumbprint

Name	Typ	Beschreibung
primaryThumbprint	string	Primärer Fingerabdruck des X509-Clientzertifikats.
secondaryThumbprint	string	Sekundärer Fingerabdruck des X509-Clientzertifikats.

Freigeben über