Modules - Create Or Update Identity

Crée ou met à jour l’identité du module pour un appareil dans IoT Hub. Impossible de mettre à jour moduleId et generationId par l’utilisateur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
id	path	True	string	Identificateur unique de l’appareil.
mid	path	True	string	Identificateur unique du module.
api-version	query	True	string	Version de l’API.

Nom	Obligatoire	Type	Description
If-Match		string	Chaîne représentant un ETag faible pour le module, conformément à RFC7232. Cela ne doit pas être défini lors de la création d’un module, mais peut être défini lors de la mise à jour d’un module.

Nom	Type	Description
authentication	AuthenticationMechanism	Mécanisme d’authentification utilisé par le module lors de la connexion au service et au hub edge.
cloudToDeviceMessageCount	integer (int32)	Nombre de messages cloud-à-module actuellement mis en file d’attente à envoyer au module.
connectionState	enum: Disconnected Connected	État de connexion de l’appareil.
connectionStateUpdatedTime	string (date-time)	Date et heure de la dernière mise à jour de l’état de connexion.
deviceId	string	Identificateur unique de l’appareil.
etag	string	Chaîne représentant un ETag faible pour l’identité du module, conformément à RFC7232.
generationId	string	Chaîne sensible à la casse générée par IoT Hub jusqu’à 128 caractères. Cette valeur est utilisée pour distinguer les modules avec le même moduleId, lorsqu’ils ont été supprimés et recréés.
lastActivityTime	string (date-time)	Date et heure de la dernière connexion, réception ou envoi d’un message sur l’appareil.
managedBy	string	Identifie qui gère ce module. Par exemple, cette valeur est « IotEdge » si le runtime edge possède ce module.
moduleId	string	Identificateur unique du module.

Nom	Type	Description
200 OK	Module	D’ACCORD.
201 Created	Module	Créé.

Nom	Description
AuthenticationMechanism
Module	Identité du module sur un appareil.
SymmetricKey
X509Thumbprint

Object

Nom	Type	Description
symmetricKey	SymmetricKey	Clés primaires et secondaires utilisées pour l’authentification basée sur SAP.
type	enum: certificateAuthority none sas selfSigned	Type d’authentification utilisé pour se connecter au service.
x509Thumbprint	X509Thumbprint	Empreintes principales et secondaires x509 utilisées pour l’authentification basée sur x509.

Object

Identité du module sur un appareil.

Nom	Type	Description
authentication	AuthenticationMechanism	Mécanisme d’authentification utilisé par le module lors de la connexion au service et au hub edge.
cloudToDeviceMessageCount	integer (int32)	Nombre de messages cloud-à-module actuellement mis en file d’attente à envoyer au module.
connectionState	enum: Connected Disconnected	État de connexion de l’appareil.
connectionStateUpdatedTime	string (date-time)	Date et heure de la dernière mise à jour de l’état de connexion.
deviceId	string	Identificateur unique de l’appareil.
etag	string	Chaîne représentant un ETag faible pour l’identité du module, conformément à RFC7232.
generationId	string	Chaîne sensible à la casse générée par IoT Hub jusqu’à 128 caractères. Cette valeur est utilisée pour distinguer les modules avec le même moduleId, lorsqu’ils ont été supprimés et recréés.
lastActivityTime	string (date-time)	Date et heure de la dernière connexion, réception ou envoi d’un message sur l’appareil.
managedBy	string	Identifie qui gère ce module. Par exemple, cette valeur est « IotEdge » si le runtime edge possède ce module.
moduleId	string	Identificateur unique du module.

Object

Nom	Type	Description
primaryKey	string	Clé primaire encodée en base64 de l’appareil.
secondaryKey	string	Clé secondaire encodée en base64 de l’appareil.

Object

Nom	Type	Description
primaryThumbprint	string	Empreinte numérique principale du certificat client X509.
secondaryThumbprint	string	Empreinte numérique secondaire du certificat client X509.