Sdílet prostřednictvím

Jobs - Create Scheduled Job

  • Reference
Služba:
IoT Hub
Verze rozhraní API:
2021-04-12

Vytvoří novou úlohu pro naplánování aktualizací dvojčat nebo přímých metod na IoT Hub v naplánovaném čase. Další informace naleznete v tématu 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 identifikátoru URI

Name V Vyžadováno Typ Description
id
 path True

string

Jedinečný identifikátor úlohy.
api-version
 query True

string

Verze rozhraní API.

Text požadavku

Name Typ Description
cloudToDeviceMethod

CloudToDeviceMethod

Typ metody a parametry. To je povinné, pokud je typ úlohy cloudToDeviceMethod.
jobId

string

Jedinečný identifikátor úlohy.
maxExecutionTimeInSeconds

integer

Maximální doba provádění v secounds.
queryCondition

string

Podmínka, aby zařízení spustila úlohu. To je povinné, pokud je typ úlohy updateTwin nebo cloudToDeviceMethod.
startTime

string

Datum a čas zahájení úlohy ve standardu ISO 8601.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

Typ úlohy.
updateTwin

Twin

Informace o stavu zařízení nebo modulu Ten se implicitně vytvoří a odstraní při vytvoření nebo odstranění odpovídající identity zařízení nebo modulu v IoT Hub.

Odpovědi

Name Typ Description
200 OK

JobResponse

OK.

Definice

Name Description
CloudToDeviceMethod

Parametry pro spuštění přímé metody na zařízení.
DeviceCapabilities

Stav funkcí povolených na zařízení.
DeviceJobStatistics

Statistika úlohy týkající se stavu spuštění.
JobRequest
JobResponse
Twin

Informace o stavu zařízení nebo modulu Ten se implicitně vytvoří a odstraní při vytvoření nebo odstranění odpovídající identity zařízení nebo modulu v IoT Hub.
TwinProperties

Požadované a hlášené vlastnosti dvojčete. Maximální hloubka objektu je 10.
X509Thumbprint

CloudToDeviceMethod

Parametry pro spuštění přímé metody na zařízení.

Name Typ Description
connectTimeoutInSeconds

integer

methodName

string

Název metody, která se má provést.
payload

object

Datová část přímé metody ve formátu JSON o velikosti až 128 kB
responseTimeoutInSeconds

integer

DeviceCapabilities

Stav funkcí povolených na zařízení.

Name Typ Description
iotEdge

boolean

Vlastnost, která určuje, jestli je zařízení hraničním zařízením, nebo ne.

DeviceJobStatistics

Statistika úlohy týkající se stavu spuštění.

Name Typ Description
deviceCount

integer

Počet zařízení, na která úloha cílí.
failedCount

integer

Počet neúspěšných úloh.
pendingCount

integer

Počet čekajících (naplánovaných) úloh.
runningCount

integer

Počet spuštěných úloh.
succeededCount

integer

Počet úspěšných úloh.

JobRequest

Name Typ Description
cloudToDeviceMethod

CloudToDeviceMethod

Typ metody a parametry. To je povinné, pokud je typ úlohy cloudToDeviceMethod.
jobId

string

Jedinečný identifikátor úlohy.
maxExecutionTimeInSeconds

integer

Maximální doba provádění v secounds.
queryCondition

string

Podmínka, aby zařízení spustila úlohu. To je povinné, pokud je typ úlohy updateTwin nebo cloudToDeviceMethod.
startTime

string

Datum a čas zahájení úlohy ve standardu ISO 8601.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Typ úlohy.
updateTwin

Twin

Informace o stavu zařízení nebo modulu Ten se implicitně vytvoří a odstraní při vytvoření nebo odstranění odpovídající identity zařízení nebo modulu v IoT Hub.

JobResponse

Name Typ Description
cloudToDeviceMethod

CloudToDeviceMethod

Typ metody a parametry. To je povinné, pokud je typ úlohy cloudToDeviceMethod.
createdTime

string

Vygenerováno systémem. Při vytváření se ignoruje. Datum a čas vytvoření úlohy.
deviceJobStatistics

DeviceJobStatistics

Podrobnosti týkající se stavu provádění úlohy
endTime

string

Vygenerováno systémem. Při vytváření se ignoruje. Koncové datum a čas úlohy v UTC.
failureReason

