azure-iot-common package

Klassen

Message	Das Message -Objekt wird für Telemetriedaten (Device-to-Cloud) und Befehle (Cloud-to-Device) asynchrones Messaging zwischen dem Gerät und dem IoT Hub-Dienst verwendet. Es ist transportagnostisch, was bedeutet, dass es über AMQP, MQTT und HTTP auf die gleiche Weise funktioniert.
ArgumentError	Fehler, wenn ein Argument ungültig ist.
ArgumentOutOfRangeError	Fehler wird ausgelöst, wenn ein Argument über einen Wert außerhalb des zulässigen Bereichs verfügt.
BadDeviceResponseError	Fehler, der ausgelöst wird, wenn ein Gerät eine fehlerhafte Antwort an einen Gerätemethodenaufruf sendet.
CloudToDeviceDetachedError	Fehler, der ausgelöst wird, wenn das c2d-Feature auf Transportebene nicht mehr funktioniert, sodass der Client es erneut starten muss.
DeviceAlreadyExistsError	Fehler, der ausgelöst wird, wenn die für die Geräteerstellung verwendete Geräte-ID bereits in der Geräteidentitätsregistrierung vorhanden ist.
DeviceMaximumQueueDepthExceededError	Fehler, der ausgelöst wird, wenn die Nachrichtenwarteschlange für ein Gerät voll ist.
DeviceMessageLockLostError	Fehler beim Festlegen einer Nachricht, weil das der Nachricht zugeordnete Sperrtoken verloren geht.
DeviceMethodsDetachedError	Fehler, der ausgelöst wird, wenn das Gerätemethodenfeature auf Transportebene nicht mehr funktioniert, sodass der Client es erneut starten muss.
DeviceNotFoundError	Fehler, wenn ein Gerät nicht in der IoT Hub instance Registrierung gefunden werden kann.
DeviceRegistrationFailedError	Fehler beim Fehler eines DPS-Registrierungsvorgangs
DeviceTimeoutError	Fehler, der ausgelöst wird, wenn das Gerät den Methodenaufruf nicht rechtzeitig verarbeitet.
FormatError	Fehler, wenn eine Zeichenfolge, die eine bestimmte Formatierung aufweisen soll, nicht ordnungsgemäß formatiert ist.
GatewayTimeoutError	Fehler, der ausgelöst wird, wenn der IoT Hub instance den Gerätemethodenaufruf nicht rechtzeitig verarbeitet.
InternalServerError	Fehler, der ausgelöst wird, wenn ein interner Serverfehler aufgetreten ist. Sie haben möglicherweise einen Fehler gefunden?
InvalidEtagError	Fehler, wenn das angegebene eTag falsch formatiert oder veraltet ist.
InvalidOperationError	Fehler, der ausgelöst wird, wenn ein Vorgang versucht, aber nicht zulässig ist.
IotHubNotFoundError	Fehler, der ausgelöst wurde, wenn der Azure IoT Hub nicht gefunden wurde.
IotHubQuotaExceededError	Fehler: Das Azure IoT Hub-Kontingent wurde überschritten. 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	Fehler, der ausgelöst wird, wenn die gesendete Nachricht zu groß ist: Die maximale Größe beträgt 256 KB.
NotConnectedError	Fehler, der ausgelöst wird, wenn das Gerät getrennt ist und der Vorgang nicht abgeschlossen werden kann.
NotImplementedError	Fehler wird ausgelöst, wenn ein Feature noch nicht implementiert ist, aber der Platzhalter vorhanden ist.
OperationCancelledError	Fehler beim Abbrechen eines beliebigen Vorgangs (lokal oder remote)
PreconditionFailedError	Fehler, wenn eine Bedingung, die erfüllt werden sollte, um einen Vorgang auszuführen, nicht erfüllt wurde.
SecurityDeviceError	Fehler, wenn ein Gerät/Treiber der niedrigen Sicherheitsstufe ausfällt.
ServiceUnavailableError	Fehler, der ausgelöst wird, wenn der Dienst nicht verfügbar ist. Der Vorgang sollte wiederholt werden.
ThrottlingError	Fehler, der ausgelöst wird, wenn IoT Hub aufgrund übermäßiger Aktivität gedrosselt wird. Weitere Informationen zu Kontingenten finden Sie unter Azure IoT Hub Kontingente und Drosselung.
TimeoutError	Fehler beim Auftreten eines Timeouts
TooManyDevicesError	Fehler, wenn die maximale Anzahl von Geräten auf einem bestimmten Hub erreicht wurde.
TwinDetachedError	Fehler, der ausgelöst wird, wenn das Zwillingsfeature auf Transportebene nicht mehr funktioniert, sodass der Client es erneut starten muss.
TwinRequestError	Generischer Fehler, der ausgelöst wird, wenn eine Zwillingsanforderung mit einem unbekannten Fehlercode fehlschlägt.
UnauthorizedError	Fehler, wenn die Verbindungsparameter falsch sind und der Server die Verbindung verweigert hat.
Connected	Das Ergebnis wird zurückgegeben, wenn ein Transport erfolgreich verbunden wurde.
Disconnected	Das Ergebnis wird zurückgegeben, wenn die Verbindung eines Transports erfolgreich getrennt wurde.
MessageAbandoned	Das Ergebnis wird zurückgegeben, wenn eine Nachricht erfolgreich abgebrochen wurde.
MessageCompleted	Das Ergebnis wird zurückgegeben, wenn eine Nachricht erfolgreich abgelehnt wurde.
MessageEnqueued	Das Ergebnis wird zurückgegeben, wenn eine Nachricht erfolgreich in die Warteschlange eingereiht wurde.
MessageRejected	Das Ergebnis wird zurückgegeben, wenn eine Nachricht erfolgreich abgelehnt wurde.
SharedAccessSignatureUpdated	Das Ergebnis wird zurückgegeben, wenn ein SAS-Token erfolgreich aktualisiert wurde.
TransportConfigured	Das Ergebnis wird zurückgegeben, 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 eine Exponentielle Backoff-Strategie mit Jitter-Wiederholungsversuchen. Die Funktion zum Berechnen des nächsten Intervalls ist die folgende (x ist der xte Wiederholungsversuch): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Stubrichtlinie, die alle Wiederholungsversuche verhindert. Vorgänge werden nicht wiederholt.
RetryOperation	Implementiert die erforderliche Logik für Wiederholungsvorgänge wie herstellen, empfangen von C2D-Nachrichten, Senden von Telemetriedaten, Zwillingsupdates usw.
SharedAccessSignature	Shared Access Signature Token werden verwendet, um die Verbindung zu authentifizieren, wenn symmetrische Schlüssel (im Gegensatz zu x509-Zertifikaten) verwendet werden, um die Verbindung mit dem Azure IoT Hub zu schützen.

