Jobs - Create Scheduled Job

  • Odwołanie
Service:
IoT Hub
API Version:
2021-04-12

Tworzy nowe zadanie, aby zaplanować aktualizacje reprezentacji bliźniaczej lub metody bezpośrednie na IoT Hub w zaplanowanym czasie. Aby uzyskać więcej informacji, zobacz 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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
id
 path True

string

Unikatowy identyfikator zadania.
api-version
 query True

string

Wersja interfejsu API.

Treść żądania

Nazwa Typ Opis
cloudToDeviceMethod

CloudToDeviceMethod

Typ metody i parametry. Jest to wymagane, jeśli typ zadania to cloudToDeviceMethod.
jobId

string

Unikatowy identyfikator zadania.
maxExecutionTimeInSeconds

integer

Maksymalny czas wykonywania w sekundach.
queryCondition

string

Warunek wykonania zadania przez urządzenia. Jest to wymagane, jeśli typ zadania to updateTwin lub cloudToDeviceMethod.
startTime

string

Data i godzina rozpoczęcia zadania w standardzie ISO 8601.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

Typ zadania.
updateTwin

Twin

Informacje o stanie urządzenia lub modułu. Jest to tworzone i usuwane niejawnie po utworzeniu lub usunięciu odpowiedniej tożsamości urządzenia/modułu w IoT Hub.

Odpowiedzi

Nazwa Typ Opis
200 OK

JobResponse

OK.

Definicje

Nazwa Opis
CloudToDeviceMethod

Parametry do wykonania metody bezpośredniej na urządzeniu.
DeviceCapabilities

Stan możliwości włączonych na urządzeniu.
DeviceJobStatistics

Statystyki zadania dotyczące stanu wykonania.
JobRequest
JobResponse
Twin

Informacje o stanie urządzenia lub modułu. Jest to tworzone i usuwane niejawnie po utworzeniu lub usunięciu odpowiedniej tożsamości urządzenia/modułu w IoT Hub.
TwinProperties

Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej. Maksymalna głębokość obiektu wynosi 10.
X509Thumbprint

CloudToDeviceMethod

Parametry do wykonania metody bezpośredniej na urządzeniu.

Nazwa Typ Opis
connectTimeoutInSeconds

integer

methodName

string

Nazwa metody do wykonania.
payload

object

Ładunek metody bezpośredniej sformatowany w formacie JSON o rozmiarze do 128 kb.
responseTimeoutInSeconds

integer

DeviceCapabilities

Stan możliwości włączonych na urządzeniu.

Nazwa Typ Opis
iotEdge

boolean

Właściwość określająca, czy urządzenie jest urządzeniem brzegowym, czy nie.

DeviceJobStatistics

Statystyki zadania dotyczące stanu wykonania.

Nazwa Typ Opis
deviceCount

integer

Liczba urządzeń objętych zadaniem.
failedCount

integer

Liczba zadań zakończonych niepowodzeniem.
pendingCount

integer

Liczba oczekujących (zaplanowanych) zadań.
runningCount

integer

Liczba uruchomionych zadań.
succeededCount

integer

Liczba zakończonych pomyślnie zadań.

JobRequest

Nazwa Typ Opis
cloudToDeviceMethod

CloudToDeviceMethod

Typ metody i parametry. Jest to wymagane, jeśli typ zadania to cloudToDeviceMethod.
jobId

string

Unikatowy identyfikator zadania.
maxExecutionTimeInSeconds

integer

Maksymalny czas wykonywania w sekundach.
queryCondition

string

Warunek wykonania zadania przez urządzenia. Jest to wymagane, jeśli typ zadania to updateTwin lub cloudToDeviceMethod.
startTime

string

Data i godzina rozpoczęcia zadania w standardzie ISO 8601.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Typ zadania.
updateTwin

Twin

Informacje o stanie urządzenia lub modułu. Jest to tworzone i usuwane niejawnie po utworzeniu lub usunięciu odpowiedniej tożsamości urządzenia/modułu w IoT Hub.

JobResponse

Nazwa Typ Opis
cloudToDeviceMethod

CloudToDeviceMethod

Typ metody i parametry. Jest to wymagane, jeśli typ zadania to cloudToDeviceMethod.
createdTime

string

Wygenerowany system. Ignorowane podczas tworzenia. Data i godzina utworzenia zadania.
deviceJobStatistics

DeviceJobStatistics

Szczegóły dotyczące stanu wykonywania zadania.
endTime

string

Wygenerowany system. Ignorowane podczas tworzenia. Data i godzina zakończenia zadania w formacie UTC.
failureReason

string

