Partager via

Modules - Get Identity

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

Obtient une identité de module sur l’appareil.

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

Module

OK.

Définitions

Nom Description
AuthenticationMechanism
Module

Identité du module sur un appareil.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Nom Type Description
symmetricKey

SymmetricKey

Clés primaires et secondaires utilisées pour l’authentification basée sur SAS.
type enum:
  • certificateAuthority
  • none
  • sas
  • selfSigned

Type d’authentification utilisé pour se connecter au service.
x509Thumbprint

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

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