Modules - Update Twin

  • Referencia
Service:
IoT Hub
API Version:
2020-05-31-preview

Frissítések egy moduli ikerpéldány címkéinek és kívánt tulajdonságainak. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

PATCH https://fully-qualified-iothubname.azure-devices.net/twins/{id}/modules/{mid}?api-version=2020-05-31-preview

URI-paraméterek

Name In Kötelező Típus Description
id
 path True

string

Az eszköz egyedi azonosítója.
mid
 path True

string

A modul egyedi azonosítója.
api-version
 query True

string

Az API verziója.

Kérelem fejléce

Name Kötelező Típus Description
If-Match

string

Az ikereszköz gyenge ETag-jének megfelelő sztring, a RFC7232 szerint. Meghatározza, hogy a frissítési műveletet végre kell-e hajtani.

Kérelem törzse

Name Típus Description
authenticationType enum:
  • sas
  • selfSigned
  • certificateAuthority
  • none

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:
  • Disconnected
  • Connected

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: {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}.
properties

TwinProperties

Az ikerpéldány kívánt és jelentett tulajdonságai.
status enum:
  • enabled
  • disabled

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.

Válaszok

Name Típus Description
200 OK

Twin

OK gombra.

Definíciók

Name Description
DeviceCapabilities

Az eszközön engedélyezett képességek állapota.
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

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.

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: {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}.
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.