Devices - Get Identity

Service:

IoT Hub

Version d'API:

2021-04-12

Obtient un appareil à partir du registre d’identités de l’IoT Hub.

GET https://fully-qualified-iothubname.azure-devices.net/devices/{id}?api-version=2021-04-12

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

Réponses

Nom	Type	Description
200 OK	Device	D’ACCORD.

Définitions

Nom	Description
AuthenticationMechanism
Device
DeviceCapabilities	État des fonctionnalités activées sur l’appareil.
SymmetricKey
X509Thumbprint

AuthenticationMechanism

Object

Nom	Type	Description
symmetricKey	SymmetricKey	Clés primaires et secondaires utilisées pour l’authentification basée sur SAP.
type	enum: certificateAuthority none sas selfSigned	Type d’authentification utilisé pour se connecter au service.
x509Thumbprint	X509Thumbprint	Empreintes principales et secondaires x509 utilisées pour l’authentification basée sur x509.

Device

Object

Nom	Type	Description
authentication	AuthenticationMechanism	Mécanisme d’authentification utilisé par l’appareil.
capabilities	DeviceCapabilities	Ensemble de fonctionnalités de l’appareil. Par exemple, si cet appareil est un appareil de périphérie ou non.
cloudToDeviceMessageCount	integer (int32)	Nombre de messages cloud-à-appareil actuellement mis en file d’attente à envoyer à l’appareil.
connectionState	enum: Connected Disconnected	État de l’appareil.
connectionStateUpdatedTime	string (date-time)	Date et heure de la dernière mise à jour de l’état de connexion.
deviceId	string	Identificateur unique de l’appareil.
deviceScope	string	Portée de l’appareil. Générés automatiquement et immuables pour les appareils de périphérie et modifiables dans les appareils feuilles pour créer une relation enfant/parent.
etag	string	Chaîne représentant un ETag faible pour l’identité de l’appareil, conformément à RFC7232.
generationId	string	Chaîne sensible à la casse générée par IoT Hub jusqu’à 128 caractères. Cette valeur est utilisée pour distinguer les appareils avec le même deviceId, lorsqu’ils ont été supprimés et recréés.
lastActivityTime	string (date-time)	Date et dernière connexion de l’appareil, réception ou envoi d’un message.
parentScopes	string[]	Étendues des périphériques de niveau supérieur, le cas échéant. Disponible uniquement pour les appareils de périphérie.
status	enum: disabled enabled	État de l’appareil. Si l’état est désactivé, un appareil ne peut pas se connecter au service.
statusReason	string	Chaîne longue de 128 caractères qui stocke la raison de l’état de l’identité de l’appareil. Tous les caractères UTF-8 sont autorisés.
statusUpdatedTime	string (date-time)	Date et heure de la dernière mise à jour du champ d’état.

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.

SymmetricKey

Object

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

Object

Nom	Type	Description
primaryThumbprint	string	Empreinte numérique principale du certificat client X509.
secondaryThumbprint	string	Empreinte numérique secondaire du certificat client X509.