你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Azure.Devices.Client 命名空间
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
类
| AmqpConnectionPoolSettings |
包含设备客户端的 AMQP 连接池设置。 |
| AmqpTransportSettings |
包含设备和模块客户端的特定于 Amqp 传输的设置。 |
| AuthenticationMethodFactory |
基于已知的身份验证参数创建 的 IAuthenticationMethod 实现实例。 |
| AuthenticationWithTokenRefresh |
使用共享访问签名令牌并允许令牌刷新的身份验证方法。 |
| ClientAuthenticationWithSharedAccessKeyRefresh |
基于 SAK) 提供的共享访问密钥，通过刷新 (SAS () 令牌生成共享访问签名的身份验证方法。 |
| ClientAuthenticationWithSharedAccessSignature |
使用共享访问签名令牌的身份验证方法。 |
| ClientAuthenticationWithTokenRefresh |
使用共享访问签名令牌并允许令牌刷新的身份验证方法。 |
| ClientAuthenticationWithX509Certificate |
使用 X.509 证书的身份验证方法 |
| ClientOptions |
允许在初始化期间配置设备或模块客户端实例的选项。 |
| ConnectionStatusInfo |
自上次状态更改以来的连接状态信息。 |
| DefaultPayloadConvention |
类的默认实现 PayloadConvention 。 |
| DesiredProperties |
从服务接收的所需属性更新请求的集合。 |
| DeviceAuthenticationWithRegistrySymmetricKey |
使用与设备注册表中的设备关联的对称密钥的身份验证方法。 |
| DeviceAuthenticationWithSharedAccessPolicyKey |
使用共享访问策略密钥的身份验证方法。 |
| DeviceAuthenticationWithToken |
使用共享访问签名令牌的身份验证方法。 |
| DeviceAuthenticationWithTokenRefresh |
使用共享访问签名令牌并允许令牌刷新的身份验证方法。 |
| DeviceAuthenticationWithTpm |
使用共享访问签名令牌并允许令牌刷新的身份验证方法。 |
| DeviceAuthenticationWithX509Certificate |
使用 X.509 证书的身份验证方法 |
| DeviceClient |
包含设备可用于向服务发送消息和从服务接收消息的方法。 |
| DirectMethodRequest |
用于在设备或模块上执行直接方法的参数。 |
| DirectMethodResponse |
设备/模块对直接方法调用的响应。 |
| ExponentialBackoff |
表示执行指定次数的重试的重试策略，该策略使用随机化的指数退让方案来确定重试间隔。 |
| FileUploadCompletionNotification |
要发送到 IoT 中心的请求有效负载，以便在文件上传完成时通知它，无论是否成功。 |
| FileUploadSasUriRequest |
从 IoT 中心获取文件上传 SAS URI 时的请求参数。 |
| FileUploadSasUriResponse |
IoT 中心提供的信息，可与 Azure 存储 SDK 一起使用，以便从此客户端应用程序上传文件。 |
| Http1TransportSettings |
包含设备和模块客户端的特定于 HTTP 传输的设置。 |
| IncomingMessage |
表示从 Iot 中心接收的消息的数据结构。 |
| IotHubBaseClient |
包含客户端可用于向服务发送消息和从服务接收消息、响应来自服务的直接方法调用以及发送和接收孪生体属性更新的方法。 |
| IotHubClientAmqpSettings |
包含设备和模块客户端的特定于 AMQP 传输的设置。 |
| IotHubClientException |
在 DeviceClient 或 ModuleClient 操作期间发生错误时引发的异常。 |
| IotHubClientExponentialBackoffRetryPolicy |
表示一个重试策略，该策略使用指数退避方案（带有选项抖动）执行指定次数的重试，以确定重试之间的间隔。 |
| IotHubClientFixedDelayRetryPolicy |
表示一个重试策略，该策略使用固定的重试延迟和抖动来执行指定次数的重试。 |
| IotHubClientHttpSettings |
包含设备和模块客户端的特定于 HTTP 传输的设置。 |
| IotHubClientIncrementalDelayRetryPolicy |
表示一个重试策略，该策略使用增量增加的重试延迟和抖动来执行指定次数的重试。 |
| IotHubClientMqttSettings |
包含设备和模块客户端的特定于 MQTT 传输的设置。 |
| IotHubClientNoRetry |
表示不执行重试的重试策略。 |
| IotHubClientOptions |
允许在初始化期间配置 IoT 中心设备或模块客户端实例的选项。 |
| IotHubClientRetryPolicyBase |
基本重试策略。 |
| IotHubClientTransportSettings |
用于为 IoT 中心设备和模块客户端定义各种特定于传输的设置的基类。 |
| IotHubConnectionCredentials |
客户端凭据的持有者，用于通过 IoT 中心服务对客户端进行身份验证。 |
| IotHubConnectionStringBuilder |
基于用户填充的属性为 IoT 中心服务生成连接字符串。 |
| IotHubDeviceClient |
包含设备可用于向服务发送消息和从服务接收消息的方法。 |
| IotHubModuleClient |
包含模块可用于向服务发送消息和从服务接收消息并与模块孪生交互的方法。 |
| Message |
数据结构表示用于与 IotHub 交互的消息。 |
| MethodRequest |
表示方法请求的数据结构。 |
| MethodRequestInternal |
数据结构表示来自 IoT 中心的方法请求。 |
| MethodResponse |
数据结构表示用于触发设备上的活动的设备孪生方法。 |
| MethodResponseInternal |
数据结构表示用于与 IoT 中心交互的方法响应。 |
| ModuleAuthenticationWithRegistrySymmetricKey |
使用与设备注册表中的模块关联的对称密钥的身份验证方法。 |
| ModuleAuthenticationWithToken |
使用共享访问签名令牌的身份验证方法。 |
| ModuleAuthenticationWithTokenRefresh |
使用共享访问签名令牌并允许令牌刷新的身份验证方法。 |
| ModuleClient |
包含模块可用于向服务发送消息和从服务接收消息并与模块孪生交互的方法。 |
| NewtonsoftJsonPayloadSerializer |
Newtonsoft.Json.JsonConvert PayloadSerializer 实现。 |
| NoRetry |
表示不执行重试的重试策略。 |
| PayloadConvention |
有效负载约定类。 它用于定义特定的序列化程序和特定内容编码。 |
| PayloadEncoder |
指定有效负载的字节编码。 |
| PayloadSerializer |
提供指定约定的序列化。 |
| PropertyCollection |
孪生体属性的集合。 |
| ReadOnlyDictionary45<TKey,TValue>.KeyCollection |
字典键的集合 |
| ReadOnlyDictionary45<TKey,TValue>.ValueCollection |
字典值的集合 |
| ReadOnlyDictionary45<TKey,TValue> |
另一个泛型字典的只读包装器。 |
| ReportedProperties |
客户端报告的孪生属性的集合。 |
| Resources | |
| SharedAccessSignatureBuilder |
生成共享访问签名 (SAS) 令牌。 |
| StringFormattingExtensions |
常见操作的字符串扩展类。 此类由 SDK 使用，不应由应用程序直接使用。 |
| SystemTextJsonPayloadConvention | |
| SystemTextJsonPayloadSerializer | |
| TelemetryMessage |
表示将发送到 IoT 中心的消息的数据结构。 |
| TwinProperties |
从服务检索到的客户端属性的容器。 |
| Utf8PayloadEncoder |
UTF-8 PayloadEncoder 实现。 |
| WillMessage |
在客户端断开连接之前，此客户端要发送的 MQTT“将”消息。 |
接口
| IAuthenticationMethod |
用于设备通信的身份验证接口。 |
| IETagHolder | |
| IIotHubClientRetryPolicy |
表示中心设备/模块客户端的重试策略。 |
| IReadOnlyIndicator |
指示类是否为只读 |
| IRetryPolicy |
表示重试策略 |
| ITransportSettings |
用于为 DeviceClient 和 ModuleClient 定义各种特定于传输的设置的接口。 |
| IWillMessage |
在客户端断开连接之前，此客户端要发送的 MQTT“将”消息。 |
枚举
| AuthenticationModel |
设备的身份验证模型;即 X.509 证书、单个客户端范围的 SAS 令牌或 IoT 中心级别范围的 SAS 令牌。 |
| ConnectionStatus |
连接更改事件中的连接状态。 |
| ConnectionStatusChangeReason |
连接状态因连接更改事件而发生更改的原因。 |
| DeliveryAcknowledgement |
指定消息传递的不同确认级别。 |
| IotHubClientErrorCode |
IoT 中心设备/模块客户端错误代码。 |
| IotHubClientTransportProtocol |
传输 (即 MQTT、AMQP) 通信的协议。 |
| MessageAcknowledgement |
用于确认云到设备的选项 (C2D) 消息。 |
| MessageResponse |
处理消息的状态。 |
| MethodResponseStatusCode |
方法响应的状态代码。 |
| QualityOfService |
将通过 MQTT 为其发送特定消息的策略。 |
| RecommendedAction |
设备应用程序为响应连接更改事件而采取的推荐操作。 |
| RetryPolicyType |
DeviceClient 支持的重试策略类型 |
| SdkAssignsMessageId |
可用于在 IoT 中心消息上设置 MessageId 值的不同配置。 |
| TraceEventType | |
| TransportType |
设备和模块客户端支持的传输类型 - AMQP/TCP、HTTP 1.1、MQTT/TCP、AMQP/WS、MQTT/WS |
委托
| ConnectionStatusChangesHandler |
连接状态的委托已更改。 |
| DesiredPropertyUpdateCallback |
所需属性更新回调的委托。 每次从服务收到修补程序时，都会调用此修补程序。 |
| MessageHandler |
在 上收到消息时调用的 ModuleClient委托。 |
| MethodCallback |
方法调用的委托。 每次收到已注册的方法调用时，都会调用此方法。 |
| ReceiveMessageCallback |
在 上收到消息时调用的 DeviceClient委托。 |
