Modules - Create Or Update Identity

Služba:

IoT Hub

Verze rozhraní API:

2021-04-12

Vytvoří nebo aktualizuje identitu modulu pro zařízení ve službě IoT Hub. Id modulu 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. Tato možnost by se neměla nastavit při vytváření modulu, ale může být nastavená při aktualizaci modulu.

Text požadavku

Name	Typ	Description
authentication	AuthenticationMechanism	Mechanismus ověřování používaný modulem při připojování ke službě a hraničnímu centru.
cloudToDeviceMessageCount	integer (int32)	Počet zpráv cloud-to-module, které se mají do modulu odeslat do fronty.
connectionState	enum: Disconnected Connected	Stav připojení zařízení.
connectionStateUpdatedTime	string (date-time)	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 rozlišující velká a malá písmena vygenerovaný službou IoT Hub o délce až 128 znaků. Tato hodnota se používá k rozlišení modulů se stejným ID modulu, když byly odstraněny a znovu vytvořeny.
lastActivityTime	string (date-time)	Datum a čas posledního připojení, přijetí nebo odeslání zprávy zařízení.
managedBy	string	Identifikuje, 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řil.

Definice

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

AuthenticationMechanism

Objekt

Name	Typ	Description
symmetricKey	SymmetricKey	Primární a sekundární klíče používané pro ověřování na základě SAS.
type	enum: certificateAuthority none sas selfSigned	Typ ověřování sloužící k 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

Objekt

Identita modulu na zařízení.

Name	Typ	Description
authentication	AuthenticationMechanism	Mechanismus ověřování používaný modulem při připojování ke službě a hraničnímu centru.
cloudToDeviceMessageCount	integer (int32)	Počet zpráv cloud-to-module, které se mají do modulu odeslat do fronty.
connectionState	enum: Connected Disconnected	Stav připojení zařízení.
connectionStateUpdatedTime	string (date-time)	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 rozlišující velká a malá písmena vygenerovaný službou IoT Hub o délce až 128 znaků. Tato hodnota se používá k rozlišení modulů se stejným ID modulu, když byly odstraněny a znovu vytvořeny.
lastActivityTime	string (date-time)	Datum a čas posledního připojení, přijetí nebo odeslání zprávy zařízení.
managedBy	string	Identifikuje, 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

Objekt

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

X509Thumbprint

Objekt

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.