Modules - Create Or Update Identity

Dienst:

IoT Hub

API-Version:

2021-04-12

Erstellt oder aktualisiert die Modulidentität für ein Gerät im IoT Hub. Die moduleId und generationId können vom Benutzer nicht aktualisiert werden.

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

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
If-Match		string	Die Zeichenfolge, die gemäß RFC7232 ein schwaches ETag für das Modul darstellt. Dies sollte nicht beim Erstellen eines Moduls festgelegt werden, sondern kann beim Aktualisieren eines Moduls festgelegt werden.

Anforderungstext

Name	Typ	Beschreibung
authentication	AuthenticationMechanism	Der Authentifizierungsmechanismus, der vom Modul beim Herstellen einer Verbindung mit dem Dienst und Edgehub verwendet wird.
cloudToDeviceMessageCount	integer	Die Anzahl der Cloud-zu-Modul-Nachrichten, die derzeit in der Warteschlange stehen, um an das Modul gesendet zu werden.
connectionState	enum: Disconnected Connected	Der Verbindungsstatus des Geräts.
connectionStateUpdatedTime	string	Das Datum und die Uhrzeit der letzten Aktualisierung des Verbindungsstatus.
deviceId	string	Der eindeutige Bezeichner des Geräts.
etag	string	Die Zeichenfolge, die gemäß RFC7232 ein schwaches ETag für die Modulidentität darstellt.
generationId	string	Die IoT Hub generierte Zeichenfolge mit einer Länge von bis zu 128 Zeichen unter 128 Zeichen. Dieser Wert wird verwendet, um Module mit derselben moduleId zu unterscheiden, wenn sie gelöscht und neu erstellt wurden.
lastActivityTime	string	Das Datum und die Uhrzeit, zu der das Gerät zuletzt eine Nachricht hergestellt, empfangen oder gesendet hat.
managedBy	string	Legt fest, wer dieses Modul verwaltet. Dieser Wert ist beispielsweise „IotEdge“, wenn die Edge-Runtime Besitzer dieses Modul ist.
moduleId	string	Der eindeutige Bezeichner des Moduls.

Antworten

Name	Typ	Beschreibung
200 OK	Module	OK.
201 Created	Module	Erstellt.

Definitionen

Name	Beschreibung
AuthenticationMechanism
Module	Die Modulidentität auf einem Gerät.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Name	Typ	Beschreibung
symmetricKey	SymmetricKey	Der primäre und sekundäre Schlüssel, der für die SAS-basierte Authentifizierung verwendet wird.
type	enum: certificateAuthority none sas selfSigned	Der Authentifizierungstyp, der zum Herstellen einer Verbindung mit dem Dienst verwendet wird.
x509Thumbprint	X509Thumbprint	Die primären und sekundären x509-Fingerabdruck, die für die x509-basierte Authentifizierung verwendet werden.

Module

Die Modulidentität auf einem Gerät.

Name	Typ	Beschreibung
authentication	AuthenticationMechanism	Der Authentifizierungsmechanismus, der vom Modul beim Herstellen einer Verbindung mit dem Dienst und Edgehub verwendet wird.
cloudToDeviceMessageCount	integer	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	Das Datum und die Uhrzeit der letzten Aktualisierung des Verbindungsstatus.
deviceId	string	Der eindeutige Bezeichner des Geräts.
etag	string	Die Zeichenfolge, die gemäß RFC7232 ein schwaches ETag für die Modulidentität darstellt.
generationId	string	Die IoT Hub generierte Zeichenfolge mit einer Länge von bis zu 128 Zeichen unter 128 Zeichen. Dieser Wert wird verwendet, um Module mit derselben moduleId zu unterscheiden, wenn sie gelöscht und neu erstellt wurden.
lastActivityTime	string	Das Datum und die Uhrzeit, zu der das Gerät zuletzt eine Nachricht hergestellt, empfangen oder gesendet hat.
managedBy	string	Legt fest, wer dieses Modul verwaltet. Dieser Wert ist beispielsweise „IotEdge“, wenn die Edge-Runtime Besitzer dieses Modul ist.
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äre Schlüssel des Geräts.

X509Thumbprint

Name	Typ	Beschreibung
primaryThumbprint	string	Primärer Fingerabdruck des X509-Clientzertifikats.
secondaryThumbprint	string	Sekundärer Fingerabdruck des X509-Clientzertifikats.