Devices - Get Devices

Service:

IoT Hub

Version d'API:

2021-04-12

Obtient les identités de plusieurs appareils à partir du registre d’identités IoT Hub. Non recommandé. Utilisez l’API de requête IoT Hub pour récupérer les informations de jumeau d’appareil et d’identité d’appareil. Pour plus d'informations, consultez https://docs.microsoft.com/en-us/rest/api/iothub/service/queryiothub et https://docs.microsoft.com/en-us/azure/iot-hub/iot-hub-devguide-query-language.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
api-version	query	True	string	Version de l’API.
top	query		integer int32	Nombre maximal d’identités d’appareil retournées par la requête. Toute valeur située en dehors de la plage comprise entre 1 et 1000 est considérée comme 1000.

Réponses

Nom	Type	Description
200 OK	Device[]	OK.

Définitions

Nom	Description
AuthenticationMechanism
Device
DeviceCapabilities	Status des fonctionnalités activées sur l’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 principales et secondaires utilisées pour l’authentification basée sur x509.

Device

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	Nombre de messages cloud-à-appareil actuellement mis en file d’attente pour être envoyés à l’appareil.
connectionState	enum: Connected Disconnected	L’état 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.
deviceScope	string	Portée de l’appareil. Généré automatiquement et immuable pour les appareils de périphérie et modifiable 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 de 128 caractères générée par le IoT Hub, qui respecte la casse. Cette valeur permet de distinguer les appareils dotés du même deviceIdlorsqu’ils ont été supprimés et recréés.
lastActivityTime	string	Date et heure de la dernière connexion, de la réception ou de l’envoi d’un message à l’appareil.
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	Status de l’appareil. Si le status désactivé, un appareil ne peut pas se connecter au service.
statusReason	string	Chaîne de 128 caractères qui stocke la raison de l’identité de l’appareil status. Tous les caractères UTF-8 sont autorisés.
statusUpdatedTime	string	Date et heure de la dernière mise à jour du champ status.

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.

SymmetricKey

Nom	Type	Description
primaryKey	string	Clé primaire codée en base64 de l’appareil.
secondaryKey	string	Clé secondaire codée en base64 de l’appareil.

X509Thumbprint

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