azure-iot-common package

Klassen

Message	Het Message object wordt gebruikt voor telemetrie (apparaat-naar-cloud) en opdrachten (cloud-naar-apparaat) asynchrone berichten tussen het apparaat en de IoT Hub-service. Het is transportagnostisch, wat betekent dat het op dezelfde manier werkt via AMQP, MQTT en HTTP.
ArgumentError	Er is een fout opgetreden wanneer een argument ongeldig is.
ArgumentOutOfRangeError	Er is een fout opgetreden wanneer een argument een waarde heeft die buiten het toegestane bereik valt.
BadDeviceResponseError	Er is een fout opgetreden wanneer een apparaat een ongeldig antwoord verzendt op een aanroep van een apparaatmethode.
CloudToDeviceDetachedError	Er is een fout opgetreden toen de c2d-functie niet meer werkte op transportniveau, waardoor de client deze opnieuw moest starten.
DeviceAlreadyExistsError	Er is een fout opgetreden wanneer de apparaat-id die wordt gebruikt voor het maken van het apparaat al bestaat in het register voor apparaat-id's.
DeviceMaximumQueueDepthExceededError	Er is een fout opgetreden wanneer de berichtenwachtrij voor een apparaat vol is.
DeviceMessageLockLostError	Er is een fout opgetreden bij het afhandelen van een bericht, omdat het vergrendelingstoken dat aan het bericht is gekoppeld, verloren is gegaan.
DeviceMethodsDetachedError	Er is een fout opgetreden toen de functie apparaatmethoden niet meer werkte op transportniveau, waardoor de client het opnieuw moest proberen te starten.
DeviceNotFoundError	Er is een fout opgetreden wanneer een apparaat niet kan worden gevonden in het register van het IoT Hub-exemplaar.
DeviceRegistrationFailedError	Er is een fout opgetreden wanneer een DPS-registratiebewerking mislukt
DeviceTimeoutError	Er is een fout opgetreden wanneer het apparaat de methode-aanroep niet op tijd verwerkt.
FormatError	Er is een fout opgetreden wanneer een tekenreeks die een specifieke opmaak moet hebben, niet juist is opgemaakt.
GatewayTimeoutError	Er is een fout opgetreden wanneer het IoT Hub-exemplaar de aanroep van de apparaatmethode niet op tijd verwerkt.
InternalServerError	Er is een fout opgetreden bij het optreden van een interne serverfout. Heb je misschien een fout gevonden?
InvalidEtagError	Er is een fout opgetreden wanneer de opgegeven eTag onjuist is opgemaakt of verouderd is.
InvalidOperationError	Er is een fout opgetreden wanneer een bewerking wordt geprobeerd, maar niet is toegestaan.
IotHubNotFoundError	Er is een fout opgetreden toen de Azure IoT-hub niet werd gevonden.
IotHubQuotaExceededError	Er is een fout opgetreden dat het quotum van de Azure IoT-hub is overschreden. Quota's worden periodiek opnieuw ingesteld. Deze bewerking moet tot die tijd wachten. Zie quota en beperking Azure IoT Hub voor meer informatie over quota
IoTHubSuspendedError	Er is een fout opgetreden wanneer IoT Hub is onderbroken.
JobNotFoundError	Er is een fout opgetreden wanneer de taak met de opgegeven id niet is gevonden.
MessageTooLargeError	Er is een fout opgetreden wanneer het verzonden bericht te groot is: de maximale grootte is 256 kB.
NotConnectedError	Er is een fout opgetreden wanneer de verbinding met het apparaat is verbroken en de bewerking niet kan worden voltooid.
NotImplementedError	Er is een fout opgetreden wanneer een functie nog niet is geïmplementeerd, maar de tijdelijke aanduiding wel aanwezig is.
OperationCancelledError	Er is een fout opgetreden wanneer een bewerking (lokaal of extern) wordt geannuleerd
PreconditionFailedError	Er is een fout opgetreden wanneer niet aan een voorwaarde was voldaan om een bewerking uit te voeren.
SecurityDeviceError	Er is een fout opgetreden wanneer een apparaat/stuurprogramma voor beveiliging op laag niveau uitvalt.
ServiceUnavailableError	Er is een fout opgetreden wanneer de service niet beschikbaar is. De bewerking moet opnieuw worden uitgevoerd.
ThrottlingError	Er is een fout opgetreden wanneer IoT Hub wordt beperkt vanwege overmatige activiteit. Zie quota en beperking Azure IoT Hub voor meer informatie over quota
TimeoutError	Er is een fout opgetreden wanneer er een time-out optreedt
TooManyDevicesError	Er is een fout opgetreden wanneer het maximum aantal apparaten op een specifieke hub is bereikt.
TwinDetachedError	Er is een fout opgetreden toen de dubbelfunctie niet meer werkte op transportniveau, waardoor de client deze opnieuw moest starten.
TwinRequestError	Algemene fout die optreedt wanneer een dubbelaanvraag mislukt met een onbekende foutcode.
UnauthorizedError	Er is een fout opgetreden wanneer de verbindingsparameters onjuist zijn en de server de verbinding heeft geweigerd.
Connected	Resultaat dat wordt geretourneerd wanneer een transport is verbonden.
Disconnected	Het resultaat wordt geretourneerd wanneer de verbinding van een transport is verbroken.
MessageAbandoned	Het resultaat wordt geretourneerd wanneer een bericht is verwijderd.
MessageCompleted	Het resultaat wordt geretourneerd wanneer een bericht is geweigerd.
MessageEnqueued	Het resultaat wordt geretourneerd wanneer een bericht is ge enqueueerd.
MessageRejected	Het resultaat wordt geretourneerd wanneer een bericht is geweigerd.
SharedAccessSignatureUpdated	Het resultaat wordt geretourneerd wanneer een SAS-token is bijgewerkt.
TransportConfigured	Resultaat dat wordt geretourneerd wanneer een transport is geconfigureerd.
ConnectionString	Beschrijft de parameters waarmee een apparaat of cloudtoepassing verbinding kan maken met een Azure IoT-hub.
ExponentialBackOffWithJitter	Implementeert een exponentiële uitstel met Jitter-strategie voor opnieuw proberen. De functie voor het berekenen van het volgende interval is de volgende (x is de xe poging): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Stub-beleid dat elke voorlopige poging blokkeert. Bewerkingen worden niet opnieuw geprobeerd.
RetryOperation	Implementeert de benodigde logica voor het opnieuw proberen van bewerkingen, zoals verbinding maken, C2D-berichten ontvangen, telemetrie verzenden, dubbelupdates, enzovoort.
SharedAccessSignature	Shared Access Signature-tokens worden gebruikt om de verbinding te verifiëren bij het gebruik van symmetrische sleutels (in tegenstelling tot x509-certificaten) om de verbinding met de Azure IoT-hub te beveiligen.

