azure-iothub package

Třídy

Client	Klient služby IoT Hub se používá ke komunikaci se zařízeními prostřednictvím služby Azure IoT Hub. Umožňuje uživateli sady SDK: odesílání cloud-zařízení (označované také jako příkazy) do zařízení: příkazy se zařadí do fronty ve službě IoT Hub a asynchronně jenom v době, kdy je zařízení připojené. Do fronty na zařízení je možné zařadit pouze 50 příkazů. vyvolání přímých metod na zařízeních (které budou fungovat jenom 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 odesílané zařízeními pro předchozí příkazy. naslouchejte oznámení o nahrávání souborů ze zařízení. Uživatelé by měli vytvořit nové instance Client voláním jedné z metod továrny, zConnectionString nebo zesharedAccessSignature, vytvořit klienta služby IoT Hub.
Device	Vytvoří reprezentaci zařízení pro použití s registrem identit zařízení rozhraníMI API. Tato třída je zastaralá, protože registr identit zařízení může pracovat přímo s objekty JSON obsahujícími částečný popis zařízení, nikoli nutně úplný objekt. Na začátku byla tato třída odeslána překlepem na název vlastnosti symmetricKey (místo camel-cased). Sada SDK udržuje tuto třídu v pořádku, aby nepřerušila stávající kód, ale v budoucí aktualizaci hlavní verze se odebere a zákazníci by měli místo toho používat prosté objekty JSON.
JobClient	Poskytuje metody pro vytváření, aktualizaci, monitorování a rušení dlouhotrvajících úloh v instanci ioT Hubu a také dotazování existujících úloh. Rozhraní API úloh v Azure IoT Hubu umožňuje naplá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 vytvoří instance JobClient pomocí metod továrny fromConnectionString(string) a fromSharedAccessSignature(string).
Registry	Třída Registru poskytuje přístup ke službě identit zařízení služby IoT Hub. Uživatelé sady SDK by měli vytvořit instanci této třídy pomocí jedné z metod továrny: fromConnectionString nebo zesharedAccessSignature. Protokol používaný pro operace registru identit zařízení je HTTPS.
Amqp	Přenosová třída používaná klientem služby pro připojení k centru Azure IoT 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 je předána do jedné z metod Client továrny: fromConnectionString nebo zesharedAccessSignature.
AmqpWs	Transportní třída používaná klientem služby pro připojení k centru Azure IoT pomocí protokolu AMQP přes zabezpečené websockety. Tato třída by neměla být použita přímo a místo toho je předána do jedné z metod Client továrny: fromConnectionString nebo zesharedAccessSignature.
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í hlaviček ověřování do každého požadavku.
Twin	Dvojče zařízení je dokument popisující stav zařízení, které je uložené centrem Azure IoT, a je k dispozici i v případě, že je zařízení offline. Je postaven kolem 3 částí: Značky: Páry klíč/hodnota jsou přístupné pouze ze strany služby. Požadované vlastnosti: Aktualizováno službou a přijato zařízením Ohlášené vlastnosti: aktualizováno zařízením a přijatou službou. Mějte na paměti, že i když je to možnost, požadované a hlášené vlastnosti nemusí odpovídat a že logika synchronizace těchto dvou kolekcí je v případě potřeby ponechána uživateli sady SDK. Další informace naleznete 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 pro 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