Freigeben über


Modules - Get Identity

Ruft eine Modulidentität auf dem Gerät ab.

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}/modules/{mid}?api-version=2021-04-12

URI-Parameter

Name In Erforderlich Typ Beschreibung
id
path True

string

Der eindeutige Bezeichner des Geräts.

mid
path True

string

Der eindeutige Bezeichner des Moduls.

api-version
query True

string

Version der API.

Antworten

Name Typ Beschreibung
200 OK

Module

OKAY.

Definitionen

Name Beschreibung
AuthenticationMechanism
Module

Die Modulidentität auf einem Gerät.

SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name Typ Beschreibung
symmetricKey

SymmetricKey

Die primären und sekundären Schlüssel, die für die SAS-basierte Authentifizierung verwendet werden.

type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Der Typ der Authentifizierung, die zum Herstellen einer Verbindung mit dem Dienst verwendet wird.

x509Thumbprint

X509Thumbprint

Die primären und sekundären x509-Fingerabdrucke, die für die x509-basierte Authentifizierung verwendet werden.

Module

Die Modulidentität auf einem Gerät.

Name Typ Beschreibung
authentication

AuthenticationMechanism

Der vom Modul beim Herstellen einer Verbindung mit dem Dienst und edge-Hub verwendete Authentifizierungsmechanismus.

cloudToDeviceMessageCount

integer (int32)

Die Anzahl der Cloud-zu-Modul-Nachrichten, die derzeit in der Warteschlange stehen, um an das Modul gesendet zu werden.

connectionState enum:
  • Connected
  • Disconnected

Der Verbindungsstatus des Geräts.

connectionStateUpdatedTime

string (date-time)

Datum und Uhrzeit der letzten Aktualisierung des Verbindungsstatus.

deviceId

string

Der eindeutige Bezeichner des Geräts.

etag

string

Die Zeichenfolge, die ein schwaches ETag für die Modulidentität gemäß RFC7232 darstellt.

generationId

string

Die generierte IoT Hub-Zeichenfolge mit Groß-/Kleinschreibung bis zu 128 Zeichen lang. Dieser Wert wird verwendet, um Module mit derselben moduleId zu unterscheiden, wenn sie gelöscht und neu erstellt wurden.

lastActivityTime

string (date-time)

Das Datum und die Uhrzeit, zu der das Gerät zuletzt verbunden, empfangen oder eine Nachricht gesendet hat.

managedBy

string

Legt fest, wer dieses Modul verwaltet. Dieser Wert ist z. B. "IotEdge", wenn die Edgelaufzeit dieses Modul besitzt.

moduleId

string

Der eindeutige Bezeichner des Moduls.

SymmetricKey

Name Typ Beschreibung
primaryKey

string

Der base64-codierte Primärschlüssel des Geräts.

secondaryKey

string

Der base64-codierte Sekundärschlüssel des Geräts.

X509Thumbprint

Name Typ Beschreibung
primaryThumbprint

string

Der primäre Fingerabdruck des X509-Clientzertifikats.

secondaryThumbprint

string

Sekundärer Fingerabdruck des X509-Clientzertifikats.