Megosztás a következőn keresztül:

Jobs - Get Scheduled Job

  • Referencia
Szolgáltatás:
IoT Hub
API-verzió:
2021-04-12

Lekéri egy ütemezett feladat részleteit az IoT Hubról. További információért lásd a https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs jelű részt.

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

URI-paraméterek

Name In Kötelező Típus Description
id
 path True

string

A feladat egyedi azonosítója.
api-version
 query True

string

Az Api verziója.

Válaszok

Name Típus Description
200 OK

JobResponse

OKÉ.

Definíciók

Name Description
CloudToDeviceMethod

Az eszközön egy közvetlen metódus végrehajtásához használandó paraméterek.
DeviceCapabilities

Az eszközön engedélyezett képességek állapota.
DeviceJobStatistics

A végrehajtás állapotával kapcsolatos feladatstatisztikák.
JobResponse
Twin

Az eszköz vagy modul állapotadatai. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz/ modul identitása létrejön vagy törlődik az IoT Hubban.
TwinProperties

Az ikerpéldány kívánt és jelentett tulajdonságai. Az objektum maximális mélysége 10.
X509Thumbprint

CloudToDeviceMethod

Objektum

Az eszközön egy közvetlen metódus végrehajtásához használandó paraméterek.

Name Típus Description
connectTimeoutInSeconds

integer (int32)

methodName

string

A végrehajtandó metódus neve.
payload

object

A JSON-formátumú közvetlen metódus hasznos adatai, legfeljebb 128kb méretűek.
responseTimeoutInSeconds

integer (int32)

DeviceCapabilities

Objektum

Az eszközön engedélyezett képességek állapota.

Name Típus Description
iotEdge

boolean

Az a tulajdonság, amely meghatározza, hogy az eszköz peremeszköz-e vagy sem.

DeviceJobStatistics

Objektum

A végrehajtás állapotával kapcsolatos feladatstatisztikák.

Name Típus Description
deviceCount

integer (int32)

A feladat által megcélzott eszközök száma.
failedCount

integer (int32)

A sikertelen feladatok száma.
pendingCount

integer (int32)

Függőben lévő (ütemezett) feladatok száma.
runningCount

integer (int32)

A futó feladatok száma.
succeededCount

integer (int32)

A sikeres feladatok száma.

JobResponse

Objektum
Name Típus Description
cloudToDeviceMethod

CloudToDeviceMethod

A metódus típusa és paraméterei. Erre akkor van szükség, ha a feladat típusa cloudToDeviceMethod.
createdTime

string (date-time)

Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat létrehozásának dátuma és időpontja.
deviceJobStatistics

DeviceJobStatistics

A feladatvégrehajtás állapotával kapcsolatos részletek.
endTime

string (date-time)

Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat befejezési dátuma és időpontja (UTC).
failureReason

string

A hiba oka, ha hiba történt.
jobId

string

Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat egyedi azonosítója.
maxExecutionTimeInSeconds

integer (int64)

A maximális végrehajtási idő szekundumokban.
queryCondition

string

Az eszköz lekérdezési feltétele.
startTime

string (date-time)

Az ütemezett feladat kezdési dátuma és időpontja (UTC).
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Rendszer generálva. A létrehozáskor figyelmen kívül hagyva. A feladat állapota.
statusMessage

string

A feladat állapotüzenete.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

A feladat típusa.
updateTwin

Twin

Az eszköz vagy modul állapotadatai. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz/ modul identitása létrejön vagy törlődik az IoT Hubban.

Twin

Objektum

Az eszköz vagy modul állapotadatai. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz/ modul identitása létrejön vagy törlődik az IoT Hubban.

Name Típus Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Az eszköz által használt hitelesítési típus.
capabilities

DeviceCapabilities

Az eszközön engedélyezett képességek állapota.
cloudToDeviceMessageCount

integer (int32)

