Share via

Device class

  • Referenz
Paket:
azure-iothub

Warnung

Diese API ist nun veraltet.

Erstellt eine Darstellung eines Geräts zur Verwendung mit den Geräteidentitätsregistrierungs-APIs .

Diese Klasse ist veraltet , da die Geräteidentitätsregistrierung direkt mit JSON-Objekten arbeiten kann, die eine partielle Beschreibung des Geräts enthalten, nicht unbedingt das vollständige Objekt. Darüber hinaus wurde diese Klasse anfangs mit einem Tippfehler für den symmetricKey Eigenschaftsnamen ausgeliefert (sie war pascal-cased statt camel-cased). Das SDK behält diese Klasse bei, um vorhandenen Code nicht zu unterbrechen. Dies wird jedoch in einem zukünftigen Hauptversionsupdate entfernt, und Kunden sollten stattdessen einfache JSON-Objekte verwenden.

Konstruktoren

Device(any)

Instanziiert ein neues Device-Objekt.

Eigenschaften

authentication

Enthält die symmetrischen Schlüssel, die zum Authentifizieren dieses Geräts verwendet werden.
capabilities

Enthält die Funktionen dieses Geräts.
cloudToDeviceMessageCount

Anzahl der c2d-Nachrichten, auf die gewartet wird, indem sie an das Gerät übermittelt werden.
connectionState

Gibt an, ob das Gerät "verbunden" oder "getrennt" ist. Es wird jedoch nicht empfohlen, diese Eigenschaft zu verwenden, um zu ermitteln, ob das Gerät tatsächlich verbunden ist, da für die Geräteverbindung möglicherweise ein Timeout aufgetreten ist und der IoT Hub es möglicherweise nicht erkannt hat, oder wenn das Gerät HTTPS zum Herstellen der Verbindung verwendet. Wenn Sie Geräteverbindungen überwachen müssen, empfiehlt es sich, die Betriebsüberwachungsfunktion Ihres Hubs zu verwenden.
connectionStateUpdatedTime

Zeitstempel, der den Zeitpunkt connectionState der letzten Änderung darstellt.
deviceId

Eindeutiger Gerätebezeichner, wie er in der Azure IoT Hub-Geräteregistrierung vorhanden ist.
etag

Schwacher Entitätstag, der dieser Geräteidentitätsbeschreibung zugewiesen ist
generationId

Wird verwendet, um Mehrdeutigkeit von Geräten zu entfernen, die mit demselben gelöscht/neu erstellt wurden deviceId
lastActivityTime

Zeitstempel, der den Zeitpunkt darstellt, zu dem sich das Gerät zuletzt authentifiziert, eine Nachricht gesendet oder eine Nachricht empfangen hat.
status

"aktiviert" (Gerät autorisiert zum Herstellen einer Verbindung, kann Nachrichten senden/empfangen) oder "deaktiviert".
statusReason

128-stellige Zeichenfolge festgelegt, wenn das Gerät deaktiviert ist.
statusUpdatedTime

Zeitstempel, der den Zeitpunkt status der letzten Änderung darstellt.

Details zum Konstruktor

Device(any)

Instanziiert ein neues Device-Objekt.

new Device(jsonData?: any)

Parameter

jsonData

any

Eine optionale JSON-Darstellung des Geräts, die Eigenschaften im -Objekt zugeordnet wird. Wenn kein Argument angegeben wird, werden Geräteeigenschaften Standardwerte zugewiesen.

Details zur Eigenschaft

authentication

Enthält die symmetrischen Schlüssel, die zum Authentifizieren dieses Geräts verwendet werden.

authentication?: Authentication

Eigenschaftswert

Authentication

capabilities

Enthält die Funktionen dieses Geräts.

capabilities?: Capabilities

Eigenschaftswert

Capabilities

cloudToDeviceMessageCount

Anzahl der c2d-Nachrichten, auf die gewartet wird, indem sie an das Gerät übermittelt werden.

cloudToDeviceMessageCount?: string

Eigenschaftswert

string

connectionState

Gibt an, ob das Gerät "verbunden" oder "getrennt" ist. Es wird jedoch nicht empfohlen, diese Eigenschaft zu verwenden, um zu ermitteln, ob das Gerät tatsächlich verbunden ist, da für die Geräteverbindung möglicherweise ein Timeout aufgetreten ist und der IoT Hub es möglicherweise nicht erkannt hat, oder wenn das Gerät HTTPS zum Herstellen der Verbindung verwendet. Wenn Sie Geräteverbindungen überwachen müssen, empfiehlt es sich, die Betriebsüberwachungsfunktion Ihres Hubs zu verwenden.

connectionState?: ConnectionState

Eigenschaftswert

ConnectionState

connectionStateUpdatedTime

Zeitstempel, der den Zeitpunkt connectionState der letzten Änderung darstellt.

connectionStateUpdatedTime?: string

Eigenschaftswert

string

deviceId

Eindeutiger Gerätebezeichner, wie er in der Azure IoT Hub-Geräteregistrierung vorhanden ist.

deviceId: string

Eigenschaftswert

string

etag

Schwacher Entitätstag, der dieser Geräteidentitätsbeschreibung zugewiesen ist

etag?: string

Eigenschaftswert

string

generationId

Wird verwendet, um Mehrdeutigkeit von Geräten zu entfernen, die mit demselben gelöscht/neu erstellt wurden deviceId

generationId?: string

Eigenschaftswert

string

lastActivityTime

Zeitstempel, der den Zeitpunkt darstellt, zu dem sich das Gerät zuletzt authentifiziert, eine Nachricht gesendet oder eine Nachricht empfangen hat.

lastActivityTime?: string

Eigenschaftswert

string

status

"aktiviert" (Gerät autorisiert zum Herstellen einer Verbindung, kann Nachrichten senden/empfangen) oder "deaktiviert".

status?: DeviceStatus

Eigenschaftswert

DeviceStatus

statusReason

128-stellige Zeichenfolge festgelegt, wenn das Gerät deaktiviert ist.

statusReason?: string

Eigenschaftswert

string

statusUpdatedTime

Zeitstempel, der den Zeitpunkt status der letzten Änderung darstellt.

statusUpdatedTime?: string

Eigenschaftswert

string