azure-iot-common package

Classes

Message	L’objet Message est utilisé pour la télémétrie (appareil à cloud) et les commandes (cloud à appareil) asynchrones entre l’appareil et le service IoT Hub. Il est indépendant du transport, ce qui signifie qu’il fonctionne de la même façon sur AMQP, MQTT et HTTP.
ArgumentError	Erreur levée lorsqu’un argument n’est pas valide.
ArgumentOutOfRangeError	Erreur levée lorsqu’un argument a une valeur qui n’est pas dans la plage admissible.
BadDeviceResponseError	Erreur générée lorsqu’un appareil envoie une réponse incorrecte à un appel de méthode d’appareil.
CloudToDeviceDetachedError	Erreur générée lorsque la fonctionnalité c2d a cessé de fonctionner au niveau du transport, ce qui a obligé le client à réessayer de la démarrer.
DeviceAlreadyExistsError	Erreur levée lorsque l’ID d’appareil utilisé pour la création d’appareil existe déjà dans le Registre d’identités d’appareil.
DeviceMaximumQueueDepthExceededError	Erreur levée lorsque la file d’attente de messages d’un appareil est pleine.
DeviceMessageLockLostError	Erreur levée lors de l’échec du règlement d’un message, car le jeton de verrouillage associé au message est perdu.
DeviceMethodsDetachedError	Erreur générée lorsque la fonctionnalité de méthodes d’appareil a cessé de fonctionner au niveau du transport, ce qui oblige le client à réessayer de la démarrer.
DeviceNotFoundError	Erreur levée lorsqu’un appareil est introuvable dans le registre IoT Hub instance.
DeviceRegistrationFailedError	Erreur levée lors de l’échec d’une opération d’inscription DPS
DeviceTimeoutError	Erreur levée lorsque l’appareil ne traite pas l’appel de méthode dans le temps.
FormatError	Erreur levée lorsqu’une chaîne censée avoir une mise en forme spécifique n’est pas correctement mise en forme.
GatewayTimeoutError	Erreur levée lorsque le IoT Hub instance ne traite pas l’appel de méthode d’appareil à temps.
InternalServerError	Erreur levée lorsqu’une erreur de serveur interne s’est produite. Vous avez peut-être trouvé un bogue ?
InvalidEtagError	Erreur levée lorsque l’eTag spécifié est mal mis en forme ou obsolète.
InvalidOperationError	Erreur levée lorsqu’une opération est tentée, mais n’est pas autorisée.
IotHubNotFoundError	Erreur levée lorsque le hub Azure IoT est introuvable.
IotHubQuotaExceededError	Erreur levée du dépassement du quota du hub Azure IoT. Les quotas sont réinitialisés régulièrement. Cette opération devra attendre. Pour en savoir plus sur les quotas, consultez Azure IoT Hub quotas et limitation
IoTHubSuspendedError	Erreur levée lorsque IoT Hub a été suspendu.
JobNotFoundError	Erreur levée lorsque le travail avec l’identificateur spécifié est introuvable.
MessageTooLargeError	Erreur levée lorsque le message envoyé est trop volumineux : la taille maximale est de 256 Ko.
NotConnectedError	Erreur levée lorsque l’appareil est déconnecté et que l’opération ne peut pas être terminée.
NotImplementedError	Erreur levée lorsqu’une fonctionnalité n’est pas encore implémentée, mais que l’espace réservé est présent.
OperationCancelledError	Erreur levée lors de l’annulation d’une opération (locale ou distante)
PreconditionFailedError	Erreur levée lorsqu’une condition qui aurait dû être remplie pour exécuter une opération n’était pas.
SecurityDeviceError	Erreur générée lors de l’échec d’un périphérique/pilote de sécurité de bas niveau.
ServiceUnavailableError	Erreur levée lorsque le service n’est pas disponible. L’opération doit être retentée.
ThrottlingError	Erreur levée lorsque IoT Hub est limité en raison d’une activité excessive. Pour en savoir plus sur les quotas, consultez Azure IoT Hub quotas et limitation
TimeoutError	Erreur levée lorsqu’un délai d’expiration se produit
TooManyDevicesError	Erreur levée lorsque le nombre maximal d’appareils sur un hub spécifique a été atteint.
TwinDetachedError	Erreur générée lorsque la fonctionnalité de jumeau a cessé de fonctionner au niveau du transport, ce qui a obligé le client à réessayer de la démarrer.
TwinRequestError	Erreur générique levée lorsqu’une demande de jumeau échoue avec un code d’erreur inconnu.
UnauthorizedError	Erreur levée lorsque les paramètres de connexion sont incorrects et que le serveur a refusé la connexion.
Connected	Résultat retourné lorsqu’un transport est correctement connecté.
Disconnected	Résultat retourné lorsqu’un transport est correctement déconnecté.
MessageAbandoned	Résultat retourné lorsqu’un message a été abandonné.
MessageCompleted	Résultat retourné lorsqu’un message a été rejeté avec succès.
MessageEnqueued	Résultat retourné lorsqu’un message a été correctement mis en file d’attente.
MessageRejected	Résultat retourné lorsqu’un message a été rejeté avec succès.
SharedAccessSignatureUpdated	Résultat retourné lorsqu’un jeton SAP a été correctement mis à jour.
TransportConfigured	Résultat retourné lorsqu’un transport est correctement configuré.
ConnectionString	Décrit les paramètres qui permettent à un appareil ou à une application cloud de se connecter à un hub Azure IoT.
ExponentialBackOffWithJitter	Implémente une stratégie de retour exponentiel avec nouvelle tentative Jitter. La fonction permettant de calculer l’intervalle suivant est la suivante (x est la nouvelle tentative) : F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Stratégie stub qui bloque toute tentative de nouvelle tentative. Les opérations ne sont pas retentées.
RetryOperation	Implémente la logique nécessaire pour réessayer des opérations telles que la connexion, la réception de messages C2D, l’envoi de données de télémétrie, les mises à jour de jumeau, etc.
SharedAccessSignature	Les jetons de signature d’accès partagé sont utilisés pour authentifier la connexion lors de l’utilisation de clés symétriques (par opposition aux certificats x509) pour sécuriser la connexion avec Azure IoT Hub.