Interfaces

AuthenticationProvider	Interface die moet worden geïmplementeerd door objecten die worden gebruikt om referenties te verstrekken aan de transporten die door de apparaatclient worden gebruikt voor verificatie met een Azure IoT Hub-exemplaar.
Receiver
RetryPolicy	Interface die een beleidsobject voor opnieuw proberen beschrijft. Beleid voor opnieuw proberen bestaat uit 2 dingen Een algoritme dat de volgende keer berekent om het opnieuw te proberen op basis van het huidige aantal of nieuwe pogingen. Een foutfilter dat bepaalt, op basis van het type fout dat is ontvangen, of een nieuwe poging moet plaatsvinden of niet. Deze twee onderdelen verbergen zich achter 2 methode-aanroepen die in deze interface worden beschreven.
TransportConfig	Configuratiestructuur die wordt gebruikt door transporten en AuthenticationProvider objecten om referenties op te slaan en uit te wisselen.
X509	Object dat wordt gebruikt voor het opslaan van een X509-certificaat en -sleutel voor transporten. Dit wordt rechtstreeks doorgegeven aan de objecten op laag niveau die door Node.js worden gebruikt om de TLS-socket te verbinden. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Type-aliassen

BufferConvertible
ResultWithHttpResponse
Callback	Definieert het type dat de reguliere callback beschrijft met twee resultaten: de ene is de fout, de andere is de resultaatwaarde.
DoubleValueCallback	Definieert het type dat callback beschrijft met twee resultaten.
ErrorCallback	Definieert het type dat callback beschrijft met alleen de resultaatwaarde fout.
HttpResponseCallback	Definieert het type dat callback beschrijft met drie resultaten: antwoord, onbewerkte HTTP-reactie en een fout.
NoErrorCallback	Definieert het type dat callback beschrijft met één resultaatwaarde zonder fout.
TripleValueCallback	Definieert het type dat reguliere callback met drie resultaten beschrijft. De eerste is Fout, de andere twee zijn de resultaatwaarden.

Enums

AuthenticationType

Geef het type verificatie aan dat door een AuthenticationProviderwordt gebruikt.

Functies

anHourFromNow()	Retourneert de seconden die zijn verstreken sinds 1 januari 1970 00:00:00 UTC tot één uur vanaf nu.
encodeUriComponentStrict(string)

Functiedetails

anHourFromNow()

Retourneert de seconden die zijn verstreken sinds 1 januari 1970 00:00:00 UTC tot één uur vanaf nu.

function anHourFromNow(): number

Retouren

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parameters

str

string

Retouren

string