Sdílet prostřednictvím

Jobs - Get Scheduled Job

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

Získá podrobnosti o naplánované úloze ze služby IoT Hub. Další informace najdete v tématu https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.

GET 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

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 provádění.
JobResponse
Twin

Informace o stavu zařízení nebo modulu To se implicitně vytvoří a odstraní, když se v IoT Hubu vytvoří nebo odstraní odpovídající identita zařízení nebo modulu.
TwinProperties

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

CloudToDeviceMethod

Objekt

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

Name Typ Description
connectTimeoutInSeconds

integer (int32)

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 (int32)

DeviceCapabilities

Objekt

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

Objekt

Statistika úlohy týkající se stavu provádění.

Name Typ Description
deviceCount

integer (int32)

Počet zařízení cílených úlohou.
failedCount

integer (int32)

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

integer (int32)

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

integer (int32)

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

integer (int32)

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

JobResponse

Objekt
Name Typ Description
cloudToDeviceMethod

CloudToDeviceMethod

Typ a parametry metody. To se vyžaduje, pokud je typ úlohy cloudToDeviceMethod.
createdTime

string (date-time)

Systém se vygeneroval. Při vytváření se ignoruje. Datum a čas vytvoření úlohy.
deviceJobStatistics

DeviceJobStatistics

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

string (date-time)

Systém se vygeneroval. 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

Systém se vygeneroval. Při vytváření se ignoruje. Jedinečný identifikátor úlohy.
maxExecutionTimeInSeconds

integer (int64)

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

string

Podmínka dotazu zařízení.
startTime

string (date-time)

Počáteční datum a čas naplánované úlohy v UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Systém se vygeneroval. 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 To se implicitně vytvoří a odstraní, když se v IoT Hubu vytvoří nebo odstraní odpovídající identita zařízení nebo modulu.

Twin

Objekt

Informace o stavu zařízení nebo modulu To se implicitně vytvoří a odstraní, když se v IoT Hubu vytvoří nebo odstraní odpovídající identita zařízení nebo modulu.

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 (int32)

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í značku ETag pro zařízení podle RFC7232.
deviceId

string

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

string

Rozsah zařízení.
etag

string

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

string (date-time)

Datum a čas posledního připojení nebo přijetí nebo odeslání zprávy zařízení. Datum a čas jsou v ISO8601 formátu data a času v 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 služby IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků dlouhý) 7bitové alfanumerické znaky ASCII, a následující speciální znaky {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

Rozsahy hraničních zařízení nejvyšší úrovně, pokud je to možné. K dispozici pouze pro hraniční zařízení.
properties

TwinProperties

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

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

string

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

string (date-time)

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

object

Kolekce párů klíč-hodnota přečtených a zapsaných back-endem řešení. Nejsou viditelné pro aplikace zařízení. Klíče jsou kódované UTF-8, rozlišují velká a malá písmena a up-to délku 1 kB. Povolené znaky vylučují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Hodnoty jsou objekty JSON, up-to o délce 4 kB.
version

integer (int64)

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

X509Thumbprint

Kryptografický otisk X509 zařízení.

TwinProperties

Objekt

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

Name Typ Description
desired

object

Kolekce dvojic klíč-hodnota požadované vlastnosti. Klíče jsou kódované UTF-8, rozlišují velká a malá písmena a up-to délku 1 kB. Povolené znaky vylučují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Požadované hodnoty porperty jsou objekty JSON up-to o délce 4 kB.
reported

object

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

X509Thumbprint

Objekt
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.