你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
EventHubConsumerClient.ReadEventsAsync 方法
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
重载
| ReadEventsAsync(CancellationToken) |
将事件中心的所有分区作为异步枚举读取事件，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。 如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 |
| ReadEventsAsync(ReadEventOptions, CancellationToken) |
将事件中心的所有分区作为异步枚举读取事件，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。 如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 |
| ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken) |
将事件中心的所有分区作为异步枚举读取事件，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。 如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 |
ReadEventsAsync(CancellationToken)
- Source:
- EventHubConsumerClient.cs
- Source:
- EventHubConsumerClient.cs
将事件中心的所有分区作为异步枚举读取事件，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。
如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 await 量，要求通过 cancellationToken 请求取消以返回控制权。 建议为需要更确定的最长等待期的方案设置 MaximumWaitTime 。
public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsAsync (System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsAsync (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)参数
- cancellationToken
- CancellationToken
一个可选 CancellationToken 实例，用于向请求发出取消操作的信号。
返回
IAsyncEnumerable<T>用于循环访问分区中的事件。
例外
当 由于另一个 EventHubConsumerClient 读取者断言独占所有权而无法从事件中心读取时发生。 在这种情况下， EventHubsException.FailureReason 将设置为 ConsumerDisconnected。
注解
不建议将此方法用于生产用途; EventProcessorClient 应使用 从生产方案中的所有分区读取事件，因为它提供了更可靠的体验，吞吐量更高。
请务必注意，此方法不能保证迭代期间分区之间的公平性;每个分区都争相发布要由枚举器读取的事件。 根据服务通信，每个分区可能有聚类分析事件和/或给定分区或分区子集可能存在明显的偏差。
事件的每个读取者都呈现一个独立的迭代器;如果有多个读取器，则每个人都会收到自己要处理的事件副本，而不是争用它们。
另请参阅
适用于
ReadEventsAsync(ReadEventOptions, CancellationToken)
- Source:
- EventHubConsumerClient.cs
- Source:
- EventHubConsumerClient.cs
将事件中心的所有分区作为异步枚举读取事件，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。
如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 await 量，要求通过 cancellationToken 请求取消以返回控制权。 建议为需要更确定的最长等待期的方案设置 MaximumWaitTime 。
public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsAsync (Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions, System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsAsync : Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsAsync : Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsAsync (readOptions As ReadEventOptions, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)参数
- readOptions
- ReadEventOptions
用于配置读取行为的选项集;如果未指定，将使用默认值。
- cancellationToken
- CancellationToken
一个可选 CancellationToken 实例，用于向请求发出取消操作的信号。
返回
IAsyncEnumerable<T>用于循环访问分区中的事件。
例外
当 由于另一个 EventHubConsumerClient 读取者断言独占所有权而无法从事件中心读取时发生。 在这种情况下， EventHubsException.FailureReason 将设置为 ConsumerDisconnected。
注解
不建议将此方法用于生产用途; EventProcessorClient 应使用 从生产方案中的所有分区读取事件，因为它提供了更可靠的体验，吞吐量更高。
请务必注意，此方法不能保证迭代期间分区之间的公平性;每个分区都争相发布要由枚举器读取的事件。 根据服务通信，每个分区可能有聚类分析事件和/或给定分区或分区子集可能存在明显的偏差。
事件的每个读取者都呈现一个独立的迭代器;如果有多个读取器，则每个人都会收到自己要处理的事件副本，而不是争用它们。
另请参阅
适用于
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)
- Source:
- EventHubConsumerClient.cs
- Source:
- EventHubConsumerClient.cs
将事件中心的所有分区作为异步枚举读取事件，允许事件在分区上可用时进行迭代，在没有可用事件时根据需要等待。
如果事件在分区上不可用，此枚举器可能会阻止 不确定的时间 await 量，要求通过 cancellationToken 请求取消以返回控制权。 建议为需要更确定的最长等待期的方案设置 MaximumWaitTime 。
public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsAsync (bool startReadingAtEarliestEvent, Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsAsync : bool * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsAsync : bool * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsAsync (startReadingAtEarliestEvent As Boolean, Optional readOptions As ReadEventOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)参数
- startReadingAtEarliestEvent
- Boolean
true 从每个分区中可用的第一个事件开始读取;否则，读取将在每个分区的末尾开始，在发布新事件时只看到新事件。
- readOptions
- ReadEventOptions
用于配置读取行为的选项集;如果未指定，将使用默认值。
- cancellationToken
- CancellationToken
一个可选 CancellationToken 实例，用于向请求发出取消操作的信号。
返回
IAsyncEnumerable<T>用于循环访问分区中的事件。
例外
当 由于另一个 EventHubConsumerClient 读取者断言独占所有权而无法从事件中心读取时发生。 在这种情况下， EventHubsException.FailureReason 将设置为 ConsumerDisconnected。
注解
不建议将此方法用于生产用途; EventProcessorClient 应使用 从生产方案中的所有分区读取事件，因为它提供了更可靠的体验，吞吐量更高。
请务必注意，此方法不能保证迭代期间分区之间的公平性;每个分区都争用发布要由枚举器读取的事件。 根据服务通信，每个分区可能有聚类分析事件和/或给定分区或分区子集可能存在明显的偏差。
事件的每个读取者都呈现一个独立的迭代器;如果有多个读取器，则每个人都会收到自己要处理的事件副本，而不是争用它们。