Schnittstellen

AuthenticationProvider	Schnittstelle, die von Objekten implementiert werden muss, die zum Bereitstellen von Anmeldeinformationen für die Transporte verwendet werden, die vom Geräteclient zur Authentifizierung bei einem Azure IoT Hub-instance verwendet werden.
Receiver
RetryPolicy	Schnittstelle, die ein Wiederholungsrichtlinienobjekt beschreibt. Wiederholungsrichtlinien bestehen aus 2 Dingen Ein Algorithmus, der die nächste Wiederholung basierend auf der aktuellen Anzahl oder Wiederholung berechnet. Ein Fehlerfilter, der basierend auf dem Typ des empfangenen Fehlers entscheidet, ob ein Wiederholungsversuch erfolgen soll oder nicht. Diese 2 Komponenten verstecken sich hinter 2 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 für transporte 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 den regulären Rückruf mit zwei Ergebnissen beschreibt: Eins ist der Fehler, das 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 dem Fehlerergebniswert beschreibt.
HttpResponseCallback	Definiert den Typ, der den Rückruf mit drei Ergebnissen beschreibt: Antwort, unformatierte HTTP-Antwort und Fehler.
NoErrorCallback	Definiert den Typ, der den Rückruf mit einem Ergebniswert ohne Fehler beschreibt.
TripleValueCallback	Definiert den Typ, der einen regulären Rückruf mit drei Ergebnissen beschreibt: Das erste ist Fehler, die beiden anderen sind die Ergebniswerte.

Enumerationen

AuthenticationType

Legen Sie den Authentifizierungstyp fest, der von verwendet AuthenticationProviderwird.

Functions

anHourFromNow()	Gibt die sekunden zurück, die seit dem 1. Januar 1970 00:00:00:00 UTC bis zu einer Stunde verstrichen sind.
encodeUriComponentStrict(string)

Details zur Funktion

anHourFromNow()

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

function anHourFromNow(): number

Gibt zurück

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parameter

str

string

Gibt zurück

string