azure-iot-common package

Классы

Message	Объект Message используется для асинхронного обмена сообщениями между устройством и службой Центр Интернета вещей телеметрии (с устройства в облако) и команд (из облака в устройство). Он не зависит от транспорта, то есть работает одинаково по amQP, MQTT и HTTP.
ArgumentError	Ошибка, возникаемая при недопустимом аргументе.
ArgumentOutOfRangeError	Ошибка возникает, когда аргумент имеет значение, которое выходит за пределы допустимого диапазона.
BadDeviceResponseError	Ошибка, возникает, когда устройство отправляет неверный ответ на вызов метода устройства.
CloudToDeviceDetachedError	Ошибка, возникающая, когда функция c2d перестала работать на уровне транспорта, что требует от клиента повторного запуска.
DeviceAlreadyExistsError	Ошибка возникает, если идентификатор устройства, используемый для создания устройства, уже существует в реестре удостоверений устройств.
DeviceMaximumQueueDepthExceededError	Ошибка, возникаемая при заполнении очереди сообщений для устройства.
DeviceMessageLockLostError	Ошибка, возникаемая при сбое разрешения сообщения из-за потери маркера блокировки, связанного с сообщением.
DeviceMethodsDetachedError	Ошибка, возникающая, когда функция методов устройства перестала работать на уровне транспорта, что требует от клиента повторного запуска.
DeviceNotFoundError	Ошибка возникает, когда устройство не удается найти в реестре экземпляров Центр Интернета вещей.
DeviceRegistrationFailedError	Ошибка, возникаемая при сбое операции регистрации DPS
DeviceTimeoutError	Ошибка возникает, когда устройство не обрабатывает вызов метода вовремя.
FormatError	Ошибка возникает при неправильном форматировании строки, которая должна иметь определенное форматирование.
GatewayTimeoutError	Ошибка возникает, когда экземпляр Центр Интернета вещей не обрабатывает вызов метода устройства вовремя.
InternalServerError	Ошибка, возникает при возникновении внутренней ошибки сервера. Возможно, вы нашли ошибку?
InvalidEtagError	Ошибка возникает, если указанный eTag неправильно отформатирован или устарел.
InvalidOperationError	Ошибка, возникаемая при попытке выполнения операции, но она не разрешена.
IotHubNotFoundError	Ошибка, возникаемая, когда центр Интернета вещей Azure не найден.
IotHubQuotaExceededError	Ошибка, которая возникла при превышении квоты Центра Интернета вещей Azure. Квоты периодически сбрасываются, эта операция придется подождать до тех пор. Дополнительные сведения о квотах см. в статье Центр Интернета вещей Azure квоты и регулирование.
IoTHubSuspendedError	Ошибка, возникаемая при приостановке Центр Интернета вещей.
JobNotFoundError	Ошибка возникает, когда задание с указанным идентификатором не найдено.
MessageTooLargeError	Ошибка, возникаемая при слишком большом размере отправленного сообщения: максимальный размер — 256 КБ.
NotConnectedError	Ошибка, возникаемая при отключении устройства и невозможности завершить операцию.
NotImplementedError	Ошибка возникает, если функция еще не реализована, но заполнитель присутствует.
OperationCancelledError	Ошибка, возникаемая при отмене любой операции (локальной или удаленной)
PreconditionFailedError	Ошибка возникает, когда условие, которое должно было быть выполнено для выполнения операции, не было.
SecurityDeviceError	Ошибка, возникаемая при сбое устройства или драйвера с низким уровнем безопасности.
ServiceUnavailableError	Ошибка, возникаемая при недоступности службы. Операция должна быть выполнена повторно.
ThrottlingError	Ошибка, возникаемая при регулировании Центр Интернета вещей из-за чрезмерной активности. Дополнительные сведения о квотах см. в статье Центр Интернета вещей Azure квоты и регулирование.
TimeoutError	Ошибка, возникаемая при истечении времени ожидания
TooManyDevicesError	Ошибка, возникаемая при достижении максимального количества устройств в определенном концентраторе.
TwinDetachedError	Ошибка, возникающая, когда функция двойника перестала работать на уровне транспорта, требуя от клиента повторного запуска.
TwinRequestError	Общая ошибка, возникаемая при сбое запроса двойника с неизвестным кодом ошибки.
UnauthorizedError	Ошибка возникает, если параметры подключения неверны и сервер отказал в подключении.
Connected	Результат возвращается при успешном подключении транспорта.
Disconnected	Результат возвращается при успешном отключении транспорта.
MessageAbandoned	Результат возвращается, когда сообщение было успешно прервано.
MessageCompleted	Результат возвращается при успешном отклонении сообщения.
MessageEnqueued	Результат возвращается при успешном постановке сообщения в очередь.
MessageRejected	Результат возвращается при успешном отклонении сообщения.
SharedAccessSignatureUpdated	Результат возвращается при успешном обновлении маркера SAS.
TransportConfigured	Результат возвращается при успешной настройке транспорта.
ConnectionString	Описание параметров, позволяющих устройству или облачному приложению подключаться к Центру Интернета вещей Azure.
ExponentialBackOffWithJitter	Реализует стратегию экспоненциального отката с использованием стратегии повторных попыток jitter. Функция для вычисления следующего интервала следующая (x — повторная попытка x): F(x) = min(Cmin+ (2^(x-1)-1) * rand(C * (1 – Jd), C*(1-Ju)), Cmax)
NoRetry	Политика заглушки, которая блокирует любые предварительные попытки. Повторные операции не выполняются.
RetryOperation	Реализует необходимую логику для повторных операций, таких как подключение, получение сообщений C2D, отправка данных телеметрии, обновления двойников и т. д.
SharedAccessSignature	Маркеры подписанного URL-адреса используются для проверки подлинности подключения при использовании симметричного ключа (в отличие от сертификатов x509) для защиты подключения к Центру Интернета вещей Azure.

