Modules - Update Twin

Služba:

IoT Hub

Verze rozhraní API:

2021-04-12

Aktualizace značky a požadované vlastnosti dvojčete modulu. Další informace naleznete v tématu 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=2021-04-12

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
id	path	True	string	Jedinečný identifikátor zařízení.
mid	path	True	string	Jedinečný identifikátor modulu.
api-version	query	True	string	Verze rozhraní API.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match		string	Řetězec představující slabou ETag pro dvojče zařízení podle RFC7232. Určuje, jestli se má provést operace aktualizace.

Text požadavku

Name	Typ	Description
authenticationType	enum: sas selfSigned certificateAuthority none	Typ ověřování používaný zařízením.
capabilities	DeviceCapabilities	Stav funkcí povolených na zařízení.
cloudToDeviceMessageCount	integer	Počet odeslaných zpráv typu cloud-zařízení.
connectionState	enum: Disconnected Connected	Stav připojení zařízení.
deviceEtag	string	Řetězec představující ETag zařízení podle RFC7232.
deviceId	string	Jedinečný identifikátor zařízení v registru identit IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků) 7bitových alfanumerických znaků ASCII. a následující speciální znaky {-', ':', '.', '+', '%', '_', '#', '*', '?', '!', ',', ',', '=', '@', ';', '$', ''}.
deviceScope	string	Rozsah zařízení.
etag	string	Řetězec představující ETag dvojčete zařízení podle RFC7232.
lastActivityTime	string	Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu. Datum a čas jsou v ISO8601 formátu datetime ve formátu UTC, například 2015-01-28T16:24:48.789Z. Tato hodnota se neaktualizuje, pokud zařízení k provádění operací zasílání zpráv používá protokol HTTP/1.
moduleId	string	Jedinečný identifikátor modulu v registru identit IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků) 7bitových alfanumerických znaků ASCII. a následující speciální znaky {-', ':', '.', '+', '%', '_', '#', '*', '?', '!', ',', ',', '=', '@', ';', '$', ''}.
parentScopes	string[]	Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. K dispozici pouze pro hraniční zařízení.
properties	TwinProperties	Požadované a hlášené vlastnosti dvojčete.
status	enum: enabled disabled	Stav povoleného zařízení. Pokud je tato možnost zakázaná, zařízení se nemůže ke službě připojit.
statusReason	string	Důvod aktuálního stavu zařízení, pokud existuje.
statusUpdateTime	string	Datum a čas poslední aktualizace stavu zařízení.
tags	object	Kolekce párů klíč-hodnota, které back-end řešení načítá a zapisuje. Nejsou viditelné aplikacím zařízení. Jejich klíče jsou kódované UTF-8, rozlišují se velká a malá písmena a mají délku až 1 kB. Povolené znaky nezahrnují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Hodnoty jsou objekty JSON o délce až 4 kB.
version	integer	Verze dvojčete zařízení včetně značek a požadovaných vlastností
x509Thumbprint	X509Thumbprint	Kryptografický otisk zařízení X509.

Odpovědi

Name	Typ	Description
200 OK	Twin	OK.

Definice

Name	Description
DeviceCapabilities	Stav funkcí povolených na zařízení.
Twin	Informace o stavu zařízení nebo modulu Ten se implicitně vytvoří a odstraní při vytvoření nebo odstranění odpovídající identity zařízení nebo modulu v IoT Hub.
TwinProperties	Požadované a hlášené vlastnosti dvojčete. Maximální hloubka objektu je 10.
X509Thumbprint

DeviceCapabilities

Stav funkcí povolených na zařízení.

Name	Typ	Description
iotEdge	boolean	Vlastnost, která určuje, jestli je zařízení hraničním zařízením, nebo ne.

Twin

Informace o stavu zařízení nebo modulu Ten se implicitně vytvoří a odstraní při vytvoření nebo odstranění odpovídající identity zařízení nebo modulu v IoT Hub.

Name	Typ	Description
authenticationType	enum: certificateAuthority none sas selfSigned	Typ ověřování používaný zařízením.
capabilities	DeviceCapabilities	Stav funkcí povolených na zařízení.
cloudToDeviceMessageCount	integer	Počet odeslaných zpráv typu cloud-zařízení.
connectionState	enum: Connected Disconnected	Stav připojení zařízení.
deviceEtag	string	Řetězec představující ETag zařízení podle RFC7232.
deviceId	string	Jedinečný identifikátor zařízení v registru identit IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků) 7bitových alfanumerických znaků ASCII. a následující speciální znaky {-', ':', '.', '+', '%', '_', '#', '*', '?', '!', ',', ',', '=', '@', ';', '$', ''}.
deviceScope	string	Rozsah zařízení.
etag	string	Řetězec představující ETag dvojčete zařízení podle RFC7232.
lastActivityTime	string	Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu. Datum a čas jsou v ISO8601 formátu datetime ve formátu UTC, například 2015-01-28T16:24:48.789Z. Tato hodnota se neaktualizuje, pokud zařízení k provádění operací zasílání zpráv používá protokol HTTP/1.
moduleId	string	Jedinečný identifikátor modulu v registru identit IoT Hub. Jedná se o řetězec rozlišující velká a malá písmena (až 128 znaků) 7bitových alfanumerických znaků ASCII. a následující speciální znaky {-', ':', '.', '+', '%', '_', '#', '*', '?', '!', ',', ',', '=', '@', ';', '$', ''}.
parentScopes	string[]	Rozsahy hraničních zařízení horní úrovně, pokud jsou k dispozici. K dispozici pouze pro hraniční zařízení.
properties	TwinProperties	Požadované a hlášené vlastnosti dvojčete.
status	enum: disabled enabled	Stav povoleného zařízení. Pokud je tato možnost zakázaná, zařízení se nemůže ke službě připojit.
statusReason	string	Důvod aktuálního stavu zařízení, pokud existuje.
statusUpdateTime	string	Datum a čas poslední aktualizace stavu zařízení.
tags	object	Kolekce párů klíč-hodnota, které back-end řešení načítá a zapisuje. Nejsou viditelné aplikacím zařízení. Jejich klíče jsou kódované UTF-8, rozlišují se velká a malá písmena a mají délku až 1 kB. Povolené znaky nezahrnují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Hodnoty jsou objekty JSON o délce až 4 kB.
version	integer	Verze dvojčete zařízení včetně značek a požadovaných vlastností
x509Thumbprint	X509Thumbprint	Kryptografický otisk zařízení X509.

TwinProperties

Požadované a hlášené vlastnosti dvojčete. Maximální hloubka objektu je 10.

Name	Typ	Description
desired	object	Kolekce požadovaných párů klíč-hodnota vlastnosti. Klíče mají kódování UTF-8, rozlišují se velká a malá písmena a délku až 1 kB. Povolené znaky nezahrnují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Požadované hodnoty porperty jsou objekty JSON o délce až 4 kB.
reported	object	Kolekce hlášených párů klíč-hodnota vlastnosti. Klíče mají kódování UTF-8, rozlišují se velká a malá písmena a délku až 1 kB. Povolené znaky nezahrnují řídicí znaky UNICODE (segmenty C0 a C1), ., $a mezeru. Hlášené hodnoty vlastností jsou objekty JSON o délce až 4 kB.

X509Thumbprint

Name	Typ	Description
primaryThumbprint	string	Primární kryptografický otisk klientského certifikátu X509.
secondaryThumbprint	string	Sekundární kryptografický otisk klientského certifikátu X509.