Device class
Warnung
Diese API ist nun veraltet.
Erstellt eine Darstellung eines Geräts zur Verwendung mit der Geräteidentitätsregistrierung APIs.
Diese Klasse ist veraltet, da die Geräteidentitätsregistrierung direkt mit JSON-Objekten arbeiten kann, die eine teilweise Beschreibung des Geräts enthalten, nicht unbedingt das vollständige Objekt. Darüber hinaus wurde diese Klasse zunächst mit einem Tippfehler auf dem symmetricKey
Eigenschaftsnamen ausgeliefert (es wurde pascal-cased anstelle von Kamel cased). Das SDK behält diese Klasse bei, um vorhandenen Code nicht zu unterbrechen, dies wird jedoch in einem zukünftigen Update der Hauptversion entfernt, und Kunden sollten stattdessen einfache JSON-Objekte verwenden.
Konstruktoren
Device(any) | Instanziieren Sie 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. |
cloud |
Die Anzahl der C2D-Nachrichten, die auf die Zustellung an das Gerät warten. |
connection |
Gibt an, ob das Gerät "verbunden" oder "getrennt" ist. Es wird nicht empfohlen, diese Eigenschaft zu verwenden, um festzustellen, ob das Gerät tatsächlich im Moment verbunden ist, da die Geräteverbindung möglicherweise ein Timeout aufgetreten ist und der IoT-Hub es möglicherweise nicht erkannt hat oder ob das Gerät HTTPS zum Herstellen einer Verbindung verwendet. Wenn Sie Geräteverbindungen überwachen müssen, besteht die recommned-Methode darin, die Betriebsüberwachung Feature Ihres Hubs zu verwenden. |
connection |
Zeitstempel, der das letzte Mal darstellt, |
device |
Eindeutiger Gerätebezeichner, wie er in der Azure IoT Hub-Geräteregistrierung vorhanden ist. |
etag | Schwaches Entitätstag, das dieser Geräteidentitätsbeschreibung zugewiesen ist |
generation |
Wird verwendet, um mehrdeutig zu unterscheidende Geräte, die gelöscht/neu erstellt wurden, mit demselben |
last |
Zeitstempel, der das letzte Mal darstellt, wenn das Gerät authentifiziert, eine Nachricht gesendet oder eine Nachricht empfangen hat. |
status | "aktiviert" (Gerät, das zum Herstellen einer Verbindung autorisiert ist, Nachrichten senden/empfangen kann) oder "deaktiviert". |
status |
128-stellige Zeichenfolgensatz, wenn das Gerät deaktiviert ist. |
status |
Zeitstempel, der das letzte Mal darstellt, |
Details zum Konstruktor
Device(any)
Instanziieren Sie 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
capabilities
cloudToDeviceMessageCount
Die Anzahl der C2D-Nachrichten, die auf die Zustellung an das Gerät warten.
cloudToDeviceMessageCount?: string
Eigenschaftswert
string
connectionState
Gibt an, ob das Gerät "verbunden" oder "getrennt" ist. Es wird nicht empfohlen, diese Eigenschaft zu verwenden, um festzustellen, ob das Gerät tatsächlich im Moment verbunden ist, da die Geräteverbindung möglicherweise ein Timeout aufgetreten ist und der IoT-Hub es möglicherweise nicht erkannt hat oder ob das Gerät HTTPS zum Herstellen einer Verbindung verwendet. Wenn Sie Geräteverbindungen überwachen müssen, besteht die recommned-Methode darin, die Betriebsüberwachung Feature Ihres Hubs zu verwenden.
connectionState?: ConnectionState
Eigenschaftswert
connectionStateUpdatedTime
Zeitstempel, der das letzte Mal darstellt, connectionState
geändert wurde.
connectionStateUpdatedTime?: string
Eigenschaftswert
string
deviceId
Eindeutiger Gerätebezeichner, wie er in der Azure IoT Hub-Geräteregistrierung vorhanden ist.
deviceId: string
Eigenschaftswert
string
etag
Schwaches Entitätstag, das dieser Geräteidentitätsbeschreibung zugewiesen ist
etag?: string
Eigenschaftswert
string
generationId
Wird verwendet, um mehrdeutig zu unterscheidende Geräte, die gelöscht/neu erstellt wurden, mit demselben deviceId
generationId?: string
Eigenschaftswert
string
lastActivityTime
Zeitstempel, der das letzte Mal darstellt, wenn das Gerät authentifiziert, eine Nachricht gesendet oder eine Nachricht empfangen hat.
lastActivityTime?: string
Eigenschaftswert
string
status
"aktiviert" (Gerät, das zum Herstellen einer Verbindung autorisiert ist, Nachrichten senden/empfangen kann) oder "deaktiviert".
status?: DeviceStatus
Eigenschaftswert
statusReason
128-stellige Zeichenfolgensatz, wenn das Gerät deaktiviert ist.
statusReason?: string
Eigenschaftswert
string
statusUpdatedTime
Zeitstempel, der das letzte Mal darstellt, status
geändert wurde.
statusUpdatedTime?: string
Eigenschaftswert
string