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

EventHubConsumerClient 类

定义

命名空间:

Azure.Messaging.EventHubs.Consumer

程序集:

Azure.Messaging.EventHubs.dll

包:

Azure.Messaging.EventHubs v5.11.3

Source:

EventHubConsumerClient.cs

作为特定使用者组的成员负责从特定事件中心进行读取 EventData 的客户端。

使用者可能是独占的，它断言对使用者组的关联分区的所有权，以确保该组中只有一个使用者从分区读取 。 这些独占使用者有时称为“Epoch 使用者”。

使用者也可能是非独占的，允许来自同一使用者组的多个使用者主动读取给定分区的事件。 这些非独占使用者有时称为“非纪元使用者”。

public class EventHubConsumerClient : IAsyncDisposable

type EventHubConsumerClient = class
    interface IAsyncDisposable

Public Class EventHubConsumerClient
Implements IAsyncDisposable

继承

Object

EventHubConsumerClient

实现

IAsyncDisposable

注解

EventHubConsumerClient在应用程序的生存期内可以安全地缓存和使用 ，这是应用程序定期或半定期读取事件时的最佳做法。 使用者负责确保高效使用网络、CPU 和内存。 CloseAsync(CancellationToken)在应用程序关闭时调用 或 DisposeAsync() 将确保正确清理网络资源和其他非托管对象。

构造函数

EventHubConsumerClient()	初始化 EventHubConsumerClient 类的新实例。
EventHubConsumerClient(String, EventHubConnection, EventHubConsumerClientOptions)	初始化 EventHubConsumerClient 类的新实例。
EventHubConsumerClient(String, String)	初始化 EventHubConsumerClient 类的新实例。
EventHubConsumerClient(String, String, EventHubConsumerClientOptions)	初始化 EventHubConsumerClient 类的新实例。
EventHubConsumerClient(String, String, String)	初始化 EventHubConsumerClient 类的新实例。
EventHubConsumerClient(String, String, String, AzureNamedKeyCredential, EventHubConsumerClientOptions)	初始化 EventHubConsumerClient 类的新实例。
EventHubConsumerClient(String, String, String, AzureSasCredential, EventHubConsumerClientOptions)	初始化 EventHubConsumerClient 类的新实例。
EventHubConsumerClient(String, String, String, EventHubConsumerClientOptions)	初始化 EventHubConsumerClient 类的新实例。
EventHubConsumerClient(String, String, String, TokenCredential, EventHubConsumerClientOptions)	初始化 EventHubConsumerClient 类的新实例。

字段

DefaultConsumerGroupName

事件中心服务中默认使用者组的名称。

属性

ConsumerGroup	与此使用者关联的使用者组的名称。 事件在此组的上下文中是只读的。
EventHubName	使用者连接到的事件中心的名称，特定于包含该事件中心的事件中心命名空间。
FullyQualifiedNamespace	与使用者关联的完全限定的事件中心命名空间。 这可能类似于 {yournamespace}.servicebus.windows.net。
Identifier	用于标识此使用者的唯一名称。
IsClosed	指示是否已关闭。EventHubConsumerClient

方法

CloseAsync(CancellationToken)	关闭使用者。
DisposeAsync()	执行清理 使用 EventHubConsumerClient的资源所需的任务，包括确保客户端本身已关闭。
GetEventHubPropertiesAsync(CancellationToken)	检索与连接关联的事件中心的相关信息，包括存在的分区数及其标识符。
GetPartitionIdsAsync(CancellationToken)	检索事件中心分区的标识符集。
GetPartitionPropertiesAsync(String, CancellationToken)	检索有关事件中心的特定分区的信息，包括描述分区事件流中可用事件的元素。
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)	将事件中心的所有分区作为异步枚举读取事件，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。 如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 await 量，要求通过 cancellationToken 请求取消以返回控制权。 建议为需要更确定的最长等待期的方案设置 MaximumWaitTime 。
ReadEventsAsync(CancellationToken)	将事件中心的所有分区作为异步枚举读取事件，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。 如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 await 量，要求通过 cancellationToken 请求取消以返回控制权。 建议为需要更确定的最长等待期的方案设置 MaximumWaitTime 。
ReadEventsAsync(ReadEventOptions, CancellationToken)	将事件中心的所有分区作为异步枚举读取事件，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。 如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 await 量，要求通过 cancellationToken 请求取消以返回控制权。 建议为需要更确定的最长等待期的方案设置 MaximumWaitTime 。
ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)	从请求的分区中读取事件作为异步枚举对象，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。 如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 await 量，要求通过 cancellationToken 请求取消以返回控制权。 建议调用重载，该重载接受一组选项，用于在需要更确定的最长等待期的情况下配置读取行为。
ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)	从请求的分区中读取事件作为异步枚举对象，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。 如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 await 量，要求通过 cancellationToken 请求取消以返回控制权。 建议为需要更确定的最长等待期的方案设置 MaximumWaitTime 。