你当前正在访问 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 |
定义描述只包含错误结果值的回调的类型。 |
| HttpResponseCallback |
定义使用三个结果描述回调的类型 - 响应、原始 HTTP 响应和错误。 |
| NoErrorCallback |
定义描述具有一个非错误结果值的回调的类型。 |
| TripleValueCallback |
定义描述具有三个结果的常规回调的类型 - 第一个是 Error，另一个是结果值。 |
枚举
| AuthenticationType |
指定 |
函数
| an |
返回自 1970 年 1 月 1 日 00：00：00 UTC 到 1 小时之后的秒数。 |
| encode |
函数详细信息
anHourFromNow()
返回自 1970 年 1 月 1 日 00：00：00 UTC 到 1 小时之后的秒数。
function anHourFromNow(): number返回
number
encodeUriComponentStrict(string)
function encodeUriComponentStrict(str: string): string参数
- str
-
string
返回
string