Freigeben über


azure-iot-common package

Klassen

Message

Das Message-Objekt wird für Telemetrie (Geräte-zu-Cloud) und Befehle (Cloud-zu-Gerät) asynchrones Messaging zwischen dem Gerät und dem IoT Hub-Dienst verwendet. Es ist transportagnostisch, d. h., es funktioniert auf die gleiche Weise über AMQP, MQTT und HTTP.

ArgumentError

Fehler, der ausgelöst wird, wenn ein Argument ungültig ist.

ArgumentOutOfRangeError

Fehler ausgelöst, wenn ein Argument einen Wert aufweist, der außerhalb des zulässigen Bereichs liegt.

BadDeviceResponseError

Fehler, der ausgelöst wird, wenn ein Gerät eine fehlerhafte Antwort an einen Gerätemethodenaufruf sendet.

CloudToDeviceDetachedError

Fehler ausgelöst, wenn das c2d-Feature nicht mehr auf Transportebene funktioniert, sodass der Client den Vorgang erneut starten muss.

DeviceAlreadyExistsError

Fehler ausgelöst, wenn die für die Geräteerstellung verwendete Geräte-ID bereits in der Geräteidentitätsregistrierung vorhanden ist.

DeviceMaximumQueueDepthExceededError

Fehler ausgelöst, wenn die Nachrichtenwarteschlange für ein Gerät voll ist.

DeviceMessageLockLostError

Beim Beheben einer Nachricht wird ein Fehler ausgelöst, da das der Nachricht zugeordnete Sperrtoken verloren geht.

DeviceMethodsDetachedError

Fehler ausgelöst, wenn das Feature "Gerätemethoden" nicht mehr auf Transportebene funktioniert, sodass der Client den Vorgang erneut starten muss.

DeviceNotFoundError

Fehler ausgelöst, wenn ein Gerät in der IoT Hub-Instanzregistrierung nicht gefunden werden kann.

DeviceRegistrationFailedError

Fehler, der ausgelöst wird, wenn ein DPS-Registrierungsvorgang fehlschlägt

DeviceTimeoutError

Fehler, der ausgelöst wird, wenn das Gerät den Methodenaufruf nicht rechtzeitig verarbeitet.

FormatError

Fehler ausgelöst, wenn eine Zeichenfolge, die eine bestimmte Formatierung aufweisen soll, nicht ordnungsgemäß formatiert ist.

GatewayTimeoutError

Fehler, der ausgelöst wird, wenn die IoT Hub-Instanz den Gerätemethodenaufruf nicht rechtzeitig verarbeitet.

InternalServerError

Fehler ausgelöst, wenn ein interner Serverfehler aufgetreten ist. Möglicherweise haben Sie einen Fehler gefunden?

InvalidEtagError

Fehler, der ausgelöst wird, wenn das angegebene eTag falsch formatiert oder veraltet ist.

InvalidOperationError

Fehler, der ausgelöst wird, wenn ein Vorgang versucht wird, aber nicht zulässig ist.

IotHubNotFoundError

Fehler, der ausgelöst wurde, wenn der Azure IoT-Hub nicht gefunden wurde.

IotHubQuotaExceededError

Fehler, der ausgelöst wurde, wenn das Azure IoT-Hubkontingent überschritten wurde. Kontingente werden regelmäßig zurückgesetzt, dieser Vorgang muss bis dahin warten. Weitere Informationen zu Kontingenten finden Sie unter Azure IoT Hub-Kontingente und Drosselung

IoTHubSuspendedError

Fehler, der ausgelöst wird, wenn IoT Hub angehalten wurde.

JobNotFoundError

Fehler ausgelöst, wenn der Auftrag mit dem angegebenen Bezeichner nicht gefunden wurde.

MessageTooLargeError

Der Fehler wird ausgelöst, wenn die gesendete Nachricht zu groß ist: Die maximale Größe beträgt 256 Kb.

NotConnectedError

Der Fehler wird ausgelöst, wenn das Gerät getrennt wird und der Vorgang nicht abgeschlossen werden kann.

NotImplementedError

Fehler ausgelöst, wenn ein Feature noch nicht implementiert ist, aber der Platzhalter vorhanden ist.

OperationCancelledError

Fehler, der ausgelöst wird, wenn ein Vorgang (lokal oder remote) abgebrochen wird

PreconditionFailedError

Fehler, der ausgelöst wurde, wenn eine Bedingung erfüllt werden sollte, um einen Vorgang auszuführen, nicht.

SecurityDeviceError

Fehler, der ausgelöst wird, wenn ein Sicherheitsgerät/Treiber auf niedriger Ebene fehlschlägt.

ServiceUnavailableError

Fehler ausgelöst, wenn der Dienst nicht verfügbar ist. Der Vorgang sollte wiederholt werden.

ThrottlingError

Fehler, der ausgelöst wird, wenn IoT Hub aufgrund einer übermäßigen Aktivität gedrosselt wird. Weitere Informationen zu Kontingenten finden Sie unter Azure IoT Hub-Kontingente und Drosselung

TimeoutError

Fehler beim Auftreten eines Timeouts

TooManyDevicesError

Der Fehler wird ausgelöst, wenn die maximale Anzahl von Geräten auf einem bestimmten Hub erreicht wurde.

TwinDetachedError

Fehler ausgelöst, wenn das Twin-Feature nicht mehr auf Transportebene funktioniert, sodass der Client den Vorgang erneut starten muss.

