Aracılığıyla paylaş

Jobs - Create Scheduled Job

  • Başvuru
Hizmet:
IoT Hub
API Sürümü:
2021-04-12

zamanlanmış bir zamanda IoT Hub ikiz güncelleştirmelerini veya doğrudan yöntemleri zamanlamak için yeni bir iş oluşturur. Daha fazla bilgi edinmek için bkz. https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-jobs.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
id
 path True

string

İşin benzersiz tanımlayıcısı.
api-version
 query True

string

Api sürümü.

İstek Gövdesi

Name Tür Description
cloudToDeviceMethod

CloudToDeviceMethod

Yöntem türü ve parametreleri. İş türü cloudToDeviceMethod ise bu gereklidir.
jobId

string

İşin benzersiz tanımlayıcısı.
maxExecutionTimeInSeconds

integer

Secounds içindeki en uzun yürütme süresi.
queryCondition

string

Cihazların işi yürütmesi için koşul. İş türü updateTwin veya cloudToDeviceMethod ise bu gereklidir.
startTime

string

ISO 8601 standardında işin başlangıç tarihi ve saati.
type enum:
  • unknown
  • export
  • import
  • backup
  • readDeviceProperties
  • writeDeviceProperties
  • updateDeviceConfiguration
  • rebootDevice
  • factoryResetDevice
  • firmwareUpdate
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • restoreFromBackup
  • failoverDataCopy

İş türü.
updateTwin

Twin

Bir cihaz veya modülün durum bilgileri. Bu, IoT Hub ilgili cihaz/modül kimliği oluşturulduğunda veya silindiğinde örtük olarak oluşturulur ve silinir.

Yanıtlar

Name Tür Description
200 OK

JobResponse

Tamam ögesini seçin.

Tanımlar

Name Description
CloudToDeviceMethod

Cihazda doğrudan yöntem yürütme parametreleri.
DeviceCapabilities

Cihazda etkinleştirilen özelliklerin durumu.
DeviceJobStatistics

Yürütme durumuyla ilgili iş istatistikleri.
JobRequest
JobResponse
Twin

Bir cihaz veya modülün durum bilgileri. Bu, IoT Hub ilgili cihaz/modül kimliği oluşturulduğunda veya silindiğinde örtük olarak oluşturulur ve silinir.
TwinProperties

İkizin istenen ve bildirilen özellikleri. Nesnenin maksimum derinliği 10'dur.
X509Thumbprint

CloudToDeviceMethod

Cihazda doğrudan yöntem yürütme parametreleri.

Name Tür Description
connectTimeoutInSeconds

integer

methodName

string

Yürütülecek yöntemin adı.
payload

object

Boyutu 128 kb'a kadar olan JSON biçimli doğrudan yöntem yükü.
responseTimeoutInSeconds

integer

DeviceCapabilities

Cihazda etkinleştirilen özelliklerin durumu.

Name Tür Description
iotEdge

boolean

Cihazın bir uç cihaz olup olmadığını belirleyen özellik.

DeviceJobStatistics

Yürütme durumuyla ilgili iş istatistikleri.

Name Tür Description
deviceCount

integer

İş tarafından hedeflenen cihaz sayısı.
failedCount

integer

Başarısız iş sayısı.
pendingCount

integer

Bekleyen (zamanlanmış) işlerin sayısı.
runningCount

integer

Çalışan işlerin sayısı.
succeededCount

integer

Başarılı işlerin sayısı.

JobRequest

Name Tür Description
cloudToDeviceMethod

CloudToDeviceMethod

Yöntem türü ve parametreleri. İş türü cloudToDeviceMethod ise bu gereklidir.
jobId

string

İşin benzersiz tanımlayıcısı.
maxExecutionTimeInSeconds

integer

Secounds içindeki en uzun yürütme süresi.
queryCondition

string

Cihazların işi yürütmesi için koşul. İş türü updateTwin veya cloudToDeviceMethod ise bu gereklidir.
startTime

string

ISO 8601 standardında işin başlangıç tarihi ve saati.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

İş türü.
updateTwin

Twin

Bir cihaz veya modülün durum bilgileri. Bu, IoT Hub ilgili cihaz/modül kimliği oluşturulduğunda veya silindiğinde örtük olarak oluşturulur ve silinir.

JobResponse

Name Tür Description
cloudToDeviceMethod

CloudToDeviceMethod

Yöntem türü ve parametreleri. İş türü cloudToDeviceMethod ise bu gereklidir.
createdTime

string

Sistem oluşturuldu. Oluşturma sırasında yoksayılır. İşin oluşturma tarihi ve saati.
deviceJobStatistics

DeviceJobStatistics

İş yürütme durumuyla ilgili ayrıntılar.
endTime

string

Sistem oluşturuldu. Oluşturma sırasında yoksayılır. İşin bitiş tarihi ve saati (UTC).
failureReason

string

Bir hata oluştuysa, hatanın nedeni.
jobId

string

Sistem oluşturuldu. Oluşturma sırasında yoksayılır. İşin benzersiz tanımlayıcısı.
maxExecutionTimeInSeconds

