你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
azure-iot-common package
类
| Message |
对象Message用于遥测 (设备到云) 和命令， (云到设备) 设备和IoT 中心服务之间的异步消息传送。 它与传输无关，这意味着它在 AMQP、MQTT 和 HTTP 上的工作方式相同。 |
| ArgumentError |
参数无效时引发错误。 |
| ArgumentOutOfRangeError |
当参数的值在可接受的范围内时引发错误。 |
| BadDeviceResponseError |
当设备向设备方法调用发送错误响应时引发错误。 |
| CloudToDeviceDetachedError |
当 c2d 功能在传输级别停止工作，要求客户端重试启动它时引发错误。 |
| DeviceAlreadyExistsError |
当用于创建设备的设备 ID 已存在于设备标识注册表中时引发错误。 |
| DeviceMaximumQueueDepthExceededError |
当设备的消息队列已满时引发错误。 |
| DeviceMessageLockLostError |
解决消息失败时引发错误，因为与消息关联的锁定令牌丢失。 |
| DeviceMethodsDetachedError |
当设备方法功能在传输级别停止工作，要求客户端重试启动它时引发错误。 |
| DeviceNotFoundError |
在IoT 中心实例注册表中找不到设备时引发错误。 |
| DeviceRegistrationFailedError |
DPS 注册操作失败时引发错误 |
| DeviceTimeoutError |
当设备未及时处理方法调用时引发错误。 |
| FormatError |
当应该具有特定格式的字符串的格式不正确时引发错误。 |
| GatewayTimeoutError |
当IoT 中心实例未及时处理设备方法调用时引发错误。 |
| InternalServerError |
发生内部服务器错误时引发的错误。 你可能发现了一个 bug？ |
| InvalidEtagError |
当指定的 eTag 格式不正确或过期时引发错误。 |
| InvalidOperationError |
尝试操作但不允许时引发错误。 |
| IotHubNotFoundError |
找不到 Azure IoT 中心时引发错误。 |
| IotHubQuotaExceededError |
超出 Azure IoT 中心配额时引发错误。 配额会定期重置，此操作必须等到那时为止。 若要详细了解配额，请参阅Azure IoT 中心配额和限制 |
| IoTHubSuspendedError |
暂停IoT 中心时引发错误。 |
| JobNotFoundError |
找不到具有指定标识符的作业时引发错误。 |
| MessageTooLargeError |
发送的消息太大时引发错误：最大大小为 256Kb。 |
| NotConnectedError |
当设备断开连接且无法完成操作时引发错误。 |
| NotImplementedError |
当功能尚未实现但占位符存在时引发错误。 |
| OperationCancelledError |
取消本地或远程) 的任何操作 (引发错误 |
| PreconditionFailedError |
未满足执行操作而应满足的条件时引发错误。 |
| SecurityDeviceError |
低级别安全设备/驱动程序发生故障时引发错误。 |
| ServiceUnavailableError |
服务不可用时引发错误。 应重试该操作。 |
| ThrottlingError |
由于活动过多而限制IoT 中心时引发错误。 若要详细了解配额，请参阅Azure IoT 中心配额和限制 |
| TimeoutError |
发生超时时引发的错误 |
| TooManyDevicesError |
达到特定中心上的最大设备数时引发错误。 |
| TwinDetachedError |
当孪生功能在传输级别停止工作，要求客户端重试启动它时引发错误。 |
| TwinRequestError |
当孪生请求失败并出现未知错误代码时引发的一般错误。 |
| UnauthorizedError |
当连接参数错误且服务器拒绝连接时引发错误。 |
| Connected |
成功连接传输时返回的结果。 |
| Disconnected |
成功断开传输连接后返回的结果。 |
| MessageAbandoned |
成功放弃消息时返回的结果。 |
| MessageCompleted |
成功拒绝消息时返回的结果。 |
| MessageEnqueued |
成功将消息排入队列时返回的结果。 |
| MessageRejected |
成功拒绝消息时返回的结果。 |
| SharedAccessSignatureUpdated |
成功更新 SAS 令牌时返回的结果。 |
| TransportConfigured |
成功配置传输时返回的结果。 |
| ConnectionString |
介绍使设备或云应用程序能够连接到 Azure IoT 中心的参数。 |
| ExponentialBackOffWithJitter |
使用抖动重试策略实现指数退避。 计算下一个间隔的函数为以下 (x 为第 x 次重试) ：F (x) = min (Cmin+ (2^ (x-1) -1) * rand (C * (1 – Jd) ， C* (1-Ju) ) 、Cmax) |
| NoRetry |
阻止任何试探性重试的存根策略。 不会重试操作。 |
| RetryOperation |
实现重试操作所需的逻辑，例如连接、接收 C2D 消息、发送遥测数据、孪生更新等。 |
| SharedAccessSignature |
使用对称密钥 (而不是 x509 证书) 来保护与 Azure IoT 中心的连接时，共享访问签名令牌用于对连接进行身份验证。 |
接口
| AuthenticationProvider |
接口，该接口必须由对象实现，这些对象用于向设备客户端用于向 Azure IoT 中心实例进行身份验证的传输提供凭据。 |
| Receiver | |
| RetryPolicy |
描述重试策略对象的接口。 重试策略由 2 项组成
这 2 个组件隐藏在此接口中所述的 2 个方法调用后面。 |
| TransportConfig |
传输和 |
| X509 |
用于存储 X509 证书和密钥的对象，以供传输使用。 这会直接传递到Node.js用于连接 TLS 套接字的低级别对象。 https://nodejs.org/api/tls.html#tls_tls_connect_options_callback |
类型别名
| BufferConvertible | |
| ResultWithHttpResponse | |
| Callback |
定义描述具有两个结果的常规回调的类型 - 一个是 Error，另一个是结果值。 |
| DoubleValueCallback |
定义描述具有两个结果的回调的类型。 |
| ErrorCallback |
定义描述仅包含 Error 结果值的回调的类型。 |
| HttpResponseCallback |
定义描述具有三个结果的回调的类型 - 响应、原始 HTTP 响应和错误。 |
| NoErrorCallback |
定义使用一个非错误结果值描述回调的类型。 |
| TripleValueCallback |
定义描述具有三个结果的常规回调的类型 - 第一个结果为 Error，其他两个是结果值。 |
枚举
| AuthenticationType |
指定 使用的 |
函数
| an |
返回自 1970 年 1 月 1 日 00：00：00 UTC 到现在一小时以来经过的秒数。 |
| encode |
函数详细信息
anHourFromNow()
返回自 1970 年 1 月 1 日 00：00：00 UTC 到现在一小时以来经过的秒数。
function anHourFromNow(): number返回
number
encodeUriComponentStrict(string)
function encodeUriComponentStrict(str: string): string参数
- str
-
string
返回
string