Aracılığıyla paylaş

Modules - Replace Twin

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

Modül ikizinin etiketlerini ve istenen özelliklerini değiştirir. Daha fazla bilgi için bkz. https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

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

URI Parametreleri

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

string

Cihazın benzersiz tanımlayıcısı.
mid
 path True

string

Modülün benzersiz tanımlayıcısı.
api-version
 query True

string

Api sürümü.

İstek Başlığı

Name Gerekli Tür Description
If-Match

string

RFC7232 göre cihaz ikizi için zayıf bir ETag'i temsil eden dize. Değiştirme işleminin gerçekleştirilmesi gerekip gerekmediğini belirler.

İstek Gövdesi

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

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

DeviceCapabilities

Cihazda etkinleştirilen özelliklerin durumu.
cloudToDeviceMessageCount

integer (int32)

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

Cihazın bağlantı durumu.
deviceEtag

string

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

string

IoT Hub'ın 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ğunda), 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 (date-time)

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'ın 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ğunda), ve aşağıdaki özel karakterler {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

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

TwinProperties

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

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 (date-time)

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ına görünmez. Bu anahtarlar UTF-8 kodlu, büyük/küçük harfe duyarlı ve 1 KB uzunluğunda up-to. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluklarını dışlar. Değerler, 4 KB uzunluğunda up-to JSON nesneleridir.
version

integer (int64)

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

X509Thumbprint

Cihazın X509 parmak izi.

Yanıtlar

Name Tür Description
200 OK

Twin

TAMAM.

Tanımlar

Name Description
DeviceCapabilities

Cihazda etkinleştirilen özelliklerin durumu.
Twin

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

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

DeviceCapabilities

Object

Cihazda etkinleştirilen özelliklerin durumu.

Name Tür Description
iotEdge

boolean

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

Twin

Object

Bir cihaz veya modülün durum bilgileri. IoT Hub'da ilgili cihaz/modül kimliği oluşturulduğunda veya silindiğinde bu ö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 (int32)

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'ın 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ğunda), 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 (date-time)

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'ın 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ğunda), ve aşağıdaki özel karakterler {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
parentScopes

string[]

Varsa üst düzey uç cihazların kapsamları. Yalnızca uç cihazlar için 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 (date-time)

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ına görünmez. Bu anahtarlar UTF-8 kodlu, büyük/küçük harfe duyarlı ve 1 KB uzunluğunda up-to. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluklarını dışlar. Değerler, 4 KB uzunluğunda up-to JSON nesneleridir.
version

integer (int64)

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

X509Thumbprint

Cihazın X509 parmak izi.

TwinProperties

Object

İ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 1 KB uzunluğunda up-to. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluklarını dışlar. İstenen gözenekli değerler JSON nesneleridir up-to 4 KB uzunluğundadır.
reported

object

Bildirilen özellik anahtar-değer çiftlerinin koleksiyonu. Anahtarlar UTF-8 kodlu, büyük/küçük harfe duyarlı ve 1 KB uzunluğunda up-to. İzin verilen karakterler UNICODE denetim karakterlerini (C0 ve C1 kesimleri), '.', '$' ve boşluklarını dışlar. Bildirilen özellik değerleri 4 KB uzunluğunda up-to JSON nesneleridir.

X509Thumbprint

Object
Name Tür Description
primaryThumbprint

string

X509 istemci sertifikası birincil parmak izi.
secondaryThumbprint

string

X509 istemci sertifikası ikincil parmak izi.