Jobs - Cancel Scheduled Job

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

Membatalkan pekerjaan terjadwal pada IoT Hub. Lihat https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs untuk informasi lebih lanjut.

POST https://fully-qualified-iothubname.azure-devices.net/jobs/v2/{id}/cancel?api-version=2021-04-12

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
id
 path True

string

Pengidentifikasi unik pekerjaan.
api-version
 query True

string

Versi Api.

Respons

Nama Jenis Deskripsi
200 OK

JobResponse

OK.

Definisi

Nama Deskripsi
CloudToDeviceMethod

Parameter untuk menjalankan metode langsung pada perangkat.
DeviceCapabilities

Status kemampuan yang diaktifkan pada perangkat.
DeviceJobStatistics

Statistik pekerjaan mengenai status eksekusi.
JobResponse
Twin

Informasi status untuk perangkat atau modul. Ini secara implisit dibuat dan dihapus saat identitas perangkat/modul yang sesuai dibuat atau dihapus di IoT Hub.
TwinProperties

Properti kembar yang diinginkan dan dilaporkan. Kedalaman maksimum objek adalah 10.
X509Thumbprint

CloudToDeviceMethod

Parameter untuk menjalankan metode langsung pada perangkat.

Nama Jenis Deskripsi
connectTimeoutInSeconds

integer

methodName

string

Nama metode yang akan dijalankan.
payload

object

Payload metode langsung berformat JSON, berukuran hingga 128kb.
responseTimeoutInSeconds

integer

DeviceCapabilities

Status kemampuan yang diaktifkan pada perangkat.

Nama Jenis Deskripsi
iotEdge

boolean

Properti yang menentukan apakah perangkat adalah perangkat edge atau tidak.

DeviceJobStatistics

Statistik pekerjaan mengenai status eksekusi.

Nama Jenis Deskripsi
deviceCount

integer

Jumlah perangkat yang ditargetkan oleh pekerjaan.
failedCount

integer

Jumlah pekerjaan yang gagal.
pendingCount

integer

Jumlah pekerjaan yang tertunda (terjadwal).
runningCount

integer

Jumlah pekerjaan yang sedang berjalan.
succeededCount

integer

Jumlah pekerjaan yang berhasil.

JobResponse

Nama Jenis Deskripsi
cloudToDeviceMethod

CloudToDeviceMethod

Jenis metode dan parameter. Ini diperlukan jika jenis pekerjaan adalah cloudToDeviceMethod.
createdTime

string

Sistem yang dihasilkan. Diabaikan saat pembuatan. Tanggal dan waktu pembuatan pekerjaan.
deviceJobStatistics

DeviceJobStatistics

Detail mengenai status eksekusi pekerjaan.
endTime

string

Sistem yang dihasilkan. Diabaikan saat pembuatan. Tanggal dan waktu akhir pekerjaan di UTC.
failureReason

string

Alasan kegagalan, jika kegagalan terjadi.
jobId

string

Sistem yang dihasilkan. Diabaikan saat pembuatan. Pengidentifikasi unik pekerjaan.
maxExecutionTimeInSeconds

integer

Waktu eksekusi maksimum dalam secound.
queryCondition

string

Kondisi kueri perangkat.
startTime

string

Tanggal dan waktu mulai pekerjaan terjadwal di UTC.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Sistem yang dihasilkan. Diabaikan saat pembuatan. Status pekerjaan.
statusMessage

string

Pesan status pekerjaan.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

Jenis pekerjaan.
updateTwin

Twin

Informasi status untuk perangkat atau modul. Ini secara implisit dibuat dan dihapus saat identitas perangkat/modul yang sesuai dibuat atau dihapus di IoT Hub.

Twin

Informasi status untuk perangkat atau modul. Ini secara implisit dibuat dan dihapus saat identitas perangkat/modul yang sesuai dibuat atau dihapus di IoT Hub.

Nama Jenis Deskripsi
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Jenis autentikasi yang digunakan oleh perangkat.
capabilities

DeviceCapabilities

Status kemampuan yang diaktifkan pada perangkat.
cloudToDeviceMessageCount

integer

Jumlah pesan cloud-ke-perangkat yang dikirim.
connectionState enum:
  • Connected
  • Disconnected

Status koneksi perangkat.
deviceEtag

string

String yang mewakili ETag untuk perangkat, sesuai RFC7232.
deviceId

string

Pengidentifikasi unik perangkat dalam registri identitas IoT Hub. Ini adalah string peka huruf besar/kecil (panjang hingga 128 karakter) karakter alfanumerik ASCII 7-bit, dan karakter khusus berikut {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope

string

Cakupan perangkat.
etag

string

String yang mewakili ETag untuk perangkat kembar, sesuai RFC7232.
lastActivityTime

string

Tanggal dan waktu saat perangkat terakhir tersambung atau menerima atau mengirim pesan. Tanggal dan waktu dipisahkan dalam format tanggalwaktu ISO8601 dalam UTC, misalnya, 2015-01-28T16:24:48.789Z. Nilai ini tidak diperbarui jika perangkat menggunakan protokol HTTP/1 untuk melakukan operasi olahpesan.
moduleId

string

Pengidentifikasi unik modul dalam registri identitas IoT Hub. Ini adalah string peka huruf besar/kecil (panjang hingga 128 karakter) karakter alfanumerik ASCII 7-bit, dan karakter khusus berikut {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

Cakupan perangkat tepi tingkat atas jika berlaku. Hanya tersedia untuk perangkat edge.
properties

TwinProperties

Properti kembar yang diinginkan dan dilaporkan.
status enum:
  • disabled
  • enabled

Status perangkat yang diaktifkan. Jika dinonaktifkan, perangkat tidak dapat tersambung ke layanan.
statusReason

string

Alasan status perangkat saat ini, jika ada.
statusUpdateTime

string

Tanggal dan waktu saat status perangkat terakhir diperbarui.
tags

object

Kumpulan pasangan kunci-nilai yang dibaca dan ditulis oleh back end solusi. Mereka tidak terlihat oleh aplikasi perangkat. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilainya adalah objek JSON, panjangnya hingga 4KB.
version

integer

Versi untuk perangkat kembar termasuk tag dan properti yang diinginkan
x509Thumbprint

X509Thumbprint

Thumbprint X509 perangkat.

TwinProperties

Properti kembar yang diinginkan dan dilaporkan. Kedalaman maksimum objek adalah 10.

Nama Jenis Deskripsi
desired

object

Kumpulan pasangan kunci-nilai properti yang diinginkan. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilai porperty yang diinginkan adalah objek JSON, panjangnya hingga 4KB.
reported

object

Kumpulan pasangan kunci-nilai properti yang dilaporkan. Kuncinya adalah UTF-8 yang dikodekan, peka huruf besar/kecil, dan panjangnya hingga 1KB. Karakter yang diizinkan mengecualikan karakter kontrol UNICODE (segmen C0 dan C1), '.', '$' dan spasi. Nilai properti yang dilaporkan adalah objek JSON, panjangnya hingga 4KB.

X509Thumbprint

Nama Jenis Deskripsi
primaryThumbprint

string

Thumbprint utama sertifikat klien X509.
secondaryThumbprint

string

Thumbprint sekunder sertifikat klien X509.