azure-iothub package

Klassen

Client	Der IoT Hub-Dienstclient wird für die Kommunikation mit Geräten über einen Azure IoT Hub verwendet. Der SDK-Benutzer ermöglicht folgendes: Senden von Cloud-zu-Gerät (auch als Befehle bezeichnet) an Geräte: Befehle werden auf IoT Hub in die Warteschlange gestellt und nur asynchron bereitgestellt, wenn das Gerät verbunden ist. Pro Gerät können nur 50 Befehle in die Warteschlange eingereiht werden. direkte Methoden auf Geräten aufrufen (dies funktioniert nur, wenn das Gerät derzeit verbunden ist: Es handelt sich um eine synchrone Art der Kommunikation mit dem Gerät). auf Feedbackmeldungen lauschen, die von Geräten für vorherige Befehle gesendet wurden. auf Benachrichtigungen zum Dateiupload von Geräten lauschen. Benutzer sollten neue Client Instanzen erstellen, indem sie eine der Factorymethoden fromConnectionString oder fromSharedAccessSignature aufrufen, um einen IoT Hub-Dienstclient zu erstellen.
Device	Erstellt eine Darstellung eines Geräts zur Verwendung mit den Geräteidentitätsregistrierungs-APIs . Diese Klasse ist veraltet , da die Geräteidentitätsregistrierung direkt mit JSON-Objekten arbeiten kann, die eine partielle Beschreibung des Geräts enthalten, nicht unbedingt das vollständige Objekt. Darüber hinaus wurde diese Klasse anfangs mit einem Tippfehler für den symmetricKey Eigenschaftsnamen ausgeliefert (sie war pascal-cased statt camel-cased). Das SDK behält diese Klasse bei, um vorhandenen Code nicht zu unterbrechen. Dies wird jedoch in einem zukünftigen Hauptversionsupdate entfernt, und Kunden sollten stattdessen einfache JSON-Objekte verwenden.
JobClient	Stellt Methoden zum Erstellen, Aktualisieren, Überwachen und Abbrechen von Aufträgen mit langer Ausführungszeit auf einer IoT Hub-Instanz sowie zum Abfragen vorhandener Aufträge bereit. Die Auftrags-API in Azure IoT Hub ermöglicht das Planen direkter Methodenaufrufe und Zwillingsupdates auf mehreren Geräten. Von SDK-Benutzern wird erwartet, dass sie Instanzen mit den Factorymethoden fromConnectionString(string) und fromSharedAccessSignature(string)erstellenJobClient.
Registry	Die Registry-Klasse bietet Zugriff auf den IoT Hub Geräteidentitätsdienst. Benutzer des SDK sollten diese Klasse mit einer der Factorymethoden instanziieren: fromConnectionString oder fromSharedAccessSignature. Das protokoll, das für Registrierungsvorgänge für Geräteidentitäten verwendet wird, ist HTTPS.
Amqp	Transportklasse, die vom Dienstclient zum Herstellen einer Verbindung mit dem Azure IoT Hub mithilfe des AMQP-Protokolls über einen sicheren (TLS)-Socket verwendet wird. Diese Klasse sollte nicht direkt verwendet werden und stattdessen an eine der Client Factorymethoden übergeben werden: fromConnectionString oder fromSharedAccessSignature.
AmqpWs	Transportklasse, die vom Dienstclient zum Herstellen einer Verbindung mit dem Azure IoT Hub mithilfe des AMQP-Protokolls über sichere Websockets verwendet wird. Diese Klasse sollte nicht direkt verwendet werden und stattdessen an eine der Client Factorymethoden übergeben werden: fromConnectionString oder fromSharedAccessSignature.
DigitalTwinClient
IoTHubTokenCredentials	Erstellt Shared Access Signatures basierend auf der Verbindungszeichenfolge, die an den Konstruktor übergeben wird. Diese Klasse wird von der Protokollebene des SDK verwendet, um jeder Anforderung Authentifizierungsheader hinzuzufügen.
Twin	Ein Gerätezwillen ist ein Dokument, das den Zustand eines Geräts beschreibt, das von einem Azure IoT Hub gespeichert wird und auch dann verfügbar ist, wenn das Gerät offline ist. Es ist um 3 Abschnitte gebaut: Tags: Schlüssel-Wert-Paare, auf die nur von der Dienstseite zugegriffen werden kann Gewünschte Eigenschaften: von einem Dienst aktualisiert und vom Gerät empfangen Gemeldete Eigenschaften: Vom Gerät aktualisiert und vom Dienst empfangen. Beachten Sie, dass, obwohl es möglich ist, gewünschte und gemeldete Eigenschaften nicht übereinstimmen müssen, und dass die Logik zum Synchronisieren dieser beiden Sammlungen, falls erforderlich, dem Benutzer des SDK überlassen bleibt. Weitere Informationen finden Sie unter Grundlegendes zu Gerätezwillys. Die empfohlene Methode zum Abrufen eines Twin für ein bestimmtes Gerät ist die Verwendung der getTwin(string, HttpResponseCallback<Twin>) -Methode.

Schnittstellen

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration	Das Configuration-Objekt stellt die Konfiguration eines einzelnen Geräts dar, oder es kann eine Bereitstellung darstellen, die basierend auf targetCondition als Konfiguration auf Geräten angewendet werden kann.
ConfigurationContent
ConfigurationMetrics
DeviceMethodParams	Beschreibt die Parameter, die für die Verwendung mit direkten Methoden (auch als Gerätemethoden bezeichnet) verfügbar sind.
Module

Typaliase

TransportCtor

ConnectionState

DeviceStatus

JobCallback

BulkRegistryOperationType

JobCallback

ResponseCallback