azure-iot-common package

Clases

Message	El Message objeto se usa para la mensajería asincrónica de telemetría (dispositivo a nube) y comandos (nube a dispositivo) entre el dispositivo y el servicio IoT Hub. Es independiente del transporte, lo que significa que funciona de la misma manera a través de AMQP, MQTT y HTTP.
ArgumentError	Error producido cuando un argumento no es válido.
ArgumentOutOfRangeError	Error producido cuando un argumento tiene un valor que está fuera del intervalo admisible.
BadDeviceResponseError	Error producido cuando un dispositivo envía una respuesta incorrecta a una llamada de método de dispositivo.
CloudToDeviceDetachedError	Error producido cuando la característica c2d dejó de funcionar en el nivel de transporte, lo que requiere que el cliente vuelva a intentar iniciarlo.
DeviceAlreadyExistsError	Error producido cuando el identificador de dispositivo usado para la creación de dispositivos ya existe en el Registro de identidades de dispositivo.
DeviceMaximumQueueDepthExceededError	Error producido cuando la cola de mensajes de un dispositivo está llena.
DeviceMessageLockLostError	Se produce un error al resolver un mensaje porque se pierde el token de bloqueo asociado al mensaje.
DeviceMethodsDetachedError	Error producido cuando la característica de métodos de dispositivo dejó de funcionar en el nivel de transporte, lo que requiere que el cliente vuelva a intentar iniciarlo.
DeviceNotFoundError	Error producido cuando no se encuentra un dispositivo en el registro de instancia de IoT Hub.
DeviceRegistrationFailedError	Error producido cuando se produce un error en una operación de registro de DPS
DeviceTimeoutError	Error producido cuando el dispositivo no procesa la llamada al método en el tiempo.
FormatError	Error producido cuando una cadena que se supone que tiene un formato específico no tiene el formato correcto.
GatewayTimeoutError	Error producido cuando la instancia de IoT Hub no procesa la llamada al método del dispositivo a tiempo.
InternalServerError	Error producido cuando se produjo un error interno del servidor. ¿Es posible que haya encontrado un error?
InvalidEtagError	Error producido cuando el valor de eTag especificado tiene un formato incorrecto o no está actualizado.
InvalidOperationError	Error producido cuando se intenta realizar una operación, pero no se permite.
IotHubNotFoundError	Error producido cuando no se encontró el centro de IoT de Azure.
IotHubQuotaExceededError	Se ha superado la cuota del centro de IoT de Azure. Las cuotas se restablecen periódicamente, esta operación tendrá que esperar hasta entonces. Para más información sobre las cuotas, consulte Azure IoT Hub cuotas y limitación.
IoTHubSuspendedError	Error que se produce cuando se ha suspendido IoT Hub.
JobNotFoundError	Error producido cuando no se encontró el trabajo con el identificador especificado.
MessageTooLargeError	Error que se produce cuando el mensaje enviado es demasiado grande: el tamaño máximo es de 256 Kb.
NotConnectedError	Error producido cuando el dispositivo está desconectado y no se puede completar la operación.
NotImplementedError	Error que se produce cuando aún no se implementa una característica, pero el marcador de posición está presente.
OperationCancelledError	Error producido cuando se cancela cualquier operación (local o remota)
PreconditionFailedError	Error producido cuando no se ha cumplido una condición que debe haberse cumplido para ejecutar una operación.
SecurityDeviceError	Error producido cuando se produce un error en un controlador o dispositivo de seguridad de bajo nivel.
ServiceUnavailableError	Error producido cuando el servicio no está disponible. Se debe reintentar la operación.
ThrottlingError	Error que se produce cuando se limita IoT Hub debido a una actividad excesiva. Para más información sobre las cuotas, consulte Azure IoT Hub cuotas y limitación.
TimeoutError	Error producido cuando se produce un tiempo de espera
TooManyDevicesError	Error producido cuando se ha alcanzado el número máximo de dispositivos en un centro específico.
TwinDetachedError	Error producido cuando la característica gemela dejó de funcionar en el nivel de transporte, lo que requiere que el cliente vuelva a intentar iniciarla.
TwinRequestError	Error genérico que se produce cuando se produce un error en una solicitud gemela con un código de error desconocido.
UnauthorizedError	Error producido cuando los parámetros de conexión son incorrectos y el servidor rechazó la conexión.
Connected	Resultado devuelto cuando un transporte se conecta correctamente.
Disconnected	Resultado devuelto cuando un transporte se desconecta correctamente.
MessageAbandoned	Resultado devuelto cuando un mensaje se abandonó correctamente.
MessageCompleted	Resultado devuelto cuando se rechazó correctamente un mensaje.
MessageEnqueued	Resultado devuelto cuando un mensaje se puso en cola correctamente.
MessageRejected	Resultado devuelto cuando se rechazó correctamente un mensaje.
SharedAccessSignatureUpdated	Resultado devuelto cuando un token de SAS se ha actualizado correctamente.
TransportConfigured	Resultado devuelto cuando un transporte se configura correctamente.
ConnectionString	Describe los parámetros que permiten que un dispositivo o una aplicación en la nube se conecten a un centro de IoT de Azure.
ExponentialBackOffWithJitter	Implementa un retroceso exponencial con la estrategia de reintento jitter. La función para calcular el siguiente intervalo es la siguiente (x es el ésimo reintento): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Directiva de código auxiliar que bloquea cualquier reintento provisional. Las operaciones no se reintentan.
RetryOperation	Implementa la lógica necesaria para reintentar operaciones como conectarse, recibir mensajes C2D, enviar telemetría, actualizaciones gemelas, etc.
SharedAccessSignature	Los tokens de firma de acceso compartido se usan para autenticar la conexión cuando se usan claves simétricas (en lugar de certificados x509) para proteger la conexión con Azure IoT Hub.