A felhőből az eszközre küldött üzenetek száma.
connectionState enum:
  • Connected
  • Disconnected

Az eszköz kapcsolati állapota.
deviceEtag

string

Az eszköz ETag-jének sztringje a RFC7232 szerint.
deviceId

string

Az eszköz egyedi azonosítója az IoT Hub identitásjegyzékében. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterből, és a következő speciális karakterek: {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope

string

Az eszköz hatóköre.
etag

string

Az ikereszköz ETag-jének sztringje a RFC7232 szerint.
lastActivityTime

string (date-time)

Az eszköz legutóbbi csatlakoztatásának vagy fogadásának vagy üzenetküldésének dátuma és időpontja. A dátum és az idő ISO8601 dátum/idő formátumban van megadva UTC-ben, például 2015-01-28T16:24:48.789Z. Ez az érték nem frissül, ha az eszköz a HTTP/1 protokollt használja az üzenetkezelési műveletek végrehajtásához.
moduleId

string

A modul egyedi azonosítója az IoT Hub identitásjegyzékében. Kis- és nagybetűk megkülönböztetése (legfeljebb 128 karakter hosszú) ASCII 7 bites alfanumerikus karakterből, és a következő speciális karakterek: {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

A felső szintű peremeszközök hatókörei, ha vannak. Csak peremeszközökhöz érhető el.
properties

TwinProperties

Az ikerpéldány kívánt és jelentett tulajdonságai.
status enum:
  • disabled
  • enabled

Az eszköz engedélyezett állapota. Ha le van tiltva, az eszköz nem tud csatlakozni a szolgáltatáshoz.
statusReason

string

Az eszköz aktuális állapotának oka, ha van ilyen.
statusUpdateTime

string (date-time)

Az eszköz állapotának legutóbbi frissítésének dátuma és időpontja.
tags

object

A megoldás háttérrendszere által beolvasott és írt kulcs-érték párok gyűjteménye. Nem láthatók az eszközalkalmazások számára. Ezek a kulcsok UTF-8 kódolású, kis- és nagybetűkre érzékenyek, és up-to 1KB hosszúságúak. Az engedélyezett karakterek nem tartalmaznak UNICODE-vezérlőkaraktereket (C0 és C1 szegmens), ".", "$" és szóközt. Az értékek JSON-objektumok, up-to 4KB hosszúak.
version

integer (int64)

Az ikereszköz verziója, beleértve a címkéket és a kívánt tulajdonságokat
x509Thumbprint

X509Thumbprint

Az eszköz X509 ujjlenyomata.

TwinProperties

Objektum

Az ikerpéldány kívánt és jelentett tulajdonságai. Az objektum maximális mélysége 10.

Name Típus Description
desired

object

A kívánt tulajdonságkulcs-érték párok gyűjteménye. A kulcsok UTF-8 kódolású, kis- és nagybetűkre érzékenyek, és up-to 1KB hosszúságúak. Az engedélyezett karakterek nem tartalmaznak UNICODE-vezérlőkaraktereket (C0 és C1 szegmens), ".", "$" és szóközt. A kívánt porperty értékek JSON-objektumok, up-to 4KB hosszúak.
reported

object

A jelentett tulajdonságkulcs-érték párok gyűjteménye. A kulcsok UTF-8 kódolású, kis- és nagybetűkre érzékenyek, és up-to 1KB hosszúságúak. Az engedélyezett karakterek nem tartalmaznak UNICODE-vezérlőkaraktereket (C0 és C1 szegmens), ".", "$" és szóközt. A jelentett tulajdonságértékek JSON-objektumok, up-to 4 KB hosszúak.

X509Thumbprint

Objektum
Name Típus Description
primaryThumbprint

string

Az X509 ügyféltanúsítvány elsődleges ujjlenyomata.
secondaryThumbprint

string

Az X509 ügyféltanúsítvány másodlagos ujjlenyomata.