Jobs - Get Scheduled Job
Hämtar information om ett schemalagt jobb från IoT Hub. Mer information finns i 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
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
id
|
path | True |
string |
Den unika identifieraren för jobbet. |
api-version
|
query | True |
string |
Version av API:et. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
OK. |
Definitioner
Name | Description |
---|---|
Cloud |
Parametrarna för att köra en direktmetod på enheten. |
Device |
Status för funktioner som är aktiverade på enheten. |
Device |
Jobbstatistiken för körningsstatus. |
Job |
|
Twin |
Tillståndsinformation för en enhet eller modul. Detta skapas och tas bort implicit när motsvarande enhets-/modulidentitet skapas eller tas bort i IoT Hub. |
Twin |
Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10. |
X509Thumbprint |
CloudToDeviceMethod
Parametrarna för att köra en direktmetod på enheten.
Name | Typ | Description |
---|---|---|
connectTimeoutInSeconds |
integer |
|
methodName |
string |
Namnet på metoden som ska köras. |
payload |
object |
Den JSON-formaterade direktmetodnyttolasten, upp till 128 kB i storlek. |
responseTimeoutInSeconds |
integer |
DeviceCapabilities
Status för funktioner som är aktiverade på enheten.
Name | Typ | Description |
---|---|---|
iotEdge |
boolean |
Egenskapen som avgör om enheten är en gränsenhet eller inte. |
DeviceJobStatistics
Jobbstatistiken för körningsstatus.
Name | Typ | Description |
---|---|---|
deviceCount |
integer |
Antalet enheter som jobbet riktar in sig på. |
failedCount |
integer |
Antalet misslyckade jobb. |
pendingCount |
integer |
Antalet väntande (schemalagda) jobb. |
runningCount |
integer |
Antalet jobb som körs. |
succeededCount |
integer |
Antalet lyckade jobb. |
JobResponse
Name | Typ | Description |
---|---|---|
cloudToDeviceMethod |
Metodtypen och parametrarna. Detta krävs om jobbtypen är cloudToDeviceMethod. |
|
createdTime |
string |
Systemet har genererats. Ignoreras vid skapande. Skapandedatum och tid för jobbet. |
deviceJobStatistics |
Information om jobbkörningsstatus. |
|
endTime |
string |
Systemet har genererats. Ignoreras vid skapande. Slutdatum och tid för jobbet i UTC. |
failureReason |
string |
Orsaken till felet, om ett fel uppstod. |
jobId |
string |
Systemet har genererats. Ignoreras vid skapande. Den unika identifieraren för jobbet. |
maxExecutionTimeInSeconds |
integer |
Den maximala körningstiden i secounds. |
queryCondition |
string |
Enhetens frågevillkor. |
startTime |
string |
Startdatum och tid för det schemalagda jobbet i UTC. |
status |
enum:
|
Systemet har genererats. Ignoreras vid skapande. Jobbets status. |
statusMessage |
string |
Statusmeddelandet för jobbet. |
type |
enum:
|
Jobbtypen. |
updateTwin |
Tillståndsinformation för en enhet eller modul. Detta skapas och tas bort implicit när motsvarande enhets-/modulidentitet skapas eller tas bort i IoT Hub. |
Twin
Tillståndsinformation för en enhet eller modul. Detta skapas och tas bort implicit när motsvarande enhets-/modulidentitet skapas eller tas bort i IoT Hub.
Name | Typ | Description |
---|---|---|
authenticationType |
enum:
|
Den autentiseringstyp som används av enheten. |
capabilities |
Status för funktioner som är aktiverade på enheten. |
|
cloudToDeviceMessageCount |
integer |
Antalet meddelanden från molnet till enheten som skickas. |
connectionState |
enum:
|
Enhetens anslutningstillstånd. |
deviceEtag |
string |
Strängen som representerar en ETag för enheten enligt RFC7232. |
deviceId |
string |
Den unika identifieraren för enheten i identitetsregistret för IoT Hub. Det är en skiftlägeskänslig sträng (upp till 128 tecken lång) av ASCII 7-bitars alfanumeriska tecken, och följande specialtecken {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
deviceScope |
string |
Enhetens omfång. |
etag |
string |
Strängen som representerar en ETag för enhetstvillingen enligt RFC7232. |
lastActivityTime |
string |
Datum och tid när enheten senast anslöt eller tog emot eller skickade ett meddelande. Datum och tid anges i ISO8601 datetime-format i UTC, till exempel 2015-01-28T16:24:48.789Z. Det här värdet uppdateras inte om enheten använder HTTP/1-protokollet för att utföra meddelandeåtgärder. |
moduleId |
string |
Den unika identifieraren för modulen i identitetsregistret för IoT Hub. Det är en skiftlägeskänslig sträng (upp till 128 tecken lång) av ASCII 7-bitars alfanumeriska tecken, och följande specialtecken {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}. |
parentScopes |
string[] |
Omfången för gränsenheterna på den övre nivån om tillämpligt. Endast tillgängligt för gränsenheter. |
properties |
Önskade och rapporterade egenskaper för tvillingen. |
|
status |
enum:
|
Enhetens aktiverade status. Om den är inaktiverad kan enheten inte ansluta till tjänsten. |
statusReason |
string |
Orsaken till enhetens aktuella status, om det finns någon. |
statusUpdateTime |
string |
Datum och tid då enhetens status senast uppdaterades. |
tags |
object |
Insamling av nyckel/värde-par som lästs och skrivits av lösningens serverdel. De är inte synliga för enhetsappar. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 kB långa. Tillåtna tecken utesluter UNICODE-kontrolltecken (segmenten C0 och C1), ".", "$" och blanksteg. Värdena är JSON-objekt med en längd på upp till 4 kB. |
version |
integer |
Versionen för enhetstvillingen inklusive taggar och önskade egenskaper |
x509Thumbprint |
Enhetens X509-tumavtryck. |
TwinProperties
Önskade och rapporterade egenskaper för tvillingen. Objektets maximala djup är 10.
Name | Typ | Description |
---|---|---|
desired |
object |
Samlingen med nyckel/värde-par för önskad egenskap. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 kB långa. Tillåtna tecken utesluter UNICODE-kontrolltecken (segmenten C0 och C1), ".", "$" och blanksteg. Önskade porperty-värden är JSON-objekt med en längd på upp till 4 KB. |
reported |
object |
Samlingen av nyckel/värde-par för rapporterade egenskaper. Nycklarna är UTF-8-kodade, skiftlägeskänsliga och upp till 1 kB långa. Tillåtna tecken utesluter UNICODE-kontrolltecken (segmenten C0 och C1), ".", "$" och blanksteg. De rapporterade egenskapsvärdena är JSON-objekt med en längd på upp till 4 KB. |
X509Thumbprint
Name | Typ | Description |
---|---|---|
primaryThumbprint |
string |
X509-klientcertifikatets primära tumavtryck. |
secondaryThumbprint |
string |
Det sekundära tumavtrycket för X509-klientcertifikatet. |