Modules - Create Or Update Identity

Service:

IoT Hub

API Version:

2020-05-31-preview

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

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

Paramètres URI

Name	In	Required	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.

En-tête de la demande

Name	Required	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.

Corps de la demande

Name	Type	Description
authentication	AuthenticationMechanism	Mécanisme d’authentification utilisé par le module lors de la connexion au service et au hub edge.
cloudToDeviceMessageCount	integer	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 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	La IoT Hub chaîne sensible à la casse 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 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.

Réponses

Name	Type	Description
200 OK	Module	OK.
201 Created	Module	Créé.

Définitions

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

AuthenticationMechanism

Name	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 x509.

Module

Identité du module sur un appareil.

Name	Type	Description
authentication	AuthenticationMechanism	Mécanisme d’authentification utilisé par le module lors de la connexion au service et au hub edge.
cloudToDeviceMessageCount	integer	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 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	La IoT Hub chaîne sensible à la casse 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 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.

SymmetricKey

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

X509Thumbprint

Name	Type	Description
primaryThumbprint	string	Empreinte principale du certificat client X509.
secondaryThumbprint	string	Empreinte secondaire du certificat client X509.