TwinRequestError

Allgemeiner Fehler wird ausgelöst, wenn eine Zwillingsanforderung mit einem unbekannten Fehlercode fehlschlägt.

UnauthorizedError

Fehler ausgelöst, wenn die Verbindungsparameter falsch sind und der Server die Verbindung verweigert hat.

Connected

Ergebnis, das zurückgegeben wird, wenn ein Transport erfolgreich verbunden ist.

Disconnected

Ergebnis, das zurückgegeben wird, wenn ein Transport erfolgreich getrennt wurde.

MessageAbandoned

Ergebnis, das zurückgegeben wurde, wenn eine Nachricht erfolgreich abgebrochen wurde.

MessageCompleted

Ergebnis, das zurückgegeben wurde, wenn eine Nachricht erfolgreich abgelehnt wurde.

MessageEnqueued

Ergebnis, das zurückgegeben wurde, wenn eine Nachricht erfolgreich enqueuiert wurde.

MessageRejected

Ergebnis, das zurückgegeben wurde, wenn eine Nachricht erfolgreich abgelehnt wurde.

SharedAccessSignatureUpdated

Ergebnis, das zurückgegeben wird, wenn ein SAS-Token erfolgreich aktualisiert wurde.

TransportConfigured

Ergebnis, das zurückgegeben wird, wenn ein Transport erfolgreich konfiguriert wurde.

ConnectionString

Beschreibt die Parameter, mit denen ein Gerät oder eine Cloudanwendung eine Verbindung mit einem Azure IoT-Hub herstellen kann.

ExponentialBackOffWithJitter

Implementiert einen exponentiellen Backoff mit Jitter-Wiederholungsstrategie. Die Funktion zum Berechnen des nächsten Intervalls ist folgendes (x ist der xte Wiederholungsversuche): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)

NoRetry

Stub-Richtlinie, die alle Wiederholungsversuche mit Vorbehalt blockiert. Vorgänge werden nicht wiederholt.

RetryOperation

Implementiert die erforderliche Logik zum Wiederholen von Vorgängen wie Verbinden, Empfangen von C2D-Nachrichten, Senden von Telemetrie, Twin-Updates usw.

SharedAccessSignature

Freigegebene Zugriffssignaturtoken werden verwendet, um die Verbindung bei Verwendung symmetrischer Schlüssel (im Gegensatz zu x509-Zertifikaten) zu authentifizieren, um die Verbindung mit dem Azure IoT-Hub zu sichern.

Schnittstellen

AuthenticationProvider

Schnittstelle, die von Objekten implementiert werden muss, die zum Bereitstellen von Anmeldeinformationen für die vom Geräteclient zum Authentifizieren mit einer Azure IoT-Hubinstanz verwendeten Transporten verwendet werden.

Receiver
RetryPolicy

Schnittstelle, die ein Wiederholungsrichtlinienobjekt beschreibt. Wiederholungsrichtlinien bestehen aus zwei Dingen

  • Ein Algorithmus, der die nächste Wiederholung basierend auf der aktuellen Anzahl oder Wiederholungsversuche berechnet.
  • Ein Fehlerfilter, der basierend auf dem Typ des empfangenen Fehlers entscheidet, ob ein Wiederholungsversuche auftreten soll oder nicht.

Diese 2 Komponenten verbergen sich hinter zwei Methodenaufrufen, die in dieser Schnittstelle beschrieben werden.

TransportConfig

Konfigurationsstruktur, die von Transporten und AuthenticationProvider Objekten zum Speichern und Austauschen von Anmeldeinformationen verwendet wird.

X509

Objekt, das zum Speichern eines X509-Zertifikats und eines Schlüssels zum Verwenden von Transporten verwendet wird.

Dies wird direkt an die Objekte auf niedriger Ebene übergeben, die von Node.js zum Verbinden des TLS-Sockets verwendet werden. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Typaliase

BufferConvertible
ResultWithHttpResponse
Callback

Definiert den Typ, der einen regulären Rückruf mit zwei Ergebnissen beschreibt : eins ist der Fehler, der andere ist der Ergebniswert.

DoubleValueCallback

Definiert den Typ, der den Rückruf mit zwei Ergebnissen beschreibt.

ErrorCallback

Definiert den Typ, der den Rückruf mit nur dem Fehlerergebniswert beschreibt.

HttpResponseCallback

Definiert den Typ, der den Rückruf mit drei Ergebnissen beschreibt: Antwort, unformatierte HTTP-Antwort und ein Fehler.

NoErrorCallback

Definiert den Typ, der den Rückruf mit einem Nicht-Fehler-Ergebniswert beschreibt.

TripleValueCallback

Definiert den Typ, der einen regulären Rückruf mit drei Ergebnissen beschreibt – der erste ist Fehler, die anderen beiden sind die Ergebniswerte.

Enumerationen

AuthenticationType

Legen Sie den Typ der Authentifizierung fest, die von einem AuthenticationProviderverwendet wird.

Functions

anHourFromNow()

Gibt die Sekunden zurück, die seit dem 1. Januar 1970 00:00:00 UTC bis zu einer Stunde vergangen sind.

encodeUriComponentStrict(string)

Details zur Funktion

anHourFromNow()

Gibt die Sekunden zurück, die seit dem 1. Januar 1970 00:00:00 UTC bis zu einer Stunde vergangen sind.

function anHourFromNow(): number

Gibt zurück

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parameter

str

string

Gibt zurück

string