Query - Get Twins
Interroger un IoT Hub pour récupérer des informations concernant les jumeaux d’appareil à l’aide d’un langage de type SQL. Consultez la rubrique https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language (éventuellement en anglais) pour plus d'informations. La pagination est prise en charge. Cette opération renvoie uniquement des informations sur les jumeaux d’appareil.
POST https://fully-qualified-iothubname.azure-devices.net/devices/query?api-version=2021-04-12Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Version de l’API. |
En-tête de la demande
| Nom | Obligatoire | Type | Description |
|---|---|---|---|
| x-ms-continuation |
string |
Jeton de continuation utilisé pour obtenir la page de résultats suivante. |
|
| x-ms-max-item-count |
string |
Nombre maximal d’éléments retournés par page. Le service peut utiliser une valeur différente si la valeur spécifiée n’est pas acceptable. |
Corps de la demande
| Nom | Type | Description |
|---|---|---|
| query |
string |
Chaîne de requête. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Twin[] |
OK. En-têtes
|
Définitions
| Nom | Description |
|---|---|
|
Device |
Status des fonctionnalités activées sur l’appareil. |
|
Query |
Demande de requête Json. |
| Twin |
Informations d’état d’un appareil ou d’un module. Elle est implicitement créée et supprimée 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 de 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 périphérique ou non. |
QuerySpecification
Demande de requête Json.
| Nom | Type | Description |
|---|---|---|
| query |
string |
Chaîne de requête. |
Twin
Informations d’état d’un appareil ou d’un module. Elle est implicitement créée et supprimée 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 des identités du IoT Hub. Il s’agit d’une chaîne respectant la casse (jusqu’à 128 caractères) 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 de la dernière connexion de l’appareil, de réception ou d’envoi d’un message. La date et l’heure sont saisies dans ISO8601 format datetime 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 des identités du IoT Hub. Il s’agit d’une chaîne respectant la casse (jusqu’à 128 caractères) de caractères alphanumériques ASCII 7 bits, et les caractères spéciaux suivants {'-', ' :', '.', '+', '%', '_', '#', '*', ' ?', ' !', '(', ')', ',', '=', '@', ' ;', '$', '''}. |
| parentScopes |
string[] |
Étendues des périphériques de niveau supérieur, le cas échéant. Disponible uniquement pour les appareils de périphérie. |
| 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 serveur principal de la solution. Ils ne sont pas visibles pour les applications d’appareil. Elles 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 space. 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 de 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 space. Les valeurs 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 space. 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 numérique principale du certificat client X509. |
| secondaryThumbprint |
string |
Empreinte secondaire du certificat client X509. |