Jobs - Cancel Scheduled Job

  • Referentie
Service:
IoT Hub
API Version:
2021-04-12

Hiermee annuleert u een geplande taak op de IoT Hub. Zie https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs voor meer informatie.

POST https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}/cancel?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

JobResponse

OK.

Definities

Name Description
CloudToDeviceMethod

De parameters voor het uitvoeren van een directe methode op het apparaat.
DeviceCapabilities

De status van de mogelijkheden die zijn ingeschakeld op het apparaat.
DeviceJobStatistics

De taakstatistieken met betrekking tot de uitvoeringsstatus.
JobResponse
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.
TwinProperties

De gewenste en gerapporteerde eigenschappen van de dubbel. 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

methodName

string

De naam van de methode die moet worden uitgevoerd.
payload

object

De nettolading van de directe methode in JSON-indeling, met een grootte van maximaal 128 kB.
responseTimeoutInSeconds

integer

DeviceCapabilities

De status van de mogelijkheden die zijn ingeschakeld op het apparaat.

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

Het aantal apparaten waarop de taak is gericht.
failedCount

integer

Het aantal mislukte taken.
pendingCount

integer

Het aantal in behandeling zijnde (geplande) taken.
runningCount

integer

Het aantal actieve taken.
succeededCount

integer

Het aantal geslaagde taken.

JobResponse

Name Type Description
cloudToDeviceMethod

CloudToDeviceMethod

Het type methode en parameters. Dit is vereist als het taaktype cloudToDeviceMethod is.
createdTime

string

Door het systeem gegenereerd. Genegeerd bij het maken. De aanmaakdatum en -tijd van de taak.
deviceJobStatistics

DeviceJobStatistics

De details met betrekking tot de uitvoeringsstatus van de taak.
endTime

string

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

De maximale uitvoeringstijd in secounds.
queryCondition

string

De queryvoorwaarde van het apparaat.
startTime

string

De begindatum en -tijd van de geplande taak in UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Door het systeem gegenereerd. Genegeerd bij het maken. De status van de taak.
statusMessage

string

Het statusbericht van de taak.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Het taaktype.
updateTwin

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 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:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Het verificatietype dat door het apparaat wordt gebruikt.
capabilities

DeviceCapabilities

De status van de mogelijkheden die zijn ingeschakeld op het apparaat.
cloudToDeviceMessageCount

integer

Het aantal cloud-naar-apparaat-berichten dat wordt verzonden.
connectionState enum:
  • Connected
  • Disconnected

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

De datum en tijd waarop het apparaat voor het laatst verbinding heeft gemaakt of een bericht heeft ontvangen of verzonden. De datum en tijd zijn gescheiden in ISO8601 datum/tijd-notatie in UTC, bijvoorbeeld 2015-01-28T16:24:48.789Z. Deze waarde wordt niet bijgewerkt als het apparaat het HTTP/1-protocol gebruikt 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 bovenste niveau, indien van toepassing. Alleen beschikbaar voor edge-apparaten.
properties

TwinProperties

De gewenste en gerapporteerde eigenschappen van de dubbel.
status enum:
  • disabled
  • enabled

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

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 met UTF-8 gecodeerd, hoofdlettergevoelig en maximaal 1 kB lang. Toegestane tekens zijn exclusief UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie. De waarden zijn JSON-objecten met een lengte van maximaal 4 kB.
version

integer

De versie voor de apparaatdubbel, inclusief tags en gewenste eigenschappen
x509Thumbprint

X509Thumbprint

De X509-vingerafdruk van het apparaat.

TwinProperties

De gewenste en gerapporteerde eigenschappen van de dubbel. De maximale diepte van het object is 10.

Name Type Description
desired

object

De verzameling van gewenste eigenschapssleutel-waardeparen. De sleutels zijn met UTF-8 gecodeerd, hoofdlettergevoelig en maximaal 1 kB lang. Toegestane tekens zijn exclusief UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie. De gewenste porpertywaarden zijn JSON-objecten met een lengte van maximaal 4 kB.
reported

object

De verzameling gerapporteerde sleutel-waardeparen van eigenschappen. De sleutels zijn met UTF-8 gecodeerd, hoofdlettergevoelig en maximaal 1 kB lang. Toegestane tekens zijn exclusief UNICODE-besturingstekens (segmenten C0 en C1), '.', '$' en spatie. De gerapporteerde eigenschapswaarden zijn JSON-objecten met een lengte van maximaal 4 kB.

X509Thumbprint

Name Type Description
primaryThumbprint

string

De primaire vingerafdruk van het X509-clientcertificaat.
secondaryThumbprint

string

De secundaire vingerafdruk van het X509-clientcertificaat.