Интерфейсы

AuthenticationProvider	Интерфейс, который должен быть реализован объектами, которые используются для предоставления учетных данных транспортам, используемым клиентом устройства для проверки подлинности в экземпляре Центра Интернета вещей Azure.
Receiver
RetryPolicy	Интерфейс, описывающий объект политики повтора. Политики повторных попыток состоят из 2 вещей Алгоритм, который вычисляет в следующий раз повторную попытку на основе текущего числа или повторных попыток. Фильтр ошибок, который в зависимости от типа полученной ошибки определяет, следует ли повторить попытку. Эти 2 компонента скрываются за 2 вызовами методов, описанными в этом интерфейсе.
TransportConfig	Структура конфигурации, используемая транспортами и AuthenticationProvider объектами для хранения учетных данных и обмена ими.
X509	Объект, используемый для хранения сертификата X509 и ключа для транспорта. Он передается непосредственно в низкоуровневые объекты, используемые Node.js для подключения сокета TLS. https://nodejs.org/api/tls.html#tls_tls_connect_options_callback

Псевдонимы типа

BufferConvertible
ResultWithHttpResponse
Callback	Определяет тип, описывающий обычный обратный вызов с двумя результатами: один — ошибка, другой — значение результата.
DoubleValueCallback	Определяет тип, описывающий обратный вызов с двумя результатами.
ErrorCallback	Определяет тип, описывающий обратный вызов только со значением результата Error.
HttpResponseCallback	Определяет тип, описывающий обратный вызов с тремя результатами: ответ, необработанный HTTP-ответ и ошибка.
NoErrorCallback	Определяет тип, описывающий обратный вызов с одним значением результата без ошибок.
TripleValueCallback	Определяет тип, описывающий обычный обратный вызов с тремя результатами: первый — Error, два других — результирующий.

Перечисления

AuthenticationType

Укажите тип проверки подлинности, используемый .AuthenticationProvider

Функции

anHourFromNow()	Возвращает секунды, прошедшие с 1 января 1970 г. с 00:00:00 (UTC) до одного часа.
encodeUriComponentStrict(string)

Сведения о функции

anHourFromNow()

Возвращает секунды, прошедшие с 1 января 1970 г. с 00:00:00 (UTC) до одного часа.

function anHourFromNow(): number

Возвращаемое значение

number

encodeUriComponentStrict(string)

function encodeUriComponentStrict(str: string): string

Параметры

str

string

Возвращаемое значение

string