integer

Secounds içindeki en uzun yürütme süresi.
queryCondition

string

Cihaz sorgu koşulu.
startTime

string

UTC olarak zamanlanan işin başlangıç tarihi ve saati.
status enum:
  • cancelled
  • completed
  • enqueued
  • failed
  • queued
  • running
  • scheduled
  • unknown

Sistem oluşturuldu. Oluşturma sırasında yoksayılır. İşin durumu.
statusMessage

string

İşin durum iletisi.
type enum:
  • backup
  • export
  • factoryResetDevice
  • failoverDataCopy
  • firmwareUpdate
  • import
  • readDeviceProperties
  • rebootDevice
  • restoreFromBackup
  • scheduleDeviceMethod
  • scheduleUpdateTwin
  • unknown
  • updateDeviceConfiguration
  • writeDeviceProperties

İş türü.
updateTwin

Twin

Bir cihaz veya modülün durum bilgileri. Bu, IoT Hub ilgili cihaz/modül kimliği oluşturulduğunda veya silindiğinde örtük olarak oluşturulur ve silinir.

Twin

Bir cihaz veya modülün durum bilgileri. Bu, IoT Hub ilgili cihaz/modül kimliği oluşturulduğunda veya silindiğinde örtük olarak oluşturulur ve silinir.

Name Tür Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Cihaz tarafından kullanılan kimlik doğrulama türü.
capabilities

DeviceCapabilities

Cihazda etkinleştirilen özelliklerin durumu.
cloudToDeviceMessageCount

integer

Gönderilen buluttan cihaza ileti sayısı.
connectionState enum:
  • Connected
  • Disconnected

Cihazın bağlantı durumu.
deviceEtag

string

RFC7232 göre cihaz için ETag'i temsil eden dize.
deviceId

string

IoT Hub kimlik kayıt defterindeki cihazın benzersiz tanımlayıcısı. ASCII 7 bit alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı bir dizedir (en fazla 128 karakter uzunluğundadır) ve aşağıdaki özel karakterler :{'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
deviceScope

string

Cihazın kapsamı.
etag

string

RFC7232 göre cihaz ikizi için ETag'i temsil eden dize.
lastActivityTime

string

Cihazın en son bağlanıp aldığı veya ileti gönderdiği tarih ve saat. Tarih ve saat UTC'de ISO8601 tarih saat biçiminde belirtilir; örneğin, 2015-01-28T16:24:48.789Z. Cihaz mesajlaşma işlemlerini gerçekleştirmek için HTTP/1 protokolunu kullanıyorsa bu değer güncelleştirilmez.
moduleId

string

IoT Hub kimlik kayıt defterindeki modülün benzersiz tanımlayıcısı. ASCII 7 bit alfasayısal karakterlerden oluşan büyük/küçük harfe duyarlı bir dizedir (en fazla 128 karakter uzunluğundadır) ve aşağıdaki özel karakterler :{'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

Varsa üst düzey uç cihazların kapsamları. Yalnızca uç cihazlarda kullanılabilir.
properties

TwinProperties

İkizin istenen ve bildirilen özellikleri.
status enum:
  • disabled
  • enabled

Cihazın etkin durumu. Devre dışı bırakılırsa cihaz hizmete bağlanamaz.
statusReason

string

Varsa cihazın geçerli durumunun nedeni.
statusUpdateTime

string

Cihazın durumunun son güncelleştirildiği tarih ve saat.
tags

object

Çözüm arka ucu tarafından okunan ve yazılan anahtar-değer çiftleri koleksiyonu. Bunlar cihaz uygulamaları tarafından görünmez. Bu anahtarlar UTF-8 kodlu, büyük/küçük harfe duyarlı ve en fazla 1 KB uzunluğundadır. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluğu hariç tutar. Değerler, uzunluğu en çok 4 KB olan JSON nesneleridir.
version

integer

Etiketler ve istenen özellikler dahil olmak üzere cihaz ikizinin sürümü
x509Thumbprint

X509Thumbprint

Cihazın X509 parmak izi.

TwinProperties

İkizin istenen ve bildirilen özellikleri. Nesnenin maksimum derinliği 10'dur.

Name Tür Description
desired

object

İstenen özellik anahtar-değer çiftlerinin koleksiyonu. Anahtarlar UTF-8 kodlu, büyük/küçük harfe duyarlı ve en fazla 1 KB uzunluğundadır. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluğu hariç tutar. İstenen porperty değerleri, uzunluğu 4 KB'a kadar olan JSON nesneleridir.
reported

object

Bildirilen özellik anahtar-değer çiftlerinin koleksiyonu. Anahtarlar UTF-8 kodlu, büyük/küçük harfe duyarlı ve en fazla 1 KB uzunluğundadır. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluğu hariç tutar. Bildirilen özellik değerleri, uzunluğu 4 KB'a kadar olan JSON nesneleridir.

X509Thumbprint

Name Tür Description
primaryThumbprint

string

X509 istemci sertifikası birincil parmak izi.
secondaryThumbprint

string

X509 istemci sertifikası ikincil parmak izi.