Modules - Create Or Update Identity
Crée ou met à jour l’identité de module pour un appareil dans le IoT Hub. L’id de module et l’id de génération ne peuvent pas être mis à jour par l’utilisateur.
PUT https://fully-qualified-iothubname.azure-devices.net/devices/{id}/modules/{mid}?api-version=2021-04-12Paramè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. |
En-tête de la demande
| 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 l’être lors de la mise à jour d’un module. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| authentication |
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:
|
État de connexion de l’appareil. |
| connectionStateUpdatedTime |
string |
Date et heure de la dernière mise à jour de l’état de la connexion. |
| deviceId |
string |
Identificateur unique de l’appareil. |
| etag |
string |
Chaîne représentant un ETag faible pour l’identité de module, conformément à RFC7232. |
| generationId |
string |
La chaîne IoT Hub générée, qui respecte 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 à 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
| Nom | Type | Description |
|---|---|---|
| 200 OK |
OK. |
|
| 201 Created |
Créé. |
Définitions
| Nom | Description |
|---|---|
|
Authentication |
|
| Module |
Identité du module sur un appareil. |
|
Symmetric |
|
| X509Thumbprint |
AuthenticationMechanism
| Nom | Type | Description |
|---|---|---|
| symmetricKey |
Clés primaires et secondaires utilisées pour l’authentification basée sur SAS. |
|
| type |
enum:
|
Type d’authentification utilisé pour se connecter au service. |
| x509Thumbprint |
Empreintes x509 primaires et secondaires utilisées pour l’authentification basée sur x509. |
Module
Identité du module sur un appareil.
| Nom | Type | Description |
|---|---|---|
| authentication |
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:
|
État de connexion de l’appareil. |
| connectionStateUpdatedTime |
string |
Date et heure de la dernière mise à jour de l’état de la connexion. |
| deviceId |
string |
Identificateur unique de l’appareil. |
| etag |
string |
Chaîne représentant un ETag faible pour l’identité de module, conformément à RFC7232. |
| generationId |
string |
La chaîne IoT Hub générée, qui respecte 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 à 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
| 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. |
X509Thumbprint
| Nom | Type | Description |
|---|---|---|
| primaryThumbprint |
string |
Empreinte primaire du certificat client X509. |
| secondaryThumbprint |
string |
Empreinte secondaire du certificat client X509. |