Modules - Get Twin

Szolgáltatás:

IoT Hub

API-verzió:

2021-04-12

Lekéri a modul ikerpéldányát. További információ: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

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

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.

Válaszok

Name	Típus	Description
200 OK	Twin	A modul állapotadatai.

Definíciók

Name	Description
DeviceCapabilities	Az eszközön engedélyezett képességek állapota.
Twin	Az eszköz vagy modul állapotadatai. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz/ modul identitása létrejön vagy törlődik 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 vagy sem.

Twin

Az eszköz vagy modul állapotadatai. Ez implicit módon jön létre és törlődik, amikor a megfelelő eszköz/ modul identitása létrejön vagy törlődik 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, fogadott vagy üzenetet 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 utolsó frissítésének dátuma és időpontja.
tags	object	Kulcs-érték párok gyűjteménye, amelyeket a megoldás háttérrendszere olvas és ír. Nem láthatók az eszközalkalmazások számára. Ezek a kulcsok UTF-8 kódolású, kis- és nagybetűkre érzékenyek, és akár 1 KB hosszúak is. Az engedélyezett karakterek nem tartalmazzák a UNICODE vezérlőkaraktereket (C0 és C1 szegmens), 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 címkékkel és kívánt tulajdonságokkal
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, a kis- és nagybetűk megkülönböztetése és akár 1 KB hosszúak. Az engedélyezett karakterek nem tartalmazzák a UNICODE vezérlőkaraktereket (C0 és C1 szegmens), 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, a kis- és nagybetűk megkülönböztetése és akár 1 KB hosszúak. Az engedélyezett karakterek nem tartalmazzák a UNICODE vezérlőkaraktereket (C0 és C1 szegmens), a ".", a "$" és a szóközt. A jelentett tulajdonságértékek JSON-objektumok, legfeljebb 4 KB hosszúságúak.

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.