Interfaces

AuthenticationProvider	Interface qui doit être implémentée par des objets utilisés pour fournir des informations d’identification aux transports utilisés par le client d’appareil pour l’authentification auprès d’un instance Azure IoT Hub.
Receiver
RetryPolicy	Interface décrivant un objet de stratégie de nouvelle tentative. Les stratégies de nouvelle tentative sont composées de 2 éléments Algorithme qui calcule la prochaine tentative en fonction du nombre ou des nouvelles tentatives actuelles. Filtre d’erreurs qui détermine, en fonction du type d’erreur reçu, si une nouvelle tentative doit se produire ou non. Ces 2 composants se cachent derrière 2 appels de méthode décrits dans cette interface.
TransportConfig	Structure de configuration utilisée par les transports et AuthenticationProvider les objets pour stocker et échanger des informations d’identification.
X509	Objet utilisé pour stocker un certificat et une clé X509 pour les transports à utiliser. Cela est transmis directement aux objets de bas niveau utilisés par Node.js pour connecter le socket TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Alias de type

BufferConvertible
ResultWithHttpResponse
Callback	Définit le type décrivant le rappel normal avec deux résultats : l’un est l’erreur, l’autre est la valeur de résultat.
DoubleValueCallback	Définit le type décrivant le rappel avec deux résultats.
ErrorCallback	Définit le type décrivant le rappel avec uniquement la valeur de résultat d’erreur.
HttpResponseCallback	Définit le type décrivant un rappel avec trois résultats : réponse, réponse HTTP brute et erreur.
NoErrorCallback	Définit le type décrivant le rappel avec une valeur de résultat sans erreur.
TripleValueCallback	Définit le type décrivant le rappel normal avec trois résultats : le premier est Error, les deux autres sont les valeurs de résultat.

Énumérations

AuthenticationType

Désignez le type d’authentification utilisé par un AuthenticationProvider.

Fonctions

anHourFromNow()	Retourne les secondes écoulées depuis le 1er janvier 1970 00:00:00 UTC jusqu’à une heure à partir de maintenant.
encodeUriComponentStrict(string)

Informations relatives à la fonction

anHourFromNow()

Retourne les secondes écoulées depuis le 1er janvier 1970 00:00:00 UTC jusqu’à une heure à partir de maintenant.

function anHourFromNow(): number

Retours

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Paramètres

str

string

Retours

string