Partager via

Modules - Get Twin

  • Référence
Service:
IoT Hub
Version d'API:
2021-04-12

Obtient le jumeau de module. Pour plus d’informations, consultez https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-device-twins.

GET https://fully-qualified-iothubname.azure-devices.net/twins/{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.

Réponses

Nom Type Description
200 OK

Twin

Informations d’état du module.

Définitions

Nom Description
DeviceCapabilities

État des fonctionnalités activées sur l’appareil.
Twin

Informations d’état pour un appareil ou un module. Cela est implicitement créé et supprimé lorsque l’identité d’appareil/module correspondante est créée ou supprimée dans IoT Hub.
TwinProperties

Propriétés souhaitées et signalées du jumeau. La profondeur maximale de l’objet est de 10.
X509Thumbprint

DeviceCapabilities

Object

État des fonctionnalités activées sur l’appareil.

Nom Type Description
iotEdge

boolean

Propriété qui détermine si l’appareil est un appareil de périphérie ou non.

Twin

Object

Informations d’état pour un appareil ou un module. Cela est implicitement créé et supprimé lorsque l’identité d’appareil/module correspondante est créée ou supprimée dans IoT Hub.

Nom Type Description
authenticationType enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Type d’authentification utilisé par l’appareil.
capabilities

DeviceCapabilities

État des fonctionnalités activées sur l’appareil.
cloudToDeviceMessageCount

integer (int32)

Nombre de messages cloud-à-appareil envoyés.
connectionState enum:
  • Connected
  • Disconnected

É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 de l’IoT Hub. Il s’agit d’une chaîne sensible à 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-time)

Date et heure de la dernière connexion ou réception ou envoi d’un message sur l’appareil. La date et l’heure sont sépecifiées au format datetime ISO8601 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 hub IoT. Il s’agit d’une chaîne sensible à 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

TwinProperties

Propriétés souhaitées et signalées du jumeau.
status enum:
  • disabled
  • enabled

État activé de l’appareil. Si cette option est désactivée, l’appareil ne peut pas se connecter au service.
statusReason

string

Raison de l’état actuel de l’appareil, le cas échéant.
statusUpdateTime

string (date-time)

Date et heure de la dernière mise à jour de l’état de l’appareil.
tags

object

Collection de paires clé-valeur lues et écrites par le back-end de solution. Elles ne sont pas visibles pour les applications d’appareil. Elles sont codées en UTF-8, sensibles à la casse et up-to longueur 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, up-to longueur de 4 Ko.
version

integer (int64)

Version du jumeau d’appareil, y compris les balises et les propriétés souhaitées
x509Thumbprint

X509Thumbprint

Empreinte X509 de l’appareil.

TwinProperties

Object

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 codées en UTF-8, respectant la casse et up-to longueur de 1 Ko. Les caractères autorisés excluent les caractères de contrôle UNICODE (segments C0 et C1), « . », « $ » et espace. Les valeurs porperty souhaitées sont des objets JSON, up-to longueur de 4 Ko.
reported

object

Collection de paires clé-valeur de propriété signalées. Les clés sont codées en UTF-8, respectant la casse et up-to longueur 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, up-to longueur de 4 Ko.

X509Thumbprint

Object
Nom Type Description
primaryThumbprint

string

Empreinte numérique principale du certificat client X509.
secondaryThumbprint

string

Empreinte numérique secondaire du certificat client X509.