Device class

Paquet:

azure-iothub

Avertissement

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

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

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

Constructeurs

Device(any)

Instanciez 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 par remise à l’appareil.
connectionState	Indique si l’appareil est « connecté » ou « déconnecté ». Il n’est pas recommandé d’utiliser cette propriété pour déterminer si l’appareil est réellement connecté pour l’instant, car la connexion de l’appareil peut avoir expiré et que le hub IoT ne l’a peut-être pas détecté, ou si l’appareil utilise HTTPS pour se connecter. Si vous avez besoin de surveiller les connexions d’appareil, la méthode recommurée consiste à utiliser la fonctionnalité de surveillance des opérations de votre hub.
connectionStateUpdatedTime	Horodatage représentant la dernière fois connectionState modifié.
deviceId	Identificateur d’appareil unique tel qu’il existe dans le registre d’appareils Azure IoT Hub.
etag	Balise 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 a authentifié, envoyé un message ou 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 la dernière fois status modifié.

Détails du constructeur

Device(any)

Instanciez 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 propriétés de l’appareil reçoivent des valeurs par défaut.

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 par remise à l’appareil.

cloudToDeviceMessageCount?: string

Valeur de propriété

string

connectionState

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

connectionState?: ConnectionState

Valeur de propriété

ConnectionState

connectionStateUpdatedTime

Horodatage représentant la dernière fois connectionState modifié.

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

Balise 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 a authentifié, envoyé un message ou 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 la dernière fois status modifié.

statusUpdatedTime?: string

Valeur de propriété

string