Devices - Update Twin

Usługa:

IoT Hub

Wersja interfejsu API:

2021-04-12

Aktualizuje tagi i żądane właściwości bliźniaczej reprezentacji urządzenia. Aby uzyskać więcej informacji, zobacz https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
id	path	True	string	Unikatowy identyfikator urządzenia.
api-version	query	True	string	Wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match		string	Ciąg reprezentujący słaby element ETag dla bliźniaczej reprezentacji urządzenia zgodnie z RFC7232. Określa, czy należy przeprowadzić operację aktualizacji.

Treść żądania

Nazwa	Typ	Opis
authenticationType	enum: sas selfSigned certificateAuthority none	Typ uwierzytelniania używany przez urządzenie.
capabilities	DeviceCapabilities	Stan możliwości włączonych na urządzeniu.
cloudToDeviceMessageCount	integer (int32)	Liczba wysłanych komunikatów z chmury do urządzenia.
connectionState	enum: Disconnected Connected	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 usługi 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 (date-time)	Data i godzina ostatniego połączenia lub odebrania lub wysłania komunikatu przez urządzenie. Data i godzina są oddzielone w formacie ISO8601 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 usługi 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 najwyższego poziomu, jeśli ma to zastosowanie. Dostępne tylko dla urządzeń brzegowych.
properties	TwinProperties	Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej.
status	enum: enabled disabled	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 (date-time)	Data i godzina ostatniej aktualizacji stanu urządzenia.
tags	object	Kolekcja par klucz-wartość odczytanych i zapisanych 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 up-to długości 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), '.', '$' i spacji. Wartości to obiekty JSON, up-to długości 4 KB.
version	integer (int64)	Wersja bliźniaczej reprezentacji urządzenia, w tym tagi i żądane właściwości
x509Thumbprint	X509Thumbprint	Odcisk palca X509 urządzenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Twin	OK.

Definicje

Nazwa	Opis
DeviceCapabilities	Stan możliwości włączonych na urządzeniu.
Twin	Informacje o stanie urządzenia lub modułu. Jest to niejawnie tworzone i usuwane po utworzeniu lub usunięciu odpowiedniej tożsamości urządzenia/modułu w usłudze IoT Hub.
TwinProperties	Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej. Maksymalna głębokość obiektu wynosi 10.
X509Thumbprint

DeviceCapabilities

Objekt

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

Objekt

Informacje o stanie urządzenia lub modułu. Jest to niejawnie tworzone i usuwane po utworzeniu lub usunięciu odpowiedniej tożsamości urządzenia/modułu w usłudze IoT Hub.

Nazwa	Typ	Opis
authenticationType	enum: certificateAuthority none sas selfSigned	Typ uwierzytelniania używany przez urządzenie.
capabilities	DeviceCapabilities	Stan możliwości włączonych na urządzeniu.
cloudToDeviceMessageCount	integer (int32)	Liczba wysłanych komunikatów z chmury do urządzenia.
connectionState	enum: Connected Disconnected	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 usługi 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 (date-time)	Data i godzina ostatniego połączenia lub odebrania lub wysłania komunikatu przez urządzenie. Data i godzina są oddzielone w formacie ISO8601 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 usługi 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 najwyższego poziomu, jeśli ma to zastosowanie. Dostępne tylko dla urządzeń brzegowych.
properties	TwinProperties	Żądane i zgłoszone właściwości bliźniaczej reprezentacji bliźniaczej.
status	enum: disabled enabled	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 (date-time)	Data i godzina ostatniej aktualizacji stanu urządzenia.
tags	object	Kolekcja par klucz-wartość odczytanych i zapisanych 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 up-to długości 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), '.', '$' i spacji. Wartości to obiekty JSON, up-to długości 4 KB.
version	integer (int64)	Wersja bliźniaczej reprezentacji urządzenia, w tym tagi i żądane właściwości
x509Thumbprint	X509Thumbprint	Odcisk palca X509 urządzenia.

TwinProperties

Objekt

Żą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 up-to długości 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), '.', '$' i spacji. Żądane wartości porperty to obiekty JSON, up-to długości 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 up-to długości 1 KB. Dozwolone znaki wykluczają znaki sterujące UNICODE (segmenty C0 i C1), '.', '$' i spacji. Zgłoszone wartości właściwości to obiekty JSON, up-to długości 4 KB.

X509Thumbprint

Objekt

Nazwa	Typ	Opis
primaryThumbprint	string	Podstawowy odcisk palca certyfikatu klienta X509.
secondaryThumbprint	string	Pomocniczy odcisk palca certyfikatu klienta X509.