Jobs - Create Scheduled Job

Dienst:
IoT Hub
API-Version:
2021-04-12

Erstellt einen neuen Auftrag zum Planen von Zwillingsupdates oder direkten Methoden auf dem 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" lautet.
jobId

string

Der eindeutige Bezeichner des Auftrags.
maxExecutionTimeInSeconds

integer (int64)

Die maximale Ausführungszeit in Secounds.
queryCondition

string

Die Bedingung für Geräte zum Ausführen des Auftrags. Dies ist erforderlich, wenn der Auftragstyp "updateTwin" oder "cloudToDeviceMethod" lautet.
startTime

string (date-time)

Das Startdatum und die Startzeit 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

OKAY.

Definitionen

Name Beschreibung
CloudToDeviceMethod

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

Der Status der auf dem Gerät aktivierten Funktionen.
DeviceJobStatistics

Die Auftragsstatistiken zum Ausführungsstatus.
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

Objekt

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

Name Typ Beschreibung
connectTimeoutInSeconds

integer (int32)

methodName

string

Der Name der auszuführenden Methode.
payload

object

Die JSON-formatierte direkte Methodennutzlast, bis zu 128 KB groß.
responseTimeoutInSeconds

integer (int32)

DeviceCapabilities

Objekt

Der Status der auf dem Gerät aktivierten Funktionen.

Name Typ Beschreibung
iotEdge

boolean

Die Eigenschaft, die bestimmt, ob das Gerät ein Edgegerät ist oder nicht.

DeviceJobStatistics

Objekt

Die Auftragsstatistiken zum Ausführungsstatus.

Name Typ Beschreibung
deviceCount

integer (int32)

Die Anzahl der Geräte, die auf den Auftrag ausgerichtet sind.
failedCount

integer (int32)

Die Anzahl der fehlgeschlagenen Aufträge.
pendingCount

integer (int32)

Die Anzahl der ausstehenden (geplanten) Aufträge.
runningCount

integer (int32)

Die Anzahl der ausgeführten Aufträge.
succeededCount

integer (int32)

Die Anzahl der erfolgreichen Aufträge.

JobRequest

Objekt
Name Typ Beschreibung
cloudToDeviceMethod

CloudToDeviceMethod

Der Methodentyp und die Parameter. Dies ist erforderlich, wenn der Auftragstyp "cloudToDeviceMethod" lautet.
jobId

string

Der eindeutige Bezeichner des Auftrags.
maxExecutionTimeInSeconds

integer (int64)

Die maximale Ausführungszeit in Secounds.
queryCondition

string

Die Bedingung für Geräte zum Ausführen des Auftrags. Dies ist erforderlich, wenn der Auftragstyp "updateTwin" oder "cloudToDeviceMethod" lautet.
startTime

string (date-time)

Das Startdatum und die Startzeit 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

Objekt
Name Typ Beschreibung
cloudToDeviceMethod

CloudToDeviceMethod

Der Methodentyp und die Parameter. Dies ist erforderlich, wenn der Auftragstyp "cloudToDeviceMethod" lautet.
createdTime

string (date-time)

Das System wurde generiert. Beim Erstellen ignoriert. Das Erstellungsdatum und die Uhrzeit des Auftrags.
deviceJobStatistics

DeviceJobStatistics

Die Details zum Auftragsausführungsstatus.
endTime

string (date-time)

Das System wurde generiert. Beim Erstellen ignoriert. Enddatum und -uhrzeit des Auftrags in UTC.
failureReason

string

Der Grund für den Fehler, wenn ein Fehler aufgetreten ist.
jobId

string

Das System wurde generiert. Beim Erstellen ignoriert. Der eindeutige Bezeichner des Auftrags.
maxExecutionTimeInSeconds

integer (int64)

Die maximale Ausführungszeit in Secounds.
queryCondition

string

Die Geräteabfragebedingung.
startTime

string (date-time)

Das Startdatum und die Uhrzeit des geplanten Auftrags in UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Das System wurde generiert. Beim Erstellen ignoriert. Der Status des Auftrags.
statusMessage

string

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

Objekt

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

Der Status der auf dem Gerät aktivierten Funktionen.
cloudToDeviceMessageCount

integer (int32)

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 Groß-/Kleinschreibung (bis zu 128 Zeichen) von ASCII-7-Bit-alphanumerischen Zeichen, und die folgenden Sonderzeichen {'-', ':', '.', '+', '%',_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}.
deviceScope

string

Der Bereich des Geräts.
etag

string

Die Zeichenfolge, die ein ETag für das Gerät Twin darstellt, gemäß RFC7232.
lastActivityTime

string (date-time)

Das Datum und die Uhrzeit, zu dem das Gerät zuletzt verbunden oder empfangen oder eine Nachricht gesendet hat. Das Datum und die Uhrzeit werden in ISO8601 Datums-/Uhrzeitformat 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 Groß-/Kleinschreibung (bis zu 128 Zeichen) von ASCII-7-Bit-alphanumerischen Zeichen, 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

Der aktivierte Status des Geräts. Wenn sie deaktiviert ist, kann das Gerät keine Verbindung mit dem Dienst herstellen.
statusReason

string

Der Grund für den aktuellen Status des Geräts, falls vorhanden.
statusUpdateTime

string (date-time)

Datum und Uhrzeit der letzten Aktualisierung des Geräts.
tags

object

Die Sammlung von Schlüssel-Wert-Paaren, die vom Back-End der Lösung gelesen und geschrieben werden. Sie sind für Geräte-Apps nicht sichtbar. Die Schlüssel sind UTF-8-codiert, groß- und up-to 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die Werte sind JSON-Objekte, up-to 4 KB länge.
version

integer (int64)

Die Version für das Gerät Twin einschließlich Tags und gewünschten Eigenschaften
x509Thumbprint

X509Thumbprint

Der X509-Fingerabdruck des Geräts.

TwinProperties

Objekt

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 Eigenschaftsschlüssel-Wert-Paare. Die Schlüssel sind UTF-8-codiert, groß- und up-to 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gewünschten Porpertywerte sind JSON-Objekte, up-to 4 KB lang.
reported

object

Die Auflistung der gemeldeten Eigenschaftsschlüssel-Wert-Paare. Die Schlüssel sind UTF-8-codiert, groß- und up-to 1 KB lang. Zulässige Zeichen schließen UNICODE-Steuerzeichen (Segmente C0 und C1), ".", "$" und Leerzeichen aus. Die gemeldeten Eigenschaftswerte sind JSON-Objekte, up-to 4 KB länge.

X509Thumbprint

Objekt
Name Typ Beschreibung
primaryThumbprint

string

Der primäre Fingerabdruck des X509-Clientzertifikats.
secondaryThumbprint

string

Sekundärer Fingerabdruck des X509-Clientzertifikats.