Devices - Update Twin
Mises à jour les balises et les propriétés souhaitées d’un jumeau d’appareil. Consultez la rubrique https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins (éventuellement en anglais) pour plus d'informations.
PATCH https://fully-qualified-iothubname.azure-devices.net/twins/{id}?api-version=2020-05-31-previewParamètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
id
|
path | True |
string |
Identificateur unique de l’appareil. |
|
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 jumeau d’appareil, conformément RFC7232. Il détermine si l’opération de mise à jour doit être effectuée. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| authenticationType |
enum:
|
Type d’authentification utilisé par l’appareil. |
| capabilities |
Status des fonctionnalités activées sur l’appareil. |
|
| cloudToDeviceMessageCount |
integer |
Nombre de messages cloud-à-appareil envoyés. |
| connectionState |
enum:
|
État de connexion de l’appareil. |
| deviceEtag |
string |
Chaîne représentant un ETag pour l’appareil, conformément à RFC7232. |
| deviceId |
string |
Identificateur unique de l’appareil dans le registre d’identités du IoT Hub. Il s’agit d’une chaîne respectant la casse (jusqu’à 128 caractères de long) de caractères alphanumériques ASCII 7 bits, et les caractères spéciaux suivants {'-', ' :', '.', '+', '%', '_', '#', '*', ' ?', ' !', '(', ')', ',', '@', ' ;', '$', ''}. |
| deviceScope |
string |
Portée de l’appareil. |
| etag |
string |
Chaîne représentant un ETag pour le jumeau d’appareil, conformément RFC7232. |
| lastActivityTime |
string |
Date et heure auxquelles l’appareil s’est connecté ou a reçu ou envoyé un message. La date et l’heure sont saisies dans ISO8601 format dateheure au format UTC, par exemple, 2015-01-28T16 :24 :48.789Z. Cette valeur n’est pas mise à jour si l’appareil utilise le protocole HTTP/1 pour effectuer des opérations de messagerie. |
| moduleId |
string |
Identificateur unique du module dans le registre d’identités du IoT Hub. Il s’agit d’une chaîne respectant la casse (jusqu’à 128 caractères de long) de caractères alphanumériques ASCII 7 bits, et les caractères spéciaux suivants {'-', ' :', '.', '+', '%', '_', '#', '*', ' ?', ' !', '(', ')', ',', '@', ' ;', '$', ''}. |
| properties |
Propriétés souhaitées et signalées du jumeau. |
|
| status |
enum:
|
Status activé de l’appareil. S’il est désactivé, l’appareil ne peut pas se connecter au service. |
| statusReason |
string |
Raison de la status actuelle de l’appareil, le cas échéant. |
| statusUpdateTime |
string |
Date et heure de la dernière mise à jour du status de l’appareil. |
| tags |
object |
Collection de paires clé-valeur lues et écrites par le back-end de solution. Ils ne sont pas visibles pour les applications d’appareil. Leurs clés sont encodées en UTF-8, respectant la casse et d’une longueur maximale de 1 Ko. Les caractères autorisés excluent les caractères de contrôle UNICODE (segments C0 et C1), '.', '$' et espace. Les valeurs sont des objets JSON d’une longueur maximale de 4 Ko. |
| version |
integer |
Version du jumeau d’appareil, y compris les balises et les propriétés souhaitées |
| x509Thumbprint |
Empreinte numérique X509 de l’appareil. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
OK. |
Définitions
| Nom | Description |
|---|---|
|
Device |
Status des fonctionnalités activées sur l’appareil. |
| Twin |
Informations d’état d’un appareil ou d’un module. Il est implicitement créé et supprimé lorsque l’identité d’appareil/module correspondante est créée ou supprimée dans le IoT Hub. |
|
Twin |
Propriétés souhaitées et signalées du jumeau. La profondeur maximale de l’objet est 10. |
| X509Thumbprint |
DeviceCapabilities
Status des fonctionnalités activées sur l’appareil.
| Nom | Type | Description |
|---|---|---|
| iotEdge |
boolean |
Propriété qui détermine si l’appareil est un appareil edge ou non. |
Twin
Informations d’état d’un appareil ou d’un module. Il est implicitement créé et supprimé lorsque l’identité d’appareil/module correspondante est créée ou supprimée dans le IoT Hub.
| Nom | Type | Description |
|---|---|---|
| authenticationType |
enum:
|
Type d’authentification utilisé par l’appareil. |
| capabilities |
Status des fonctionnalités activées sur l’appareil. |
|
| cloudToDeviceMessageCount |
integer |
Nombre de messages cloud-à-appareil envoyés. |
| connectionState |
enum:
|
État de connexion de l’appareil. |
| deviceEtag |
string |
Chaîne représentant un ETag pour l’appareil, conformément à RFC7232. |
| deviceId |
string |
Identificateur unique de l’appareil dans le registre d’identités du IoT Hub. Il s’agit d’une chaîne respectant la casse (jusqu’à 128 caractères de long) de caractères alphanumériques ASCII 7 bits, et les caractères spéciaux suivants {'-', ' :', '.', '+', '%', '_', '#', '*', ' ?', ' !', '(', ')', ',', '@', ' ;', '$', ''}. |
| deviceScope |
string |
Portée de l’appareil. |
| etag |
string |
Chaîne représentant un ETag pour le jumeau d’appareil, conformément RFC7232. |
| lastActivityTime |
string |
Date et heure auxquelles l’appareil s’est connecté ou a reçu ou envoyé un message. La date et l’heure sont saisies dans ISO8601 format dateheure au format UTC, par exemple, 2015-01-28T16 :24 :48.789Z. Cette valeur n’est pas mise à jour si l’appareil utilise le protocole HTTP/1 pour effectuer des opérations de messagerie. |
| moduleId |
string |
Identificateur unique du module dans le registre d’identités du IoT Hub. Il s’agit d’une chaîne respectant la casse (jusqu’à 128 caractères de long) de caractères alphanumériques ASCII 7 bits, et les caractères spéciaux suivants {'-', ' :', '.', '+', '%', '_', '#', '*', ' ?', ' !', '(', ')', ',', '@', ' ;', '$', ''}. |
| properties |
Propriétés souhaitées et signalées du jumeau. |
|
| status |
enum:
|
Status activé de l’appareil. S’il est désactivé, l’appareil ne peut pas se connecter au service. |
| statusReason |
string |
Raison de la status actuelle de l’appareil, le cas échéant. |
| statusUpdateTime |
string |
Date et heure de la dernière mise à jour du status de l’appareil. |
| tags |
object |
Collection de paires clé-valeur lues et écrites par le back-end de solution. Ils ne sont pas visibles pour les applications d’appareil. Leurs clés sont encodées en UTF-8, respectant la casse et d’une longueur maximale de 1 Ko. Les caractères autorisés excluent les caractères de contrôle UNICODE (segments C0 et C1), '.', '$' et espace. Les valeurs sont des objets JSON d’une longueur maximale de 4 Ko. |
| version |
integer |
Version du jumeau d’appareil, y compris les balises et les propriétés souhaitées |
| x509Thumbprint |
Empreinte numérique X509 de l’appareil. |
TwinProperties
Propriétés souhaitées et signalées du jumeau. La profondeur maximale de l’objet est 10.
| Nom | Type | Description |
|---|---|---|
| desired |
object |
Collection de paires clé-valeur de propriété souhaitées. Les clés sont encodées en UTF-8, respectant la casse et d’une longueur maximale de 1 Ko. Les caractères autorisés excluent les caractères de contrôle UNICODE (segments C0 et C1), '.', '$' et espace. Les valeurs de porperty souhaitées sont des objets JSON d’une longueur maximale de 4 Ko. |
| reported |
object |
Collection de paires clé-valeur de propriété signalées. Les clés sont encodées en UTF-8, respectant la casse et d’une longueur maximale de 1 Ko. Les caractères autorisés excluent les caractères de contrôle UNICODE (segments C0 et C1), '.', '$' et espace. Les valeurs de propriété signalées sont des objets JSON d’une longueur maximale de 4 Ko. |
X509Thumbprint
| Nom | Type | Description |
|---|---|---|
| primaryThumbprint |
string |
Empreinte primaire du certificat client X509. |
| secondaryThumbprint |
string |
Empreinte secondaire du certificat client X509. |