Interfaces

AuthenticationProvider	Interfaz que deben implementar los objetos que se usan para proporcionar credenciales a los transportes usados por el cliente del dispositivo para autenticarse con una instancia de Azure IoT Hub.
Receiver
RetryPolicy	Interfaz que describe un objeto de directiva de reintento. Las directivas de reintento se componen de 2 cosas Algoritmo que calcula la próxima vez que se vuelva a intentar en función del número o reintentos actuales. Filtro de error que decide, en función del tipo de error recibido, si se debe producir o no un reintento. Esos 2 componentes se ocultan detrás de 2 llamadas de método descritas en esta interfaz.
TransportConfig	Estructura de configuración usada por transportes y AuthenticationProvider objetos para almacenar e intercambiar credenciales.
X509	Objeto utilizado para almacenar un certificado X509 y una clave para los transportes que se van a usar. Esto se pasa directamente a los objetos de bajo nivel que usa Node.js para conectar el socket TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Alias de tipos

BufferConvertible
ResultWithHttpResponse
Callback	Define el tipo que describe la devolución de llamada normal con dos resultados: uno es error, el otro es el valor de resultado.
DoubleValueCallback	Define el tipo que describe la devolución de llamada con dos resultados.
ErrorCallback	Define el tipo que describe la devolución de llamada con solo el valor de resultado error.
HttpResponseCallback	Define el tipo que describe la devolución de llamada con tres resultados: respuesta, respuesta HTTP sin formato y error.
NoErrorCallback	Define el tipo que describe la devolución de llamada con un valor de resultado que no es de error.
TripleValueCallback	Define el tipo que describe la devolución de llamada normal con tres resultados: el primero es Error, los otros dos son los valores de resultado.

Enumeraciones

AuthenticationType

Designe el tipo de autenticación usado por un AuthenticationProviderobjeto .

Funciones

anHourFromNow()	Devuelve los segundos transcurridos desde el 1 de enero de 1970 00:00:00 UTC hasta una hora desde ahora.
encodeUriComponentStrict(string)

Detalles de la función

anHourFromNow()

Devuelve los segundos transcurridos desde el 1 de enero de 1970 00:00:00 UTC hasta una hora desde ahora.

function anHourFromNow(): number

Devoluciones

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Parámetros

str

string

Devoluciones

string