Jobs - Get Scheduled Job
Hiermee haalt u details op van een geplande taak van de IoT Hub. Zie https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs voor meer informatie.
GET https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}?api-version=2021-04-12
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
id
|
path | True |
string |
De unieke id van de taak. |
api-version
|
query | True |
string |
Versie van de API. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
OK. |
Definities
Name | Description |
---|---|
Cloud |
De parameters voor het uitvoeren van een directe methode op het apparaat. |
Device |
De status van de mogelijkheden die op het apparaat zijn ingeschakeld. |
Device |
De taakstatistieken met betrekking tot de uitvoeringsstatus. |
Job |
|
Twin |
De statusinformatie voor een apparaat of module. Dit wordt impliciet gemaakt en verwijderd wanneer de bijbehorende apparaat-/module-id wordt gemaakt of verwijderd in de IoT Hub. |
Twin |
De gewenste en gerapporteerde eigenschappen van de tweeling. De maximale diepte van het object is 10. |
X509Thumbprint |
CloudToDeviceMethod
De parameters voor het uitvoeren van een directe methode op het apparaat.
Name | Type | Description |
---|---|---|
connectTimeoutInSeconds |
integer (int32) |
|
methodName |
string |
De naam van de methode die moet worden uitgevoerd. |
payload |
object |
De nettolading van de directe methode met JSON-indeling, tot 128 kB. |
responseTimeoutInSeconds |
integer (int32) |
DeviceCapabilities
De status van de mogelijkheden die op het apparaat zijn ingeschakeld.
Name | Type | Description |
---|---|---|
iotEdge |
boolean |
De eigenschap die bepaalt of het apparaat een edge-apparaat is of niet. |
DeviceJobStatistics
De taakstatistieken met betrekking tot de uitvoeringsstatus.
Name | Type | Description |
---|---|---|
deviceCount |
integer (int32) |
Het aantal apparaten waarop de taak betrekking heeft. |
failedCount |
integer (int32) |
Het aantal mislukte taken. |
pendingCount |
integer (int32) |
Het aantal in behandeling zijnde (geplande) taken. |
runningCount |
integer (int32) |
Het aantal actieve taken. |
succeededCount |
integer (int32) |
Het aantal geslaagde taken. |
JobResponse
Name | Type | Description |
---|---|---|
cloudToDeviceMethod |
Het methodetype en de parameters. Dit is vereist als het taaktype cloudToDeviceMethod is. |
|
createdTime |
string (date-time) |
Door het systeem gegenereerd. Genegeerd bij het maken. De aanmaakdatum en -tijd van de taak. |
deviceJobStatistics |
De details met betrekking tot de uitvoeringsstatus van de taak. |
|
endTime |
string (date-time) |
Door het systeem gegenereerd. Genegeerd bij het maken. De einddatum en -tijd van de taak in UTC. |
failureReason |
string |
De reden voor de fout, als er een fout is opgetreden. |
jobId |
string |
Door het systeem gegenereerd. Genegeerd bij het maken. De unieke id van de taak. |
maxExecutionTimeInSeconds |
integer (int64) |
De maximale uitvoeringstijd in secounds. |
queryCondition |
string |
De queryvoorwaarde van het apparaat. |
startTime |
string (date-time) |
De begindatum en -tijd van de geplande taak in UTC. |
status |
enum:
|
Door het systeem gegenereerd. Genegeerd bij het maken. De status van de taak. |
statusMessage |
string |
Het statusbericht van de taak. |
type |
enum:
|
Het taaktype. |
updateTwin |
De statusinformatie voor een apparaat of module. Dit wordt impliciet gemaakt en verwijderd wanneer de bijbehorende apparaat-/module-id wordt gemaakt of verwijderd in de IoT Hub. |
Twin
De statusinformatie voor een apparaat of module. Dit wordt impliciet gemaakt en verwijderd wanneer de bijbehorende apparaat-/module-id wordt gemaakt of verwijderd in de IoT Hub.
Name | Type | Description |
---|---|---|
authenticationType |
enum:
|
Het verificatietype dat door het apparaat wordt gebruikt. |
capabilities |
De status van de mogelijkheden die op het apparaat zijn ingeschakeld. |
|
cloudToDeviceMessageCount |
integer (int32) |
Het aantal cloud-naar-apparaat-berichten dat wordt verzonden. |
connectionState |
enum:
|
De verbindingsstatus van het apparaat. |
deviceEtag |
string |
De tekenreeks die een ETag voor het apparaat vertegenwoordigt, volgens RFC7232. |
deviceId |
string |
De unieke id van het apparaat in het identiteitsregister van de IoT Hub. Het is een hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) van ASCII 7-bits alfanumerieke tekens, en de volgende speciale tekens {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}. |
deviceScope |
string |
Het bereik van het apparaat. |
etag |
string |
De tekenreeks die een ETag voor de apparaatdubbel vertegenwoordigt, volgens RFC7232. |
lastActivityTime |
string (date-time) |
De datum en tijd waarop het apparaat voor het laatst verbinding heeft gemaakt of een bericht heeft ontvangen of verzonden. De datum en tijd worden gescheiden in ISO8601 datum/tijd-notatie in UTC, bijvoorbeeld 2015-01-28T16:24:48.789Z. Deze waarde wordt niet bijgewerkt als het apparaat gebruikmaakt van het HTTP/1-protocol om berichtenbewerkingen uit te voeren. |
moduleId |
string |
De unieke id van de module in het identiteitsregister van de IoT Hub. Het is een hoofdlettergevoelige tekenreeks (maximaal 128 tekens lang) van ASCII 7-bits alfanumerieke tekens, en de volgende speciale tekens {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}. |
parentScopes |
string[] |
De bereiken van de edge-apparaten op het hoogste niveau, indien van toepassing. Alleen beschikbaar voor edge-apparaten. |
properties |
De gewenste en gerapporteerde eigenschappen van de tweeling. |
|
status |
enum:
|
De ingeschakelde status van het apparaat. Als dit is uitgeschakeld, kan het apparaat geen verbinding maken met de service. |
statusReason |
string |
De reden voor de huidige status van het apparaat, indien van toepassing. |
statusUpdateTime |
string (date-time) |
De datum en tijd waarop de status van het apparaat voor het laatst is bijgewerkt. |
tags |
object |
De verzameling sleutel-waardeparen die worden gelezen en geschreven door de back-end van de oplossing. Ze zijn niet zichtbaar voor apparaat-apps. De sleutels zijn UTF-8 gecodeerd, hoofdlettergevoelig en up-to 1 kB lang. Toegestane tekens sluiten UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie uit. De waarden zijn JSON-objecten, up-to 4 kB lang. |
version |
integer (int64) |
De versie voor de apparaatdubbel, inclusief tags en gewenste eigenschappen |
x509Thumbprint |
De X509-vingerafdruk van het apparaat. |
TwinProperties
De gewenste en gerapporteerde eigenschappen van de tweeling. De maximale diepte van het object is 10.
Name | Type | Description |
---|---|---|
desired |
object |
De verzameling gewenste sleutel-waardeparen van eigenschappen. De sleutels zijn UTF-8 gecodeerd, hoofdlettergevoelig en up-to 1 kB lang. Toegestane tekens sluiten UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie uit. De gewenste porpertywaarden zijn JSON-objecten, up-to 4 kB lang. |
reported |
object |
De verzameling gerapporteerde sleutel-waardeparen van eigenschappen. De sleutels zijn UTF-8 gecodeerd, hoofdlettergevoelig en up-to 1 kB lang. Toegestane tekens sluiten UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie uit. De gerapporteerde eigenschapswaarden zijn JSON-objecten, up-to 4 kB lang. |
X509Thumbprint
Name | Type | Description |
---|---|---|
primaryThumbprint |
string |
De primaire vingerafdruk van het X509-clientcertificaat. |
secondaryThumbprint |
string |
De secundaire vingerafdruk van het X509-clientcertificaat. |