Modules - Get Identity

Získá identitu modulu na zařízení.

GET 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.

Odpovědi

Name Typ Description
200 OK

Module

OK.

Definice

Name Description
AuthenticationMechanism
Module

Identita modulu na zařízení.

SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Typ Description
symmetricKey

SymmetricKey

Primární a sekundární klíče používané k ověřování na základě SAS.

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Typ ověřování použitý 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í používaný modulem při připojování ke službě a hraničnímu centru.

cloudToDeviceMessageCount

integer

Počet zpráv typu cloud-modul, které jsou aktuálně ve frontě k odeslání 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 ETag pro identitu modulu podle RFC7232.

generationId

string

IoT Hub vygenerovaný řetězec s rozlišováním velkých a malých písmen o délce až 128 znaků. Tato hodnota slouží k odlišení modulů se stejným moduleId po jejich odstranění a opětovném vytvoření.

lastActivityTime

string

Datum a čas, kdy se zařízení naposledy připojilo, přijalo nebo odeslalo zprávu.

managedBy

string

Určuje, kdo spravuje tento modul. Tato hodnota je například IotEdge, pokud modul runtime Edge vlastní.

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.