Device class

Pakiet:

azure-iothub

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Tworzy reprezentację urządzenia do użycia z rejestrem tożsamości urządzeń interfejsami API.

Ta klasa jest przestarzała, ponieważ rejestr tożsamości urządzeń może pracować bezpośrednio z obiektami JSON zawierającymi częściowy opis urządzenia, niekoniecznie pełny obiekt. Na początku tej klasy został dostarczony z literówką na symmetricKey nazwy właściwości (był pascal-cased zamiast camel-cased). Zestaw SDK utrzymuje tę klasę, aby nie przerywać istniejącego kodu, ale zostanie on usunięty w przyszłej aktualizacji wersji głównej, a klienci powinni zamiast tego używać zwykłych obiektów JSON.

Konstruktory

Device(any)

Utwórz wystąpienie nowego obiektu Device.

Właściwości

authentication	Zawiera klucze symetryczne używane do uwierzytelniania tego urządzenia.
capabilities	Zawiera możliwości tego urządzenia.
cloudToDeviceMessageCount	Liczba komunikatów c2d oczekujących na dostarczenie do urządzenia.
connectionState	Niezależnie od tego, czy urządzenie jest połączone, czy "odłączone". Nie zaleca się używania tej właściwości w celu określenia, czy urządzenie jest rzeczywiście połączone w tej chwili, ponieważ połączenie urządzenia mogło upłynął limit czasu, a centrum IoT mogło nie wykryć go lub jeśli urządzenie używa protokołu HTTPS do nawiązania połączenia. Jeśli musisz monitorować połączenia urządzeń, zaleca się użycie funkcji monitorowania operacji centrum.
connectionStateUpdatedTime	Znacznik czasu reprezentujący czas ostatniej zmiany connectionState.
deviceId	Unikatowy identyfikator urządzenia, który istnieje w rejestrze urządzeń usługi Azure IoT Hub.
etag	Słaby tag jednostki przypisany do tego opisu tożsamości urządzenia
generationId	Służy do uściślania urządzeń, które zostały usunięte/ponownie tworzone przy użyciu tego samego deviceId
lastActivityTime	Sygnatura czasowa reprezentująca czas ostatniego uwierzytelnienia urządzenia, wysłania komunikatu lub odebrania komunikatu.
status	"włączone" (urządzenie autoryzowane do nawiązywania połączenia, może wysyłać/odbierać komunikaty) lub "wyłączone".
statusReason	128-znakowy ciąg ustawiony, gdy urządzenie jest wyłączone.
statusUpdatedTime	Znacznik czasu reprezentujący czas ostatniej zmiany status.

Szczegóły konstruktora

Device(any)

Utwórz wystąpienie nowego obiektu Device.

new Device(jsonData?: any)

Parametry

jsonData

any

Opcjonalna reprezentacja JSON urządzenia, która zostanie zamapowana na właściwości w obiekcie. Jeśli argument nie zostanie podany, właściwości urządzenia zostaną przypisane wartości domyślne.

Szczegóły właściwości

authentication

Zawiera klucze symetryczne używane do uwierzytelniania tego urządzenia.

authentication?: Authentication

Wartość właściwości

Authentication

capabilities

Zawiera możliwości tego urządzenia.

capabilities?: Capabilities

Wartość właściwości

Capabilities

cloudToDeviceMessageCount

Liczba komunikatów c2d oczekujących na dostarczenie do urządzenia.

cloudToDeviceMessageCount?: string

Wartość właściwości

string

connectionState

Niezależnie od tego, czy urządzenie jest połączone, czy "odłączone". Nie zaleca się używania tej właściwości w celu określenia, czy urządzenie jest rzeczywiście połączone w tej chwili, ponieważ połączenie urządzenia mogło upłynął limit czasu, a centrum IoT mogło nie wykryć go lub jeśli urządzenie używa protokołu HTTPS do nawiązania połączenia. Jeśli musisz monitorować połączenia urządzeń, zaleca się użycie funkcji monitorowania operacji centrum.

connectionState?: ConnectionState

Wartość właściwości

ConnectionState

connectionStateUpdatedTime

Znacznik czasu reprezentujący czas ostatniej zmiany connectionState.

connectionStateUpdatedTime?: string

Wartość właściwości

string

deviceId

Unikatowy identyfikator urządzenia, który istnieje w rejestrze urządzeń usługi Azure IoT Hub.

deviceId: string

Wartość właściwości

string

etag

Słaby tag jednostki przypisany do tego opisu tożsamości urządzenia

etag?: string

Wartość właściwości

string

generationId

Służy do uściślania urządzeń, które zostały usunięte/ponownie tworzone przy użyciu tego samego deviceId

generationId?: string

Wartość właściwości

string

lastActivityTime

Sygnatura czasowa reprezentująca czas ostatniego uwierzytelnienia urządzenia, wysłania komunikatu lub odebrania komunikatu.

lastActivityTime?: string

Wartość właściwości

string

status

"włączone" (urządzenie autoryzowane do nawiązywania połączenia, może wysyłać/odbierać komunikaty) lub "wyłączone".

status?: DeviceStatus

Wartość właściwości

DeviceStatus

statusReason

128-znakowy ciąg ustawiony, gdy urządzenie jest wyłączone.

statusReason?: string

Wartość właściwości

string

statusUpdatedTime

Znacznik czasu reprezentujący czas ostatniej zmiany status.

statusUpdatedTime?: string

Wartość właściwości

string