Modules - Create Or Update Identity

Služba:

IoT Hub

Verze rozhraní API:

2021-04-12

Vytvoří nebo aktualizuje identitu modulu pro zařízení v IoT Hub. ModuleId a generationId nemůže uživatel aktualizovat.

PUT https://fully-qualified-iothubname.azure-devices.net/devices/{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 značku ETag pro modul podle RFC7232. Toto nastavení by nemělo být nastaveno při vytváření modulu, ale může být nastaveno při aktualizaci modulu.

Text požadavku

Name	Typ	Description
authentication	AuthenticationMechanism	Mechanismus ověřování, který modul používá při připojování ke službě a hraničnímu centru.
cloudToDeviceMessageCount	integer	Počet aktuálně zařazených zpráv typu cloud-modul do fronty, které se mají odeslat do modulu.
connectionState	enum: Disconnected Connected	Stav připojení zařízení.
connectionStateUpdatedTime	string	Datum a čas poslední aktualizace stavu připojení
deviceId	string	Jedinečný identifikátor zařízení.
etag	string	Řetězec představující slabou značku ETag pro identitu modulu podle RFC7232.
generationId	string	Vygenerovaný řetězec IoT Hub s rozlišováním velkých a malých písmen o délce až 128 znaků. Tato hodnota se používá k odlišení modulů se stejným moduleId, když byly odstraněny a znovu vytvořeny.
lastActivityTime	string	Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu.
managedBy	string	Určuje, kdo tento modul spravuje. Tato hodnota je například IotEdge, pokud modul runtime Edge vlastní tento modul.
moduleId	string	Jedinečný identifikátor modulu.

Odpovědi

Name	Typ	Description
200 OK	Module	OK.
201 Created	Module	Vytvořen.

Definice

Name	Description
AuthenticationMechanism
Module	Identita modulu na zařízení.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name	Typ	Description
symmetricKey	SymmetricKey	Primární a sekundární klíč používaný pro ověřování na základě SAS.
type	enum: certificateAuthority none sas selfSigned	Typ ověřování, který se používá pro připojení ke službě.
x509Thumbprint	X509Thumbprint	Primární a sekundární kryptografické otisky x509 používané pro ověřování na základě x509.

Module

Identita modulu na zařízení.

Name	Typ	Description
authentication	AuthenticationMechanism	Mechanismus ověřování, který modul používá při připojování ke službě a hraničnímu centru.
cloudToDeviceMessageCount	integer	Počet aktuálně zařazených zpráv typu cloud-modul do fronty, které se mají odeslat do modulu.
connectionState	enum: Connected Disconnected	Stav připojení zařízení.
connectionStateUpdatedTime	string	Datum a čas poslední aktualizace stavu připojení
deviceId	string	Jedinečný identifikátor zařízení.
etag	string	Řetězec představující slabou značku ETag pro identitu modulu podle RFC7232.
generationId	string	Vygenerovaný řetězec IoT Hub s rozlišováním velkých a malých písmen o délce až 128 znaků. Tato hodnota se používá k odlišení modulů se stejným moduleId, když byly odstraněny a znovu vytvořeny.
lastActivityTime	string	Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu.
managedBy	string	Určuje, kdo tento modul spravuje. Tato hodnota je například IotEdge, pokud modul runtime Edge vlastní tento modul.
moduleId	string	Jedinečný identifikátor modulu.

SymmetricKey

Name	Typ	Description
primaryKey	string	Primární klíč zařízení kódovaný jako base64.
secondaryKey	string	Sekundární klíč zařízení kódovaný jako base64.

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.