Dela via

Device class

  • Referens
Paket:
azure-iothub

Varning

Det här API:et är nu inaktuellt.

Skapar en representation av en enhet för användning med API:erna för enhetsidentitetsregistret .

Den här klassen är inaktuell eftersom enhetsidentitetsregistret kan fungera direkt med JSON-objekt som innehåller en partiell beskrivning av enheten, inte nödvändigtvis det fullständiga objektet. Utöver det levererades den här klassen med ett skrivfel på symmetricKey egenskapsnamnet (det var pascal-cased istället för kamel-cased). SDK:t behåller den här klassen för att inte bryta befintlig kod, men den tas bort i en framtida högre version och kunderna bör i stället använda vanliga JSON-objekt.

Konstruktorer

Device(any)

Instansiera ett nytt Device objekt.

Egenskaper

authentication

Innehåller de symmetriska nycklar som används för att autentisera den här enheten.
capabilities

Innehåller funktionerna för den här enheten.
cloudToDeviceMessageCount

Antal c2d-meddelanden som väntar på genom att levereras till enheten.
connectionState

Om enheten är "ansluten" eller "frånkopplad". Vi rekommenderar inte att du använder den här egenskapen för att avgöra om enheten faktiskt är ansluten just nu, eftersom enhetsanslutningen kan ha överskriden tidsgräns och IoT-hubben kanske inte har identifierat den, eller om enheten använder HTTPS för att ansluta. Om du behöver övervaka enhetsanslutningar är det återkomna sättet att använda funktionen för driftövervakning i hubben.
connectionStateUpdatedTime

Tidsstämpeln som representerar den senaste gången connectionState ändrades.
deviceId

Unik enhetsidentifierare eftersom den finns i Azure IoT Hub-enhetsregistret.
etag

Svag entitetstagg tilldelad till den här enhetsidentitetsbeskrivningen
generationId

Används för att skilja enheter som har tagits bort/återskapats med samma deviceId
lastActivityTime

Tidsstämpel som representerar den senaste gången enheten autentiserades, skickade ett meddelande eller tog emot ett meddelande.
status

"aktiverad" (enheten har behörighet att ansluta, kan skicka/ta emot meddelanden) eller "inaktiverad".
statusReason

Sträng med 128 tecken anges när enheten är inaktiverad.
statusUpdatedTime

Tidsstämpeln som representerar den senaste gången status ändrades.

Konstruktorinformation

Device(any)

Instansiera ett nytt Device objekt.

new Device(jsonData?: any)

Parametrar

jsonData

any

En valfri JSON-representation av enheten, som mappas till egenskaper i objektet. Om inget argument anges tilldelas enhetsegenskaper standardvärden.

Egenskapsinformation

authentication

Innehåller de symmetriska nycklar som används för att autentisera den här enheten.

authentication?: Authentication

Egenskapsvärde

Authentication

capabilities

Innehåller funktionerna för den här enheten.

capabilities?: Capabilities

Egenskapsvärde

Capabilities

cloudToDeviceMessageCount

Antal c2d-meddelanden som väntar på genom att levereras till enheten.

cloudToDeviceMessageCount?: string

Egenskapsvärde

string

connectionState

Om enheten är "ansluten" eller "frånkopplad". Vi rekommenderar inte att du använder den här egenskapen för att avgöra om enheten faktiskt är ansluten just nu, eftersom enhetsanslutningen kan ha överskriden tidsgräns och IoT-hubben kanske inte har identifierat den, eller om enheten använder HTTPS för att ansluta. Om du behöver övervaka enhetsanslutningar är det återkomna sättet att använda funktionen för driftövervakning i hubben.

connectionState?: ConnectionState

Egenskapsvärde

ConnectionState

connectionStateUpdatedTime

Tidsstämpeln som representerar den senaste gången connectionState ändrades.

connectionStateUpdatedTime?: string

Egenskapsvärde

string

deviceId

Unik enhetsidentifierare eftersom den finns i Azure IoT Hub-enhetsregistret.

deviceId: string

Egenskapsvärde

string

etag

Svag entitetstagg tilldelad till den här enhetsidentitetsbeskrivningen

etag?: string

Egenskapsvärde

string

generationId

Används för att skilja enheter som har tagits bort/återskapats med samma deviceId

generationId?: string

Egenskapsvärde

string

lastActivityTime

Tidsstämpel som representerar den senaste gången enheten autentiserades, skickade ett meddelande eller tog emot ett meddelande.

lastActivityTime?: string

Egenskapsvärde

string

status

"aktiverad" (enheten har behörighet att ansluta, kan skicka/ta emot meddelanden) eller "inaktiverad".

status?: DeviceStatus

Egenskapsvärde

DeviceStatus

statusReason

Sträng med 128 tecken anges när enheten är inaktiverad.

statusReason?: string

Egenskapsvärde

string

statusUpdatedTime

Tidsstämpeln som representerar den senaste gången status ändrades.

statusUpdatedTime?: string

Egenskapsvärde

string