Modules - Get Twin
Pobiera bliźniaczą reprezentację modułu. Aby uzyskać więcej informacji, zobacz 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
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
id
|
path | True |
string |
Unikatowy identyfikator urządzenia. |
mid
|
path | True |
string |
Unikatowy identyfikator modułu. |
api-version
|
query | True |
string |
Wersja interfejsu API. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Informacje o stanie modułu. |
Definicje
Nazwa | Opis |
---|---|
Device |
Stan możliwości włączonych na urządzeniu. |
Twin |
Informacje o stanie urządzenia lub modułu. Jest to tworzone i usuwane niejawnie po utworzeniu lub usunięciu odpowiedniej tożsamości urządzenia/modułu w IoT Hub. |
Twin |
Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej. Maksymalna głębokość obiektu wynosi 10. |
X509Thumbprint |
DeviceCapabilities
Stan możliwości włączonych na urządzeniu.
Nazwa | Typ | Opis |
---|---|---|
iotEdge |
boolean |
Właściwość określająca, czy urządzenie jest urządzeniem brzegowym, czy nie. |
Twin
Informacje o stanie urządzenia lub modułu. Jest to tworzone i usuwane niejawnie po utworzeniu lub usunięciu odpowiedniej tożsamości urządzenia/modułu w IoT Hub.
Nazwa | Typ | Opis |
---|---|---|
authenticationType |
enum:
|
Typ uwierzytelniania używany przez urządzenie. |
capabilities |
Stan możliwości włączonych na urządzeniu. |
|
cloudToDeviceMessageCount |
integer |
Liczba wysłanych komunikatów z chmury do urządzenia. |
connectionState |
enum:
|
Stan połączenia urządzenia. |
deviceEtag |
string |
Ciąg reprezentujący element ETag dla urządzenia zgodnie z RFC7232. |
deviceId |
string |
Unikatowy identyfikator urządzenia w rejestrze tożsamości IoT Hub. Jest to ciąg uwzględniający wielkość liter (do 128 znaków długości) znaków alfanumerycznych ASCII 7-bitowych, i następujące znaki specjalne {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}. |
deviceScope |
string |
Zakres urządzenia. |
etag |
string |
Ciąg reprezentujący element ETag dla bliźniaczej reprezentacji urządzenia zgodnie z RFC7232. |
lastActivityTime |
string |
Data i godzina ostatniego połączenia lub odebrania lub wysłania komunikatu przez urządzenie. Data i godzina są oddzielone ISO8601 formacie data/godzina w formacie UTC, na przykład 2015-01-28T16:24:48.789Z. Ta wartość nie jest aktualizowana, jeśli urządzenie używa protokołu HTTP/1 do wykonywania operacji obsługi komunikatów. |
moduleId |
string |
Unikatowy identyfikator modułu w rejestrze tożsamości IoT Hub. Jest to ciąg uwzględniający wielkość liter (do 128 znaków długości) znaków alfanumerycznych ASCII 7-bitowych, i następujące znaki specjalne {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', ''}. |
parentScopes |
string[] |
Zakresy urządzeń brzegowych wyższego poziomu, jeśli ma to zastosowanie. Dostępne tylko dla urządzeń brzegowych. |
properties |
Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej. |
|
status |
enum:
|
Stan włączonego urządzenia. Jeśli to ustawienie jest wyłączone, urządzenie nie może nawiązać połączenia z usługą. |
statusReason |
string |
Przyczyna bieżącego stanu urządzenia, jeśli istnieje. |
statusUpdateTime |
string |
Data i godzina ostatniej aktualizacji stanu urządzenia. |
tags |
object |
Kolekcja par klucz-wartość odczytanych i zapisywanych przez zaplecze rozwiązania. Nie są one widoczne dla aplikacji urządzeń. Klucze są zakodowane w formacie UTF-8, z uwzględnieniem wielkości liter i długości do 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), ".", "$" i spację. Wartości to obiekty JSON o długości do 4 KB. |
version |
integer |
Wersja bliźniaczej reprezentacji urządzenia, w tym tagi i żądane właściwości |
x509Thumbprint |
Odcisk palca X509 urządzenia. |
TwinProperties
Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej. Maksymalna głębokość obiektu wynosi 10.
Nazwa | Typ | Opis |
---|---|---|
desired |
object |
Kolekcja par klucz-wartość żądanej właściwości. Klucze są zakodowane w formacie UTF-8, z uwzględnieniem wielkości liter i długości do 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), ".", "$" i spację. Żądane wartości porperty to obiekty JSON o długości do 4 KB. |
reported |
object |
Kolekcja zgłoszonych par klucz-wartość właściwości. Klucze są zakodowane w formacie UTF-8, z uwzględnieniem wielkości liter i długości do 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), ".", "$" i spację. Zgłoszone wartości właściwości to obiekty JSON o długości do 4 KB. |
X509Thumbprint
Nazwa | Typ | Opis |
---|---|---|
primaryThumbprint |
string |
Podstawowy odcisk palca certyfikatu klienta X509. |
secondaryThumbprint |
string |
Pomocniczy odcisk palca certyfikatu klienta X509. |