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 transportneutraal, 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 naar een aanroep van de apparaatmethode verzendt.
CloudToDeviceDetachedError	Er is een fout opgetreden wanneer de c2d-functie niet meer werkt op transportniveau, waardoor de client deze opnieuw moet starten.
DeviceAlreadyExistsError	Er is een fout opgetreden wanneer de apparaat-id die wordt gebruikt voor het maken van het apparaat al bestaat in het apparaatidentiteitsregister.
DeviceMaximumQueueDepthExceededError	Er is een fout opgetreden wanneer de berichtenwachtrij voor een apparaat vol is.
DeviceMessageLockLostError	Er is een fout opgetreden bij het oplossen van een bericht omdat het vergrendelingstoken dat aan het bericht is gekoppeld, is verbroken.
DeviceMethodsDetachedError	Er is een fout opgetreden wanneer de functie apparaatmethoden niet meer werkt op transportniveau, waardoor de client deze opnieuw moet starten.
DeviceNotFoundError	Er is een fout opgetreden wanneer een apparaat niet kan worden gevonden in het IoT Hub-exemplaarregister.
DeviceRegistrationFailedError	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 de IoT Hub-instantie de aanroep van de apparaatmethode niet op tijd verwerkt.
InternalServerError	Er is een fout opgetreden bij het optreden van een interne serverfout. Misschien hebt u een bug 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 uitgevoerd, maar niet is toegestaan.
IotHubNotFoundError	Er is een fout opgetreden bij het niet vinden van de Azure IoT-hub.
IotHubQuotaExceededError	Er is een fout opgetreden bij het overschrijden van het Azure IoT Hub-quotum. Quota worden periodiek opnieuw ingesteld, deze bewerking moet wachten tot die tijd. Zie Azure IoT Hub-quota's en beperking 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 256Kb.
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 aanwezig is.
OperationCancelledError	Er is een fout opgetreden wanneer een bewerking (lokaal of extern) wordt geannuleerd
PreconditionFailedError	Er is een fout opgetreden wanneer aan een voorwaarde moet worden voldaan om een bewerking uit te voeren niet.
SecurityDeviceError	Er is een fout opgetreden wanneer een beveiligingsapparaat/-stuurprogramma met een laag niveau mislukt.
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 Azure IoT Hub-quota's en beperking 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 wanneer de dubbele functie niet meer werkt op transportniveau, waardoor de client deze opnieuw moet 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 geretourneerd wanneer een transport is verbonden.
Disconnected	Resultaat geretourneerd wanneer een transport is verbroken.
MessageAbandoned	Resultaat geretourneerd wanneer een bericht is afgestapt.
MessageCompleted	Resultaat geretourneerd wanneer een bericht is geweigerd.
MessageEnqueued	Resultaat geretourneerd wanneer een bericht is geïntenseerd.
MessageRejected	Resultaat geretourneerd wanneer een bericht is geweigerd.
SharedAccessSignatureUpdated	Resultaat geretourneerd wanneer een SAS-token is bijgewerkt.
TransportConfigured	Resultaat 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 Exponentieel uitstel met Jitter-strategie voor opnieuw proberen. De functie voor het berekenen van het volgende interval is het volgende (x is de xe nieuwe poging): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Stub-beleid dat elke poging voorlopig blokkeert. Bewerkingen worden niet opnieuw geprobeerd.
RetryOperation	Implementeert de benodigde logica om bewerkingen opnieuw uit te voeren, zoals verbinding maken, C2D-berichten ontvangen, telemetrie verzenden, dubbele updates, enzovoort.
SharedAccessSignature	Shared Access Signature-tokens worden gebruikt om de verbinding te verifiëren bij het gebruik van symmetrische sleutels (in plaats van 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 op te geven voor de transporten die door de apparaatclient worden gebruikt om te verifiëren met een Azure IoT Hub-exemplaar.
Receiver
RetryPolicy	Interface die een beleidsobject voor opnieuw proberen beschrijft. Beleid voor opnieuw proberen bestaat uit twee dingen Een algoritme dat de volgende keer opnieuw probeert te proberen op basis van het huidige getal of nieuwe pogingen. Een foutfilter dat besluit, op basis van het type fout dat is ontvangen, of er een nieuwe poging moet plaatsvinden of niet. Deze twee onderdelen verbergen zich achter twee methode-aanroepen die in deze interface worden beschreven.
TransportConfig	Configuratiestructuur die wordt gebruikt door transporten en AuthenticationProvider objecten voor het opslaan en uitwisselen van referenties.
X509	Object dat wordt gebruikt voor het opslaan van een X509-certificaat en -sleutel voor transporten die moeten worden gebruikt. 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 een normale callback beschrijft met twee resultaten: de ene is de fout, de andere is de resultaatwaarde.
DoubleValueCallback	Hiermee definieert u het type callback met twee resultaten.
ErrorCallback	Definieert het type dat callback beschrijft met alleen foutresultaatwaarde.
HttpResponseCallback	Definieert het type dat callback beschrijft met drie resultaten: antwoord, onbewerkt HTTP-antwoord en een fout.
NoErrorCallback	Definieert het type dat callback beschrijft met één niet-foutresultaatwaarde.
TripleValueCallback	Definieert het type dat een normale callback beschrijft met drie resultaten: de eerste is Fout, de andere twee zijn de resultaatwaarden.

Enums

AuthenticationType

Het type verificatie aanwijzen dat wordt gebruikt door een AuthenticationProvider.

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