azure-iothub package

Klasy

Client	Klient usługi IoT Hub służy do komunikowania się z urządzeniami za pośrednictwem centrum Azure IoT Hub. Umożliwia to użytkownikowi zestawu SDK: wysyłanie z chmury do urządzenia (nazywanego również poleceniami): polecenia są kolejkowane na IoT Hub i dostarczane asynchronicznie tylko wtedy, gdy urządzenie jest połączone. Na urządzenie można kolejkować tylko 50 poleceń. wywoływanie metod bezpośrednich na urządzeniach (które będą działać tylko wtedy, gdy urządzenie jest aktualnie połączone: jest to synchroniczny sposób komunikowania się z urządzeniem) nasłuchiwanie komunikatów opinii wysyłanych przez urządzenia dla poprzednich poleceń. nasłuchiwanie powiadomień dotyczących przekazywania plików z urządzeń. Użytkownicy powinni utworzyć nowe Client wystąpienia, wywołując jedną z metod fabrycznych z obszaruConnectionStringlubSharedAccessSignature, aby utworzyć klienta usługi IoT Hub.
Device	Tworzy reprezentację urządzenia do użycia z interfejsami API rejestru tożsamości urządzeń . 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, a niekoniecznie pełny obiekt. Na początku tej klasy została dostarczona literówka w symmetricKey nazwie właściwości (była to pascal-cased zamiast camel-cased). Zestaw SDK zachowuje 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.
JobClient	Udostępnia metody tworzenia, aktualizowania, monitorowania i anulowania długotrwałych zadań w wystąpieniu IoT Hub, a także wykonywania zapytań dotyczących istniejących zadań. Interfejs API zadań w Azure IoT Hub umożliwia planowanie wywołań metod bezpośrednich i aktualizacji bliźniaczych reprezentacji na wielu urządzeniach. Oczekuje się, że użytkownicy zestawu SDK będą tworzyć JobClient wystąpienia przy użyciu metod fromConnectionString(string) fabrycznych i fromSharedAccessSignature(string).
Registry	Klasa Registry zapewnia dostęp do usługi IoT Hub tożsamości urządzenia. Użytkownicy zestawu SDK powinni utworzyć wystąpienie tej klasy przy użyciu jednej z metod fabrycznych: fromConnectionString lub fromSharedAccessSignature. Protokół używany na potrzeby operacji rejestru tożsamości urządzeń to HTTPS.
Amqp	Klasa transportu używana przez klienta usługi do nawiązywania połączenia z centrum Azure IoT Hub przy użyciu protokołu AMQP za pośrednictwem gniazda bezpiecznego (TLS). Tej klasy nie należy używać bezpośrednio i zamiast tego należy przekazać do jednej z Client metod fabrycznych: fromConnectionString lub fromSharedAccessSignature.
AmqpWs	Klasa transportu używana przez klienta usługi do nawiązywania połączenia z centrum Azure IoT hub przy użyciu protokołu AMQP za pośrednictwem bezpiecznych obiektów WebSocket. Tej klasy nie należy używać bezpośrednio i zamiast tego należy przekazać do jednej z Client metod fabrycznych: fromConnectionString lub fromSharedAccessSignature.
DigitalTwinClient
IoTHubTokenCredentials	Tworzy sygnatury dostępu współdzielonego na podstawie parametrów połączenia przekazanych do konstruktora. Ta klasa jest używana przez warstwę protokołu zestawu SDK do dodawania nagłówków uwierzytelniania do każdego żądania.
Twin	Bliźniaczą reprezentacją urządzenia jest dokument opisujący stan urządzenia przechowywanego przez centrum Azure IoT Hub i jest dostępny nawet wtedy, gdy urządzenie jest w trybie offline. Jest on tworzony w około 3 sekcjach: Tagi: pary klucz/wartość są dostępne tylko po stronie usługi Żądane właściwości: zaktualizowane przez usługę i odebrane przez urządzenie Zgłaszane właściwości: zaktualizowane przez urządzenie i odebrane przez usługę. Należy pamiętać, że chociaż jest to możliwe, żądane i zgłoszone właściwości nie muszą być zgodne i że logika synchronizacji tych dwóch kolekcji, w razie potrzeby, jest pozostawiona użytkownikowi zestawu SDK. Aby uzyskać więcej informacji, zobacz Understanding Device Twins (Opis bliźniaczych reprezentacji urządzeń). Zalecanym sposobem uzyskania Twin dla określonego urządzenia jest użycie getTwin(string, HttpResponseCallback<Twin>) metody .

Interfejsy

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration	Obiekt Configuration reprezentuje konfigurację pojedynczego urządzenia lub może reprezentować wdrożenie, które można zastosować jako konfigurację do urządzeń w oparciu o element targetCondition.
ConfigurationContent
ConfigurationMetrics
DeviceMethodParams	Opisuje parametry, które są dostępne do użycia z metodami bezpośrednimi (nazywanymi również metodami urządzeń)
Module

Aliasy typu

TransportCtor

ConnectionState

DeviceStatus

JobCallback

BulkRegistryOperationType

JobCallback

ResponseCallback