string

Důvod selhání, pokud došlo k chybě.
jobId

string

Vygenerováno systémem. Při vytváření se ignoruje. Jedinečný identifikátor úlohy.
maxExecutionTimeInSeconds

integer

Maximální doba provádění v secounds.
queryCondition

string

Podmínka dotazu na zařízení.
startTime

string

Datum a čas zahájení naplánované úlohy v UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Vygenerováno systémem. Při vytváření se ignoruje. Stav úlohy.
statusMessage

string

Stavová zpráva úlohy
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Typ úlohy.
updateTwin

Twin

Informace o stavu zařízení nebo modulu Ten se implicitně vytvoří a odstraní při vytvoření nebo odstranění odpovídající identity zařízení nebo modulu v IoT Hub.

Twin

Informace o stavu zařízení nebo modulu Ten se implicitně vytvoří a odstraní při vytvoření nebo odstranění odpovídající identity zařízení nebo modulu v IoT Hub.

Name Typ Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Typ ověřování používaný zařízením.
capabilities

DeviceCapabilities

Stav funkcí povolených na zařízení.
cloudToDeviceMessageCount

integer

Počet odeslaných zpráv typu cloud-zařízení.
connectionState enum:
  • Connected
  • Disconnected

Stav připojení zařízení.
deviceEtag

string

Řetězec představující ETag zařízení podle RFC7232.
deviceId

string

Jedinečný identifikátor zařízení v registru identit IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků) 7bitových alfanumerických znaků ASCII. a následující speciální znaky {-', ':', '.', '+', '%', '_', '#', '*', '?', '!', ',', ',', '=', '@', ';', '$', ''}.
deviceScope

string

Rozsah zařízení.
etag

string

Řetězec představující ETag dvojčete zařízení podle RFC7232.
lastActivityTime

string

Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu. Datum a čas jsou v ISO8601 formátu datetime ve formátu UTC, například 2015-01-28T16:24:48.789Z. Tato hodnota se neaktualizuje, pokud zařízení k provádění operací zasílání zpráv používá protokol HTTP/1.
moduleId

string

Jedinečný identifikátor modulu v registru identit IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků) 7bitových alfanumerických znaků ASCII. a následující speciální znaky {-', ':', '.', '+', '%', '_', '#', '*', '?', '!', ',', ',', '=', '@', ';', '$', ''}.
parentScopes

string[]

Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. K dispozici pouze pro hraniční zařízení.
properties

TwinProperties

Požadované a hlášené vlastnosti dvojčete.
status enum:
  • disabled
  • enabled

Stav povoleného zařízení. Pokud je tato možnost zakázaná, zařízení se nemůže ke službě připojit.
statusReason

string

Důvod aktuálního stavu zařízení, pokud existuje.
statusUpdateTime

string

Datum a čas poslední aktualizace stavu zařízení.
tags

object

Kolekce párů klíč-hodnota, které back-end řešení načítá a zapisuje. Nejsou viditelné aplikacím zařízení. Jejich klíče jsou kódované UTF-8, rozlišují se velká a malá písmena a mají délku až 1 kB. Povolené znaky nezahrnují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Hodnoty jsou objekty JSON o délce až 4 kB.
version

integer

Verze dvojčete zařízení včetně značek a požadovaných vlastností
x509Thumbprint

X509Thumbprint

Kryptografický otisk zařízení X509.

TwinProperties

Požadované a hlášené vlastnosti dvojčete. Maximální hloubka objektu je 10.

Name Typ Description
desired

object

Kolekce požadovaných párů klíč-hodnota vlastnosti. Klíče mají kódování UTF-8, rozlišují se velká a malá písmena a délku až 1 kB. Povolené znaky nezahrnují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Požadované hodnoty porperty jsou objekty JSON o délce až 4 kB.
reported

object

Kolekce hlášených párů klíč-hodnota vlastnosti. Klíče mají kódování UTF-8, rozlišují se velká a malá písmena a délku až 1 kB. Povolené znaky nezahrnují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Hlášené hodnoty vlastností jsou objekty JSON o délce až 4 kB.

X509Thumbprint

Name Typ Description
primaryThumbprint

string

Primární kryptografický otisk klientského certifikátu X509.
secondaryThumbprint

string

Sekundární kryptografický otisk klientského certifikátu X509.