Share via

Device class

  • Référence
Paquet:
azure-iothub

Avertissement

Cette API est à présent déconseillée.

Crée une représentation d’un appareil à utiliser avec les API de registre d’identités d’appareil .

Cette classe est déconseillée , car le registre des identités d’appareil peut fonctionner directement avec des objets JSON contenant une description partielle de l’appareil, pas nécessairement l’objet complet. En plus de cela initialement, cette classe a été livrée avec une faute de frappe sur le nom de la symmetricKey propriété (il était cased pascal au lieu de camel-cased). Le Kit de développement logiciel (SDK) conserve cette classe afin de ne pas interrompre le code existant, mais il sera supprimé dans une prochaine mise à jour de version majeure et les clients devront utiliser à la place des objets JSON simples.

Constructeurs

Device(any)

Instancie un nouvel objet Device.

Propriétés

authentication

Contient les clés symétriques utilisées pour authentifier cet appareil.
capabilities

Contient les fonctionnalités de cet appareil.
cloudToDeviceMessageCount

Nombre de messages c2d en attente de remise à l’appareil.
connectionState

Indique si l’appareil est « connecté » ou « déconnecté ». Toutefois, il n’est pas recommandé d’utiliser cette propriété pour déterminer si l’appareil est connecté actuellement, car la connexion de l’appareil a peut-être expiré et le hub IoT ne l’a peut-être pas détectée, ou si l’appareil utilise HTTPS pour se connecter. Si vous avez besoin de surveiller les connexions des appareils, la méthode recommée consiste à utiliser la fonctionnalité de surveillance des opérations de votre hub.
connectionStateUpdatedTime

Horodatage représentant l’heure connectionState de la dernière modification.
deviceId

Identificateur d’appareil unique tel qu’il existe dans le registre d’appareils Azure IoT Hub.
etag

Étiquette d’entité faible affectée à cette description d’identité d’appareil
generationId

Utilisé pour lever l’ambiguïté des appareils qui ont été supprimés/recréés avec le même deviceId
lastActivityTime

Horodatage représentant la dernière fois que l’appareil s’est authentifié, a envoyé un message ou a reçu un message.
status

« enabled » (appareil autorisé à se connecter, peut envoyer/recevoir des messages) ou « désactivé ».
statusReason

Chaîne de 128 caractères définie lorsque l’appareil est désactivé.
statusUpdatedTime

Horodatage représentant l’heure status de la dernière modification.

Détails du constructeur

Device(any)

Instancie un nouvel objet Device.

new Device(jsonData?: any)

Paramètres

jsonData

any

Représentation JSON facultative de l’appareil, qui sera mappée aux propriétés de l’objet . Si aucun argument n’est fourni, les valeurs par défaut des propriétés de l’appareil sont affectées.

Détails de la propriété

authentication

Contient les clés symétriques utilisées pour authentifier cet appareil.

authentication?: Authentication

Valeur de propriété

Authentication

capabilities

Contient les fonctionnalités de cet appareil.

capabilities?: Capabilities

Valeur de propriété

Capabilities

cloudToDeviceMessageCount

Nombre de messages c2d en attente de remise à l’appareil.

cloudToDeviceMessageCount?: string

Valeur de propriété

string

connectionState

Indique si l’appareil est « connecté » ou « déconnecté ». Toutefois, il n’est pas recommandé d’utiliser cette propriété pour déterminer si l’appareil est connecté actuellement, car la connexion de l’appareil a peut-être expiré et le hub IoT ne l’a peut-être pas détectée, ou si l’appareil utilise HTTPS pour se connecter. Si vous avez besoin de surveiller les connexions des appareils, la méthode recommée consiste à utiliser la fonctionnalité de surveillance des opérations de votre hub.

connectionState?: ConnectionState

Valeur de propriété

ConnectionState

connectionStateUpdatedTime

Horodatage représentant l’heure connectionState de la dernière modification.

connectionStateUpdatedTime?: string

Valeur de propriété

string

deviceId

Identificateur d’appareil unique tel qu’il existe dans le registre d’appareils Azure IoT Hub.

deviceId: string

Valeur de propriété

string

etag

Étiquette d’entité faible affectée à cette description d’identité d’appareil

etag?: string

Valeur de propriété

string

generationId

Utilisé pour lever l’ambiguïté des appareils qui ont été supprimés/recréés avec le même deviceId

generationId?: string

Valeur de propriété

string

lastActivityTime

Horodatage représentant la dernière fois que l’appareil s’est authentifié, a envoyé un message ou a reçu un message.

lastActivityTime?: string

Valeur de propriété

string

status

« enabled » (appareil autorisé à se connecter, peut envoyer/recevoir des messages) ou « désactivé ».

status?: DeviceStatus

Valeur de propriété

DeviceStatus

statusReason

Chaîne de 128 caractères définie lorsque l’appareil est désactivé.

statusReason?: string

Valeur de propriété

string

statusUpdatedTime

Horodatage représentant l’heure status de la dernière modification.

statusUpdatedTime?: string

Valeur de propriété

string