你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

azure-iot-device package

类

Message	对象Message用于遥测 (设备到云) 和命令 (云到设备) 设备和IoT 中心服务之间的异步消息传送。 它与传输无关，这意味着它在 AMQP、MQTT 和 HTTP 上的工作方式相同。
Client	IoT 中心设备客户端，用于将设备与 Azure IoT 中心连接。 SDK 的用户应调用工厂方法之一，从ConnectionString 或 fromSharedAccessSignature 来创建IoT 中心设备客户端。
DeviceMethodRequest	表示从云调用设备方法时从服务传递到设备的数据。 此类的实例传递到通过 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)注册的回调。
DeviceMethodResponse	向用户提供 一个 DeviceMethodResponse 对象，其中每个 DeviceMethodRequest 对象允许用户为每个设备方法调用构造格式正确的响应并将其发送回服务。 此类的实例作为第二个参数传递给通过 onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)注册的回调。
IotEdgeAuthenticationProvider	提供将 AuthenticationProvider 令牌生成委托给 iotedged 的实现。 将模块客户端与 Azure IoT Edge配合使用时，应使用此实现。 此类型继承自 SharedAccessKeyAuthenticationProvider ，在功能上与该类型相同，但它通过实现 _sign 方法替代的令牌生成部分除外。
ModuleClient	IoT 中心设备客户端，用于将设备与 Azure IoT 中心连接。 SDK 的用户应调用工厂方法之一，从ConnectionString 或 fromSharedAccessSignature 来创建IoT 中心设备客户端。
SharedAccessKeyAuthenticationProvider	提供一个 AuthenticationProvider 对象，该对象只需使用连接字符串创建，然后由设备客户端和传输方使用，以便通过 Azure IoT 中心实例进行身份验证。 对象 SharedAccessKeyAuthenticationProvider 负责按常规节奏创建共享访问签名令牌，并发出 newTokenAvailable 事件供传输使用 Azure IoT 中心实例续订其凭据并保持连接状态。
SharedAccessSignatureAuthenticationProvider	提供一个 AuthenticationProvider 对象，该对象只需使用共享访问签名创建，然后由设备客户端和传输方用来对 Azure IoT 中心实例进行身份验证。 对象 SharedAccessSignatureAuthenticationProvider 不会自动续订共享访问签名令牌，因此用户需要使用 方法将未过期的共享访问签名令牌馈送给它 updateSharedAccessSignature 。 每次调用此方法时 SharedAccessSignatureAuthenticationProvider ，都会发出一个 newTokenAvailable 事件，传输将使用该事件向 Azure IoT 中心实例进行身份验证。
Twin	设备孪生是描述由 Azure IoT 中心存储的设备的状态的文档，即使设备脱机也可用。 它围绕 3 个部分构建： 标记：键/值对只能从服务端访问 所需属性：由服务更新并由设备接收 报告的属性：由设备更新并由服务接收。 请注意，尽管这有可能，但所需的属性和报告的属性不必匹配，并且同步这两个集合的逻辑（如有必要）留给 SDK 的用户。 有关详细信息，请参阅 了解设备孪生。
X509AuthenticationProvider	提供一个 AuthenticationProvider 对象，该对象只需使用 X509 证书和密钥即可创建，然后由设备客户端和传输来使用 Azure IoT 中心实例进行身份验证。 SharedAccessSignatureAuthenticationProvider与 和 SharedAccessKeyAuthenticationProvider 对象不同， X509AuthenticationProvider 不会发出事件，newTokenAvailable因为 X509 身份验证中没有涉及令牌。 传输将使用 方法获取凭据 getDeviceCredentials 。

接口

AmqpTransportOptions	特定于 AMQP 传输的选项。 这作为 DeviceClientOptions 对象内部的名为 http 的属性传递到 setOptions 中。 请参阅
DeviceClientOptions	Client 对象的选项。 传入 setOptions 函数。 示例 var options = { cert: myX509Certificate, key: myX509Key, http: { receivePolicy: { interval: 10 } } } client.setOptions(options, callback);
DeviceTransport
HttpReceiverOptions	用于配置 HTTP 接收器轮询消息的频率的选项结构。 每个选项都是互斥的，布尔值除外 drain 。 选项结构中应只存在一个 interval、 atcron 或 manualPolling 。 这是通过调用 setOptions 来配置的，其作为位于 DeviceClientOptions 对象内的 HttpTransportOptions 对象内部的名为 receivePolicy 的属性。 请参阅
HttpTransportOptions	用于将可选配置参数传递到 Http 传输的选项结构。 这作为 DeviceClientOptions 对象内部的名为 http 的属性传递到 setOptions 中。 请参阅
MqttTransportOptions	特定于 MQTT 传输的选项 这作为 DeviceClientOptions 对象内部的名为 mqtt 的属性传递到 setOptions 中。
TwinProperties	包含孪生体所需的属性和报告属性。

类型别名

BufferConvertible

函数

getUserAgentString(NoErrorCallback<string>)
getUserAgentString()
getUserAgentString(string, NoErrorCallback<string>)
getUserAgentString(string)

函数详细信息

getUserAgentString(NoErrorCallback<string>)

function getUserAgentString(done: NoErrorCallback<string>)

参数

done

NoErrorCallback<string>

getUserAgentString()

function getUserAgentString(): Promise<string>

返回

Promise<string>

getUserAgentString(string, NoErrorCallback<string>)

function getUserAgentString(productInfo: string, done: NoErrorCallback<string>)

参数

productInfo

string

done

NoErrorCallback<string>

getUserAgentString(string)

function getUserAgentString(productInfo: string): Promise<string>

参数

productInfo

string

返回

Promise<string>