azure-iothub package

Klasser

Client	Den IoT Hub-tjänstklienten används för att kommunicera med enheter via en Azure IoT-hubb. Det gör att SDK-användaren kan: skicka moln-till-enhet (kallas även kommandon) till enheter: kommandon placeras i kö på IoT Hub och levereras asynkront endast när enheten är ansluten. Endast 50 kommandon kan placeras i kö per enhet. anropa direktmetoder på enheter (som endast fungerar om enheten för närvarande är ansluten: det är ett synkront sätt att kommunicera med enheten) lyssna efter feedbackmeddelanden som skickats av enheter för tidigare kommandon. lyssna efter meddelanden om filuppladdning från enheter. Användare bör skapa nya Client instanser genom att anropa någon av fabriksmetoderna, frånConnectionString eller fromSharedAccessSignature, för att skapa en IoT Hub-tjänstklient.
Device	Skapar en representation av en enhet för användning med API:erna för enhetsidentitetsregistret . Den här klassen är inaktuell eftersom enhetsidentitetsregistret kan fungera direkt med JSON-objekt som innehåller en partiell beskrivning av enheten, inte nödvändigtvis det fullständiga objektet. Utöver det levererades den här klassen inledningsvis med ett skrivfel på symmetricKey egenskapsnamnet (det var pascal-cased istället för kamelfodrad). SDK:et behåller den här klassen för att inte bryta befintlig kod, men den tas bort i en framtida högre versionsuppdatering och kunderna bör i stället använda vanliga JSON-objekt.
JobClient	Innehåller metoder för att skapa, uppdatera, övervaka och avbryta långvariga jobb på en IoT Hub-instans, samt köra frågor mot befintliga jobb. Med JOBB-API:et i Azure IoT Hub kan du schemalägga direkta metodanrop och tvillinguppdateringar på flera enheter. SDK-användare förväntas skapa JobClient instanser med hjälp av fabriksmetoderna fromConnectionString(string) och fromSharedAccessSignature(string).
Registry	Klassen Registry ger åtkomst till IoT Hub enhetsidentitetstjänsten. Användare av SDK:t bör instansiera den här klassen med någon av fabriksmetoderna: fromConnectionString eller fromSharedAccessSignature. Protokollet som används för enhetsidentitetsregisteråtgärder är HTTPS.
Amqp	Transportklass som används av tjänstklienten för att ansluta till Azure IoT Hub med hjälp av AMQP-protokollet via en säker (TLS)-socket. Den här klassen bör inte användas direkt och skickas i stället till någon av fabriksmetoderna Client : fromConnectionString eller fromSharedAccessSignature.
AmqpWs	Transportklass som används av tjänstklienten för att ansluta till Azure IoT-hubben med hjälp av AMQP-protokollet via säkra websockets. Den här klassen bör inte användas direkt och skickas i stället till någon av fabriksmetoderna Client : fromConnectionString eller fromSharedAccessSignature.
DigitalTwinClient
IoTHubTokenCredentials	Skapar signaturer för delad åtkomst baserat på anslutningssträngen som skickas till konstruktorn. Den här klassen används av protokolllagret i SDK:et för att lägga till autentiseringshuvuden i varje begäran.
Twin	En enhetstvilling är ett dokument som beskriver tillståndet för en enhet som lagras av en Azure IoT-hubb och är tillgänglig även om enheten är offline. Den är byggd i tre avsnitt: Taggar: nyckel/värde-par som endast är tillgängliga från tjänstsidan Önskade egenskaper: uppdateras av en tjänst och tas emot av enheten Rapporterade egenskaper: uppdaterades av enheten och togs emot av tjänsten. Observera att även om det är möjligt behöver önskade och rapporterade egenskaper inte matcha och att logiken för att synkronisera dessa två samlingar, om det behövs, lämnas till SDK-användaren. Mer information finns i Förstå enhetstvillingar. Det rekommenderade sättet att hämta en Twin för en specifik enhet är att använda getTwin(string, HttpResponseCallback<Twin>) metoden .

Gränssnitt

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration	Konfigurationsobjektet representerar konfigurationen av en enskild enhet, eller så kan det representera en distribution som kan tillämpas som en konfiguration på enheter baserat på targetCondition.
ConfigurationContent
ConfigurationMetrics
DeviceMethodParams	Beskriver de parametrar som är tillgängliga för användning med direkta metoder (kallas även enhetsmetoder)
Module

Typalias

TransportCtor

ConnectionState

DeviceStatus

JobCallback

BulkRegistryOperationType

JobCallback

ResponseCallback