azure-iot-device package

Message 对象用于设备与 IoT 中心服务之间的遥测（设备到云）和命令（云到设备）异步消息传送。 它与传输无关，这意味着它的工作方式与 AMQP、MQTT 和 HTTP 的工作方式相同。

用于将设备连接到 Azure IoT 中心的 IoT 中心设备客户端。

SDK 的用户应调用工厂方法之一，FromConnectionString 或 fromSharedAccessSignature 来创建 IoT 中心设备客户端。

表示从云中调用设备方法时从服务传入到设备的数据。 此类的实例传递给通过 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)注册的回调。

向用户提供了一个 DeviceMethodResponse 对象，其中每个 DeviceMethodRequest 允许用户为每个设备方法调用构造和发送格式正确的响应。 此类的实例作为第二个参数传递给通过 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)注册的回调。

提供一个 AuthenticationProvider 实现，用于将令牌生成委托给 iotedged。 将模块客户端与 Azure IoT Edge 配合使用时，将使用此实现。

此类型继承自 SharedAccessKeyAuthenticationProvider，在功能上与该类型相同，但除了它通过实现 _sign 方法替代的令牌生成部分之外。

用于将设备连接到 Azure IoT 中心的 IoT 中心设备客户端。

SDK 的用户应调用工厂方法之一，FromConnectionString 或 fromSharedAccessSignature 来创建 IoT 中心设备客户端。

提供一个 AuthenticationProvider 对象，该对象只需使用连接字符串创建，然后由设备客户端和传输用于向 Azure IoT 中心实例进行身份验证。

SharedAccessKeyAuthenticationProvider 对象负责定期创建共享访问签名令牌，并发出传输 newTokenAvailable 事件，以使用 Azure IoT 中心实例续订其凭据并保持连接。

提供一个 AuthenticationProvider 对象，该对象只需使用共享访问签名创建，然后由设备客户端和传输用于向 Azure IoT 中心实例进行身份验证。

SharedAccessSignatureAuthenticationProvider 对象不会自动续订共享访问签名令牌，因此用户需要使用 updateSharedAccessSignature 方法将未过期的共享访问签名令牌馈送给它。 对于对此方法的每个调用，SharedAccessSignatureAuthenticationProvider 将发出一个 newTokenAvailable 事件，传输将用于向 Azure IoT 中心实例进行身份验证。

设备孪生是描述 Azure IoT 中心存储的设备的状态的文档，即使设备处于脱机状态，也可用。 它大约构建了 3 个部分：

• 标记：键/值对仅可从服务端访问
• 所需属性：由服务更新并由设备接收
• 报告的属性：由设备更新，并由服务接收。

请注意，尽管这是一种可能性，但所需属性和报告属性不必匹配，并且需要将这两个集合同步的逻辑留给 SDK 的用户。

有关详细信息，请参阅 了解设备孪生。

提供一个 AuthenticationProvider 对象，该对象只需使用 X509 证书和密钥创建，然后由设备客户端和传输用于向 Azure IoT 中心实例进行身份验证。

与 SharedAccessSignatureAuthenticationProvider 和 SharedAccessKeyAuthenticationProvider 对象不同，X509AuthenticationProvider 不会发出 newTokenAvailable 事件，因为 X509 身份验证中没有涉及令牌。 传输将使用 getDeviceCredentials 方法获取凭据。

特定于 AMQP 传输的选项。

这会作为 DeviceClientOptions 对象内命名http的属性传递到 setOptions 中。

请参阅

Client 对象的选项。 传递给 setOptions 函数。

示例

 var options = {
   cert: myX509Certificate,
   key: myX509Key,
   http: {
     receivePolicy: {
       interval: 10
     }
   }
 }
 client.setOptions(options, callback);

用于配置 HTTP 接收器轮询消息的频率的选项结构。 除 drain 布尔值外，上述每个选项都是互斥的。 选项结构中只有一个 interval、at、cron 或 manualPolling。

这是通过调用 setOptions，将其作为 receivePolicy 对象（位于 DeviceClientOptions 对象内部）中名为 的属性来配置此配置。

请参阅

用于将可选配置参数传递到 Http 传输的选项结构。

这会作为 DeviceClientOptions 对象内命名http的属性传递到 setOptions 中。

请参阅

特定于 MQTT 传输的选项

这会作为 DeviceClientOptions 对象内命名mqtt的属性传递到 setOptions 中。

包含孪生的所需属性和报告属性。