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:
Użytkownicy powinni utworzyć nowe wystąpienia Client przez wywołanie jednej z metod fabryki, z ConnectionString lub zsharedAccessSignature, aby utworzyć klienta usługi IoT Hub. |
Device |
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 |
JobClient |
Udostępnia metody tworzenia, aktualizowania, monitorowania i anulowania długotrwałych zadań w wystąpieniu usługi IoT Hub, a także wykonywania zapytań dotyczących istniejących zadań. Interfejs API zadań w usłudze 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ć wystąpienia JobClient przy użyciu metod fabrycznych fromConnectionString(string) i fromSharedAccessSignature(string). |
Registry |
Klasa Registry zapewnia dostęp do usługi tożsamości urządzenia usługi IoT Hub. Użytkownicy zestawu SDK powinni utworzyć wystąpienie tej klasy przy użyciu jednej z metod fabrycznych: z ConnectionString lub zSharedAccessSignature. 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 bezpiecznego gniazda (TLS). Ta klasa nie powinna być używana bezpośrednio i zamiast tego jest przekazywana do jednej z metod fabryki Client: fromConnectionString lub zSharedAccessSignature. |
AmqpWs |
Klasa transportu używana przez klienta usługi do nawiązywania połączenia z usługą Azure IoT Hub przy użyciu protokołu AMQP za pośrednictwem bezpiecznych obiektów websocket. Ta klasa nie powinna być używana bezpośrednio i zamiast tego jest przekazywana do jednej z metod fabryki Client: fromConnectionString lub zSharedAccessSignature. |
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źniacze reprezentacje urządzenia to 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 zbudowany w około 3 sekcjach:
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 do synchronizacji tych dwóch kolekcji, w razie potrzeby, jest pozostawiona użytkownikowi zestawu SDK. Aby uzyskać więcej informacji, zobacz Understanding Device Twins. Zalecanym sposobem uzyskania Twin dla określonego urządzenia jest użycie metody getTwin(string, HttpResponseCallback<Twin>). |
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ń na podstawie elementu 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 |