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

ModuleClient 类

定义

命名空间:

Microsoft.Azure.Devices.Client

程序集:

Microsoft.Azure.Devices.Client.dll

包:

Microsoft.Azure.Devices.Client v1.41.2

包含模块可用于向服务发送消息和从服务接收消息并与模块孪生交互的方法。

public class ModuleClient : IDisposable

type ModuleClient = class
    interface IDisposable

Public Class ModuleClient
Implements IDisposable

继承

Object

ModuleClient

实现

IDisposable

属性

DiagnosticSamplingPercentage	诊断采样百分比。
OperationTimeoutInMilliseconds	存储操作重试中使用的超时。 请注意，对于提供取消令牌的操作，将忽略此值。 例如，SendEventAsync (Message) 将使用此超时，但 SendEventAsync (Message、CancellationToken) 将不使用此超时。 后一个操作将仅由提供的取消令牌取消。
ProductInfo	存储将追加到发送到 IoT 中心的用户代理字符串的自定义产品信息。

方法

AbandonAsync(Message)	将收到的消息放回模块队列。
AbandonAsync(Message, CancellationToken)	将收到的消息放回模块队列。
AbandonAsync(String)	将收到的消息放回模块队列。
AbandonAsync(String, CancellationToken)	将收到的消息放回模块队列。
CloseAsync()	关闭 ModuleClient 实例。
CloseAsync(CancellationToken)	关闭 ModuleClient 实例。
CompleteAsync(Message)	从模块队列中删除收到的消息。
CompleteAsync(Message, CancellationToken)	从模块队列中删除收到的消息。
CompleteAsync(String)	从模块队列中删除收到的消息。
CompleteAsync(String, CancellationToken)	从模块队列中删除收到的消息。
Create(String, IAuthenticationMethod, ClientOptions)	从单个参数创建 AMQP ModuleClient。
Create(String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	从单个参数创建 ModuleClient。
Create(String, IAuthenticationMethod, TransportType, ClientOptions)	从单个参数创建 ModuleClient。
Create(String, String, IAuthenticationMethod, ClientOptions)	从单个参数创建 AMQP ModuleClient。
Create(String, String, IAuthenticationMethod, ITransportSettings[], ClientOptions)	从单个参数创建 ModuleClient。
Create(String, String, IAuthenticationMethod, TransportType, ClientOptions)	从单个参数创建 ModuleClient。
CreateFromConnectionString(String, ClientOptions)	使用 AMQP 传输从指定的连接字符串创建 ModuleClient。
CreateFromConnectionString(String, ITransportSettings[], ClientOptions)	使用优先顺序的传输列表从指定的连接字符串创建 ModuleClient。
CreateFromConnectionString(String, TransportType, ClientOptions)	使用指定的传输类型从指定的连接字符串创建 ModuleClient。
CreateFromEnvironmentAsync(ClientOptions)	基于环境变量在IoT Edge部署中创建 ModuleClient 实例。
CreateFromEnvironmentAsync(ITransportSettings[], ClientOptions)	基于环境变量在IoT Edge部署中创建 ModuleClient 实例。
CreateFromEnvironmentAsync(TransportType, ClientOptions)	基于环境变量在IoT Edge部署中创建 ModuleClient 实例。
Dispose()	释放 ModuleClient 使用的非托管资源，并选择性地释放托管资源。
Dispose(Boolean)	释放 ModuleClient 使用的非托管资源，并允许任何派生类替代并提供自定义实现。
GetTwinAsync()	检索当前模块的模块孪生对象。
GetTwinAsync(CancellationToken)	检索当前模块的模块孪生对象。
InvokeMethodAsync(String, MethodRequest)	以交互方式将方法从边缘模块调用边缘设备。 边缘模块和边缘设备都需要连接到同一边缘中心。
InvokeMethodAsync(String, MethodRequest, CancellationToken)	以交互方式将方法从边缘模块调用边缘设备。 边缘模块和边缘设备都需要连接到同一边缘中心。
InvokeMethodAsync(String, String, MethodRequest)	以交互方式将方法从边缘模块调用到其他边缘模块。 这两个边缘模块都需要连接到同一边缘中心。
InvokeMethodAsync(String, String, MethodRequest, CancellationToken)	以交互方式将方法从边缘模块调用到其他边缘模块。 这两个边缘模块都需要连接到同一边缘中心。
OpenAsync()	显式打开 ModuleClient 实例。
OpenAsync(CancellationToken)	显式打开 ModuleClient 实例。
SendEventAsync(Message)	将事件发送到 IoT 中心。
SendEventAsync(Message, CancellationToken)	将事件发送到 IoT 中心。
SendEventAsync(String, Message)	将事件发送到 IoT 中心。
SendEventAsync(String, Message, CancellationToken)	将事件发送到 IoT 中心。
SendEventBatchAsync(IEnumerable<Message>)	将一批事件发送到 IoT 中心。 使用 AMQP 或 HTTP 执行真正的批处理操作。 MQTT 将一个接一个地发送消息。 有关IoT Edge模块路由 https://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes的详细信息。
SendEventBatchAsync(IEnumerable<Message>, CancellationToken)	将一批事件发送到 IoT 中心。 使用 AMQP 或 HTTP 执行真正的批处理操作。 MQTT 将一个接一个地发送消息。 有关IoT Edge模块路由 https://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes的详细信息。
SendEventBatchAsync(String, IEnumerable<Message>)	将一批事件发送到 IoT 中心。 使用 AMQP 或 HTTP 执行真正的批处理操作。 MQTT 将一个接一个地发送消息。 有关IoT Edge模块路由的详细信息https://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes
SendEventBatchAsync(String, IEnumerable<Message>, CancellationToken)	将一批事件发送到 IoT 中心。 使用 AMQP 或 HTTP 执行真正的批处理操作。 MQTT 将一个接一个地发送消息。 有关IoT Edge模块路由的详细信息https://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes
SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler)	设置连接状态更改回调的新委托。 如果委托已关联，它将替换为新委托。 请注意，如果客户端配置为使用 HTTP，则永远不会调用此回调，因为该协议是无状态的
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object)	设置一个回调，每当客户端从服务收到所需或报告) 的状态更新 (时，将调用该回调。 将回调值设置为 null 以清除。
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken)	设置一个回调，每当客户端从服务收到所需或报告) 的状态更新 (时，将调用该回调。 将回调值设置为 null 以清除。
SetInputMessageHandlerAsync(String, MessageHandler, Object)	设置特定输入的新委托。 如果委托已与输入关联，则它将替换为新委托。
SetInputMessageHandlerAsync(String, MessageHandler, Object, CancellationToken)	设置特定输入的新委托。 如果委托已与输入关联，则它将替换为新委托。
SetMessageHandlerAsync(MessageHandler, Object)	设置应用于所有终结点的新默认委托。 如果委托已与输入关联，则将调用它，否则将调用默认委托。 如果之前设置了默认委托，则会覆盖该委托。
SetMessageHandlerAsync(MessageHandler, Object, CancellationToken)	设置应用于所有终结点的新默认委托。 如果委托已与输入关联，则将调用它，否则将调用默认委托。 如果之前设置了默认委托，则会覆盖该委托。
SetMethodDefaultHandlerAsync(MethodCallback, Object)	设置为方法调用的新委托，该方法没有为其名称注册委托。 如果默认委托已注册，它将替换为新委托。 可以通过传递 null MethodCallback 来取消设置方法处理程序。
SetMethodDefaultHandlerAsync(MethodCallback, Object, CancellationToken)	设置为方法调用的新委托，该方法没有为其名称注册委托。 如果默认委托已注册，它将替换为新委托。 可以通过传递 null MethodCallback 来取消设置方法处理程序。
SetMethodHandlerAsync(String, MethodCallback, Object)	设置命名方法的新委托。 如果委托已与命名方法关联，则它将替换为新委托。 可以通过传递 null MethodCallback 来取消设置方法处理程序。
SetMethodHandlerAsync(String, MethodCallback, Object, CancellationToken)	设置命名方法的新委托。 如果委托已与命名方法关联，则它将替换为新委托。 可以通过传递 null MethodCallback 来取消设置方法处理程序。
SetRetryPolicy(IRetryPolicy)	设置重试操作中使用的重试策略。 更改将在任何正在进行的操作后生效。
UpdateReportedPropertiesAsync(TwinCollection)	将报告的属性更改推送到服务。
UpdateReportedPropertiesAsync(TwinCollection, CancellationToken)	将报告的属性更改推送到服务。