azure-iothub package

Classes

Client	Le client de service IoT Hub est utilisé pour communiquer avec les appareils via un hub Azure IoT. Il permet à l’utilisateur du Kit de développement logiciel (SDK) : envoyer du cloud à l’appareil (également appelé commandes) aux appareils : les commandes sont mises en file d’attente sur IoT Hub et remises de manière asynchrone uniquement lorsque l’appareil est connecté. Seules 50 commandes peuvent être mises en file d’attente par appareil. appeler des méthodes directes sur les appareils (qui fonctionnent uniquement si l’appareil est actuellement connecté : il s’agit d’un moyen synchrone de communiquer avec l’appareil) écoutez les messages de commentaires envoyés par les appareils pour les commandes précédentes. écoutez les notifications de chargement de fichiers à partir d’appareils. Les utilisateurs doivent créer de nouvelles Client instances en appelant l’une des méthodes de fabrique, à partir deConnectionString ou deSharedAccessSignature, pour créer un client de service IoT Hub.
Device	Crée une représentation d’un appareil à utiliser avec les API du Registre d’identités d’appareil . Cette classe est déconseillée , car le registre d’identités d’appareil peut fonctionner directement avec des objets JSON contenant une description partielle de l’appareil, pas nécessairement l’objet complet. En plus de cela initialement, cette classe a été livrée avec une faute de frappe sur le nom de la symmetricKey propriété (il a été cased pascal au lieu de camel-cased). Le Kit de développement logiciel (SDK) conserve cette classe afin de ne pas interrompre le code existant, mais il sera supprimé lors d’une prochaine mise à jour de version majeure et les clients doivent à la place utiliser des objets JSON simples.
JobClient	Fournit des méthodes pour créer, mettre à jour, surveiller et annuler des travaux de longue durée sur une instance de IoT Hub, ainsi que pour interroger des travaux existants. L’API Travaux dans Azure IoT Hub permet de planifier des appels de méthode directe et des mises à jour de jumeau sur plusieurs appareils. Les utilisateurs du KIT de développement logiciel (SDK) doivent créer JobClient des instances à l’aide des méthodes fromConnectionString(string) de fabrique et fromSharedAccessSignature(string).
Registry	La classe Registry fournit l’accès au service d’identité d’appareil IoT Hub. Les utilisateurs du KIT de développement logiciel (SDK) doivent instancier cette classe avec l’une des méthodes de fabrique : fromConnectionString ou fromSharedAccessSignature. Le protocole utilisé pour les opérations de registre d’identités d’appareil est HTTPS.
Amqp	Classe de transport utilisée par le client de service pour se connecter au hub Azure IoT à l’aide du protocole AMQP via un socket sécurisé (TLS). Cette classe ne doit pas être utilisée directement et être passée à l’une Client des méthodes de fabrique : fromConnectionString ou fromSharedAccessSignature.
AmqpWs	Classe de transport utilisée par le client de service pour se connecter au hub Azure IoT à l’aide du protocole AMQP sur des websockets sécurisés. Cette classe ne doit pas être utilisée directement et être passée à l’une Client des méthodes de fabrique : fromConnectionString ou fromSharedAccessSignature.
DigitalTwinClient
IoTHubTokenCredentials	Crée des signatures d’accès partagé basées sur la chaîne de connexion passée au constructeur. Cette classe est utilisée par la couche de protocole du Kit de développement logiciel (SDK) pour ajouter des en-têtes d’authentification à chaque requête.
Twin	Un jumeau d’appareil est un document décrivant l’état d’un appareil stocké par un hub Azure IoT et disponible même si l’appareil est hors connexion. Il est construit autour de 3 sections : Balises : paires clé/valeur accessibles uniquement du côté service Propriétés souhaitées : mises à jour par un service et reçues par l’appareil Propriétés signalées : mises à jour par l’appareil et reçues par le service. Notez que bien qu’il s’agisse d’une possibilité, les propriétés souhaitées et signalées n’ont pas besoin de correspondre et que la logique de synchronisation de ces deux collections, si nécessaire, est laissée à l’utilisateur du KIT de développement logiciel (SDK). Pour plus d’informations, consultez Présentation des jumeaux d’appareil. La méthode recommandée pour obtenir un Twin pour un appareil spécifique consiste à utiliser la getTwin(string, HttpResponseCallback<Twin>) méthode .

Interfaces

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration	L’objet Configuration représente la configuration d’un seul appareil ou il peut représenter un déploiement qui peut être appliqué en tant que configuration à des appareils en fonction de la condition cible.
ConfigurationContent
ConfigurationMetrics
DeviceMethodParams	Décrit les paramètres disponibles pour une utilisation avec des méthodes directes (également appelées méthodes d’appareil)
Module

Alias de type

TransportCtor

ConnectionState

DeviceStatus

JobCallback

BulkRegistryOperationType

JobCallback

ResponseCallback