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

azure-iothub package

Client

IoT 中心服务客户端用于通过 Azure IoT 中心与设备通信。 它允许 SDK 用户:

  • 将云到设备 (也称为命令) 发送到设备:命令在IoT 中心排队,仅在设备连接时以异步方式传递。 每个设备只能排队 50 个命令。
  • 在设备上调用直接方法 (,仅当设备当前已连接时才有效:这是与设备通信的同步方式)
  • 侦听设备针对先前命令发送的反馈消息。
  • 侦听来自设备的文件上传通知。

用户应通过调用工厂方法之一(从ConnectionStringfromSharedAccessSignatureClient创建新实例,以创建IoT 中心服务客户端。

Device

创建要与 设备标识注册表 API 一起使用的设备表示形式。

此类已弃用 ,因为 设备标识注册表 可以直接使用包含设备部分说明(不一定是完整对象)的 JSON 对象。 除此之外,此类最初在属性名称上 symmetricKey 附带了拼写错误, (它采用 pascal 大小写,而不是骆驼) 。 SDK 保留此类是为了不中断现有代码,但在将来的主要版本更新中会删除此类,客户应改用纯 JSON 对象。

JobClient

提供在 IoT 中心 实例上创建、更新、监视和取消长时间运行的作业以及查询现有作业的方法。 Azure IoT 中心 中的作业 API 允许在多个设备上计划直接方法调用和孪生更新。

SDK 用户应使用工厂方法和 fromConnectionString(string)fromSharedAccessSignature(string)创建JobClient实例。

Registry

Registry 类提供对IoT 中心设备标识服务的访问权限。 SDK 的用户应使用工厂方法之一实例化此类: fromConnectionStringfromSharedAccessSignature

用于设备标识注册表操作的协议是 HTTPS。

Amqp

服务客户端使用传输类通过安全 (TLS) 套接字使用 AMQP 协议连接到 Azure IoT 中心。 此类不应直接使用,而应传递给工厂方法之 Client 一: fromConnectionStringfromSharedAccessSignature

AmqpWs

服务客户端用于通过安全 Websocket 使用 AMQP 协议连接到 Azure IoT 中心的传输类。 此类不应直接使用,而应传递给工厂方法之 Client 一: fromConnectionStringfromSharedAccessSignature

DigitalTwinClient
IoTHubTokenCredentials

基于传递给构造函数的连接字符串创建共享访问签名。 SDK 的协议层使用此类向每个请求添加身份验证标头。

Twin

设备孪生是描述由 Azure IoT 中心存储的设备的状态的文档,即使设备脱机也可用。 它围绕 3 个部分构建:

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

请注意,尽管这有可能,但所需的属性和报告的属性不必匹配,并且同步这两个集合的逻辑(如有必要)留给 SDK 的用户。

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

为特定设备获取 Twin 的建议方法是使用 getTwin(string, HttpResponseCallback<Twin>) 方法。

接口

ServiceReceiver
Transport
TransportConfigOptions
Authentication
Capabilities
X509Thumbprints
BulkRegistryOperationResult
DeviceDescription
DeviceRegistryOperationError
JobStatus
QueryDescription
RegistryStatistics
TransportConfig
Configuration

Configuration 对象表示单个设备的配置,也可以表示部署,该部署可以作为配置应用于基于 targetCondition 的设备。

ConfigurationContent
ConfigurationMetrics
DeviceMethodParams

介绍可用于直接方法的参数 (也称为设备方法)

Module

类型别名

TransportCtor
ConnectionState
DeviceStatus
JobCallback
BulkRegistryOperationType
JobCallback
ResponseCallback