Modules - Create Or Update Identity

Létrehozza vagy frissíti egy eszköz modulidentitását a IoT Hub. A felhasználó nem tudja frissíteni a moduleId és a generationId azonosítót.

PUT https://fully-qualified-iothubname.azure-devices.net/devices/{id}/modules/{mid}?api-version=2020-05-31-preview

URI-paraméterek

Name In Kötelező Típus Description
id
path True

string

Az eszköz egyedi azonosítója.

mid
path True

string

A modul egyedi azonosítója.

api-version
query True

string

Az API verziója.

Kérelem fejléce

Name Kötelező Típus Description
If-Match

string

A modul gyenge ETag-jének megfelelő sztring a RFC7232 szerint. Ezt nem szabad beállítani modul létrehozásakor, de a modul frissítésekor be lehet állítani.

Kérelem törzse

Name Típus Description
authentication

AuthenticationMechanism

A modul által a szolgáltatáshoz és az edge hubhoz való csatlakozáskor használt hitelesítési mechanizmus.

cloudToDeviceMessageCount

integer

A modulba jelenleg várólistára helyezett, felhőből modulba irányuló üzenetek száma.

connectionState enum:
  • Disconnected
  • Connected

Az eszköz kapcsolati állapota.

connectionStateUpdatedTime

string

A kapcsolat állapotának utolsó frissítésének dátuma és időpontja.

deviceId

string

Az eszköz egyedi azonosítója.

etag

string

A modulidentitás gyenge ETag-jének megfelelő sztring, a RFC7232 szerint.

generationId

string

A IoT Hub létrehozott, legfeljebb 128 karakter hosszú, kis- és nagybetűkre érzékeny sztring. Ez az érték az azonos modulazonosítóval rendelkező modulok megkülönböztetésére szolgál, amikor törölték és újra létrehozták őket.

lastActivityTime

string

Az eszköz legutóbbi csatlakoztatásának, fogadásának vagy üzenetküldésének dátuma és időpontja.

managedBy

string

Azonosítja, hogy ki kezeli ezt a modult. Ez az érték például "IotEdge", ha a modul a peremhálózati futtatókörnyezet tulajdonában van.

moduleId

string

A modul egyedi azonosítója.

Válaszok

Name Típus Description
200 OK

Module

OK gombra.

201 Created

Module

Létrehozott.

Definíciók

Name Description
AuthenticationMechanism
Module

A modul identitása egy eszközön.

SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Típus Description
symmetricKey

SymmetricKey

A SAS-alapú hitelesítéshez használt elsődleges és másodlagos kulcsok.

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

A szolgáltatáshoz való csatlakozáshoz használt hitelesítés típusa.

x509Thumbprint

X509Thumbprint

Az x509-alapú hitelesítéshez használt elsődleges és másodlagos x509 ujjlenyomatok.

Module

A modul identitása egy eszközön.

Name Típus Description
authentication

AuthenticationMechanism

A modul által a szolgáltatáshoz és az edge hubhoz való csatlakozáskor használt hitelesítési mechanizmus.

cloudToDeviceMessageCount

integer

A modulba jelenleg várólistára helyezett, felhőből modulba irányuló üzenetek száma.

connectionState enum:
  • Connected
  • Disconnected

Az eszköz kapcsolati állapota.

connectionStateUpdatedTime

string

A kapcsolat állapotának utolsó frissítésének dátuma és időpontja.

deviceId

string

Az eszköz egyedi azonosítója.

etag

string

A modulidentitás gyenge ETag-jének megfelelő sztring, a RFC7232 szerint.

generationId

string

A IoT Hub létrehozott, legfeljebb 128 karakter hosszú, kis- és nagybetűkre érzékeny sztring. Ez az érték az azonos modulazonosítóval rendelkező modulok megkülönböztetésére szolgál, amikor törölték és újra létrehozták őket.

lastActivityTime

string

Az eszköz legutóbbi csatlakoztatásának, fogadásának vagy üzenetküldésének dátuma és időpontja.

managedBy

string

Azonosítja, hogy ki kezeli ezt a modult. Ez az érték például "IotEdge", ha a modul a peremhálózati futtatókörnyezet tulajdonában van.

moduleId

string

A modul egyedi azonosítója.

SymmetricKey

Name Típus Description
primaryKey

string

Az eszköz base64 kódolású elsődleges kulcsa.

secondaryKey

string

Az eszköz base64 kódolású másodlagos kulcsa.

X509Thumbprint

Name Típus Description
primaryThumbprint

string

Az X509 ügyféltanúsítvány elsődleges ujjlenyomata.

secondaryThumbprint

string

Az X509 ügyféltanúsítvány másodlagos ujjlenyomata.