azure-iothub package

Třídy

Client	Klient služby IoT Hub slouží ke komunikaci se zařízeními prostřednictvím služby Azure IoT Hub. Umožňuje uživateli sady SDK: odesílání příkazů cloud-zařízení (označované také jako příkazy) do zařízení: příkazy se zadají do fronty na IoT Hub a doručují se asynchronně, jenom když je zařízení připojené. Pro každé zařízení je možné zařadit do fronty pouze 50 příkazů. vyvolání přímých metod na zařízeních (které budou fungovat pouze v případě, že je zařízení aktuálně připojené: jedná se o synchronní způsob komunikace se zařízením) poslouchejte zprávy zpětné vazby odeslané zařízeními pro předchozí příkazy. naslouchání oznámením o nahrávání souborů ze zařízení. Uživatelé by měli vytvářet nové Client instance voláním jedné z metod továrny, fromConnectionString nebo fromSharedAccessSignature, aby vytvořili klienta služby IoT Hub.
Device	Vytvoří reprezentaci zařízení pro použití s rozhraními API registru identit zařízení . Tato třída je zastaralá , protože registr identit zařízení může pracovat přímo s objekty JSON, které obsahují částečný popis zařízení, ne nutně úplný objekt. Navíc byla tato třída původně dodána s překlepem v symmetricKey názvu vlastnosti (místo s velbloudími písmeny). Sada SDK tuto třídu udržuje, aby nedošlo k narušení existujícího kódu, ale v budoucí aktualizaci hlavní verze se odebere a zákazníci by místo toho měli používat prosté objekty JSON.
JobClient	Poskytuje metody pro vytváření, aktualizaci, monitorování a rušení dlouhotrvajících úloh v instanci IoT Hub a dotazování existujících úloh. Rozhraní API pro úlohy v Azure IoT Hub umožňuje plánovat volání přímých metod a aktualizace dvojčat na více zařízeních. Očekává se, že uživatelé sady SDK budou vytvářet JobClient instance pomocí metod fromConnectionString(string) z výroby a fromSharedAccessSignature(string).
Registry	Třída Registry poskytuje přístup ke službě identit zařízení IoT Hub. Uživatelé sady SDK by měli vytvořit instanci této třídy pomocí jedné z metod továrny: fromConnectionString nebo fromSharedAccessSignature. Protokol používaný pro operace registru identit zařízení je HTTPS.
Amqp	Transportní třída používaná klientem služby pro připojení ke službě Azure IoT Hub pomocí protokolu AMQP přes zabezpečený soket (TLS). Tato třída by neměla být použita přímo a místo toho by měla být předána jedné z Client metod výroby: fromConnectionString nebo zSharedAccessSignature.
AmqpWs	Transportní třída používaná klientem služby pro připojení ke službě Azure IoT Hub pomocí protokolu AMQP přes zabezpečené protokoly websocket. Tato třída by neměla být použita přímo a místo toho by měla být předána jedné z Client metod výroby: fromConnectionString nebo zSharedAccessSignature.
DigitalTwinClient
IoTHubTokenCredentials	Vytvoří sdílené přístupové podpisy na základě připojovacího řetězce předaného konstruktoru. Tuto třídu používá vrstva protokolu sady SDK k přidání ověřovacích hlaviček do každého požadavku.
Twin	Dvojče zařízení je dokument popisující stav zařízení, které je uložené ve službě Azure IoT Hub a je dostupné, i když je zařízení offline. Je postaven kolem 3 sekcí: Značky: Páry klíč-hodnota přístupné pouze ze strany služby Požadované vlastnosti: aktualizovány službou a přijaty zařízením Ohlášené vlastnosti: Aktualizováno zařízením a přijímá je služba. Mějte na paměti, že i když je to možné, požadované a hlášené vlastnosti se nemusí shodovat a že logika synchronizace těchto dvou kolekcí je v případě potřeby ponechána na uživateli sady SDK. Další informace najdete v tématu Principy dvojčat zařízení. Doporučeným způsobem, jak získat Twin pro konkrétní zařízení, je použít metodu .getTwin(string, HttpResponseCallback<Twin>)

Rozhraní

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration	Objekt Configuration představuje konfiguraci jednoho zařízení nebo může představovat nasazení, které lze použít jako konfiguraci na zařízení na základě targetCondition.
ConfigurationContent
ConfigurationMetrics
DeviceMethodParams	Popisuje parametry, které jsou k dispozici pro použití s přímými metodami (označované také jako metody zařízení).
Module

Aliasy typu

TransportCtor

ConnectionState

DeviceStatus

JobCallback

BulkRegistryOperationType

JobCallback

ResponseCallback