Przyczyna błędu, jeśli wystąpił błąd.
jobId

string

Wygenerowany system. Ignorowane podczas tworzenia. Unikatowy identyfikator zadania.
maxExecutionTimeInSeconds

integer

Maksymalny czas wykonywania w sekundach.
queryCondition

string

Warunek zapytania urządzenia.
startTime

string

Data i godzina rozpoczęcia zaplanowanego zadania w formacie UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Wygenerowany system. Ignorowane podczas tworzenia. Stan zadania.
statusMessage

string

Komunikat o stanie zadania.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Typ zadania.
updateTwin

Twin

Informacje o stanie urządzenia lub modułu. Jest to tworzone i usuwane niejawnie po utworzeniu lub usunięciu odpowiedniej tożsamości urządzenia/modułu w IoT Hub.

Twin

Informacje o stanie urządzenia lub modułu. Jest to tworzone i usuwane niejawnie po utworzeniu lub usunięciu odpowiedniej tożsamości urządzenia/modułu w IoT Hub.

Nazwa Typ Opis
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Typ uwierzytelniania używany przez urządzenie.
capabilities

DeviceCapabilities

Stan możliwości włączonych na urządzeniu.
cloudToDeviceMessageCount

integer

Liczba wysłanych komunikatów z chmury do urządzenia.
connectionState enum:
  • Connected
  • Disconnected

Stan połączenia urządzenia.
deviceEtag

string

Ciąg reprezentujący element ETag dla urządzenia zgodnie z RFC7232.
deviceId

string

Unikatowy identyfikator urządzenia w rejestrze tożsamości IoT Hub. Jest to ciąg uwzględniający wielkość liter (do 128 znaków długości) znaków alfanumerycznych ASCII 7-bitowych, i następujące znaki specjalne {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}.
deviceScope

string

Zakres urządzenia.
etag

string

Ciąg reprezentujący element ETag dla bliźniaczej reprezentacji urządzenia zgodnie z RFC7232.
lastActivityTime

string

Data i godzina ostatniego połączenia lub odebrania lub wysłania komunikatu przez urządzenie. Data i godzina są oddzielone ISO8601 formacie data/godzina w formacie UTC, na przykład 2015-01-28T16:24:48.789Z. Ta wartość nie jest aktualizowana, jeśli urządzenie używa protokołu HTTP/1 do wykonywania operacji obsługi komunikatów.
moduleId

string

Unikatowy identyfikator modułu w rejestrze tożsamości IoT Hub. Jest to ciąg uwzględniający wielkość liter (do 128 znaków długości) znaków alfanumerycznych ASCII 7-bitowych, i następujące znaki specjalne {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}.
parentScopes

string[]

Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Dostępne tylko dla urządzeń brzegowych.
properties

TwinProperties

Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej.
status enum:
  • disabled
  • enabled

Stan włączonego urządzenia. Jeśli to ustawienie jest wyłączone, urządzenie nie może nawiązać połączenia z usługą.
statusReason

string

Przyczyna bieżącego stanu urządzenia, jeśli istnieje.
statusUpdateTime

string

Data i godzina ostatniej aktualizacji stanu urządzenia.
tags

object

Kolekcja par klucz-wartość odczytanych i zapisywanych przez zaplecze rozwiązania. Nie są one widoczne dla aplikacji urządzeń. Klucze są zakodowane w formacie UTF-8, z uwzględnieniem wielkości liter i długości do 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), ".", "$" i spację. Wartości to obiekty JSON o długości do 4 KB.
version

integer

Wersja bliźniaczej reprezentacji urządzenia, w tym tagi i żądane właściwości
x509Thumbprint

X509Thumbprint

Odcisk palca X509 urządzenia.

TwinProperties

Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej. Maksymalna głębokość obiektu wynosi 10.

Nazwa Typ Opis
desired

object

Kolekcja par klucz-wartość żądanej właściwości. Klucze są zakodowane w formacie UTF-8, z uwzględnieniem wielkości liter i długości do 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), ".", "$" i spację. Żądane wartości porperty to obiekty JSON o długości do 4 KB.
reported

object

Kolekcja zgłoszonych par klucz-wartość właściwości. Klucze są zakodowane w formacie UTF-8, z uwzględnieniem wielkości liter i długości do 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), ".", "$" i spację. Zgłoszone wartości właściwości to obiekty JSON o długości do 4 KB.

X509Thumbprint

Nazwa Typ Opis
primaryThumbprint

string

Podstawowy odcisk palca certyfikatu klienta X509.
secondaryThumbprint

string

Pomocniczy odcisk palca certyfikatu klienta X509.