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

Jobs - Cancel Scheduled Job

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

Megszakít egy ütemezett feladatot a IoT Hub. További információ: https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.

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

Definíciók

Name Description
CloudToDeviceMethod

A közvetlen metódus végrehajtásához használt paraméterek az eszközön.
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 állapotinformációi. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz- vagy modulidentitást létrehozza vagy törli a IoT Hub.
TwinProperties

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

CloudToDeviceMethod

A közvetlen metódus végrehajtásához használt paraméterek az eszközön.

Name Típus Description
connectTimeoutInSeconds

integer

methodName

string

A végrehajtandó metódus neve.
payload

object

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

integer

DeviceCapabilities

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.

DeviceJobStatistics

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

Name Típus Description
deviceCount

integer

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

integer

A sikertelen feladatok száma.
pendingCount

integer

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

integer

A futó feladatok száma.
succeededCount

integer

A sikeres feladatok száma.

JobResponse

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

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

DeviceJobStatistics

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

string

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

A maximális végrehajtási idő másodpercenként.
queryCondition

string

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

string

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 állapotinformációi. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz- vagy modulidentitást létrehozza vagy törli a IoT Hub.

Twin

Az eszköz vagy modul állapotinformációi. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz- vagy modulidentitást létrehozza vagy törli a IoT Hub.

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

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 a IoT Hub identitásjegyzékében. Ez egy kis- és nagybetűket megkülönböztető sztring (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

Az a dátum és idő, amikor az eszköz utoljára csatlakozik, illetve üzenetet kapott vagy küldött. A dátum és az idő ISO8601 dátum/idő formátumban van megadva UTC formátumban, 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 a IoT Hub identitásjegyzékében. Ez egy kis- és nagybetűket megkülönböztető sztring (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

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úak, megkülönböztetik a kis- és nagybetűket, és akár 1 KB hosszúak is. Az engedélyezett karakterek nem tartalmazzák a UNICODE-vezérlőkaraktereket (C0 és C1 szegmensek), a ".", a "$" és a szóközt. Az értékek JSON-objektumok, legfeljebb 4 KB hosszúságúak.
version

integer

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

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úak, megkülönböztetik a kis- és nagybetűket, és akár 1 KB hosszúak is. Az engedélyezett karakterek nem tartalmazzák a UNICODE-vezérlőkaraktereket (C0 és C1 szegmensek), a ".", a "$" és a szóközt. A kívánt porperty értékek JSON-objektumok, legfeljebb 4 KB hosszúságúak.
reported

object

A jelentett tulajdonságkulcs-érték párok gyűjteménye. A kulcsok UTF-8 kódolásúak, megkülönböztetik a kis- és nagybetűket, és akár 1 KB hosszúak is. Az engedélyezett karakterek nem tartalmazzák a UNICODE-vezérlőkaraktereket (C0 és C1 szegmensek), a ".", a "$" és a szóközt. A jelentett tulajdonságértékek legfeljebb 4 KB hosszúságú JSON-objektumok.

X509Thumbprint

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.