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

EventHubConsumerGroup 类

定义

命名空间:

Microsoft.ServiceBus.Messaging

程序集:

Microsoft.ServiceBus.dll

包:

WindowsAzure.ServiceBus v6.2.2

表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。

public sealed class EventHubConsumerGroup : Microsoft.ServiceBus.Messaging.ClientEntity

type EventHubConsumerGroup = class
    inherit ClientEntity

Public NotInheritable Class EventHubConsumerGroup
Inherits ClientEntity

继承

Object

ClientEntity

EventHubConsumerGroup

字段

DefaultGroupName	创建 EventHub 时预先创建的默认 ConsumerGroup 的名称。
EndOfStream	表示流结束的常量。 这可以用作接收方创建中的偏移参数，以从最新事件开始接收，而不是特定的时间点/偏移值。
StartOfStream	表示流开始的常量。 这可以在创建接收方时用作偏移参数。

属性

EnableReceiverRuntimeMetric	获取或设置一个值，该值指示是否启用接收器的运行时指标。
EventHubPath	获取事件中心路径。
GroupName	获取使用者组的名称。
IsClosed	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
PrefetchCount	获取或设置任何接收操作将主动缓存的事件数。 默认情况下，此值继承自 EventHubClient。 默认值为 10，000。
PrefetchSizeInBytes	获取或设置 (最大大小（以字节为单位），) 任何接收操作都将主动缓存。 每个事件数据的大小由 SerializedSizeInBytes 属性确定。
RetryPolicy	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
ThisLock	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)

方法

Abort()	对消息传送实体执行中止功能。 (继承自 ClientEntity)
Close()	向服务总线发送清理消息，以指示实体的使用完成。 (继承自 ClientEntity)
CloseAsync()	以异步方式将清理消息发送到服务总线，以指示实体的使用完成。 (继承自 ClientEntity)
CreateReceiver(String, DateTime, Int64, ReceiverOptions)	从指定的日期和时间开始，在指定的分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。
CreateReceiver(String, DateTime, ReceiverOptions)	从指定的日期和时间开始，在指定的分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。
CreateReceiver(String, EventPosition, Nullable<Int64>, ReceiverOptions)	在指定起始位置的指定分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。
CreateReceiver(String, Int64, ReceiverOptions)	在指定的分区和指定的 epoch 值中创建一个新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。
CreateReceiver(String, ReceiverOptions)	在指定的分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。
CreateReceiver(String, String, Boolean, Int64, ReceiverOptions)	在指定分区中以指定的起始偏移量创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。
CreateReceiver(String, String, Boolean, ReceiverOptions)	在指定分区中以指定的起始偏移量创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。
CreateReceiver(String, String, Int64, ReceiverOptions)	在指定分区中以指定的起始偏移量创建新的事件中心接收器。
CreateReceiver(String, String, ReceiverOptions)	在指定分区中以指定的起始偏移量创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。
CreateReceiverAsync(String, DateTime, Int64, ReceiverOptions)	CreateReceiver(String, DateTime, Int64, ReceiverOptions) 的异步版本。
CreateReceiverAsync(String, DateTime, ReceiverOptions)	CreateReceiver(String, DateTime, ReceiverOptions) 的异步版本。
CreateReceiverAsync(String, EventPosition, Nullable<Int64>, ReceiverOptions)	CreateReceiver(String, EventPosition, Nullable<Int64>, ReceiverOptions) 的异步版本。
CreateReceiverAsync(String, Int64, ReceiverOptions)	CreateReceiver(String, Int64, ReceiverOptions) 的异步版本。
CreateReceiverAsync(String, ReceiverOptions)	CreateReceiver(String, ReceiverOptions) 的异步版本。
CreateReceiverAsync(String, String, Boolean, Int64, ReceiverOptions)	CreateReceiver(String, String, Boolean, Int64, ReceiverOptions) 的异步版本。
CreateReceiverAsync(String, String, Boolean, ReceiverOptions)	CreateReceiver(String, String, Boolean, ReceiverOptions) 的异步版本。
CreateReceiverAsync(String, String, Int64, ReceiverOptions)	CreateReceiver(String, String, Int64, ReceiverOptions) 的异步版本。
CreateReceiverAsync(String, String, ReceiverOptions)	CreateReceiver(String, ReceiverOptions) 的异步版本。
Fault()	仅限内部使用。 请勿从此类继承。 (继承自 ClientEntity)
OnAbort()	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
OnBeginClose(TimeSpan, AsyncCallback, Object)	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
OnBeginOpen(TimeSpan, AsyncCallback, Object)	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
OnClose(TimeSpan)	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
OnClosed()	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
OnEndClose(IAsyncResult)	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
OnEndOpen(IAsyncResult)	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
OnFaulted()	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
OnOpen(TimeSpan)	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
OnOpened()	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
RegisterProcessor<T>(Lease, ICheckpointManager)	注册 的 IEventProcessor 实现，以便从 开始为指定的 PartitionIdOffset开始使用事件中心的事件。 使用此重载创建事件处理程序，该处理器使用 的 ICheckpointManager自定义实现检查消息偏移量。
RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions)	注册 的 IEventProcessor 实现，以便从 开始为指定的 PartitionIdOffset开始使用事件中心的事件。 使用此重载创建事件处理程序，该处理器使用 的 ICheckpointManager自定义实现检查消息偏移量。
RegisterProcessorAsync<T>(Lease, ICheckpointManager)	RegisterProcessor<T>(Lease, ICheckpointManager) 的异步版本。
RegisterProcessorAsync<T>(Lease, ICheckpointManager, EventProcessorOptions)	RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions) 的异步版本。
RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory)	IEventProcessorFactory注册用于创建 实例IEventProcessor的 对象，以便从 开始Offset为 指定的PartitionId分区使用事件。 使用此重载创建事件处理程序，该处理器使用 的 ICheckpointManager自定义实现检查消息偏移量。
RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)	IEventProcessorFactory注册用于创建 实例IEventProcessor的 对象，以便从 开始Offset为 指定的PartitionId分区使用事件。 使用此重载创建事件处理程序，该处理器使用 的 ICheckpointManager自定义实现检查消息偏移量。
RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory)	RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory) 的异步版本。
RegisterProcessorFactoryAsync(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)	RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions) 的异步版本。
ThrowIfClosed()	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
ThrowIfDisposed()	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
ThrowIfDisposedOrImmutable()	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
ThrowIfDisposedOrNotOpen()	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
ThrowIfFaulted()	表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。 (继承自 ClientEntity)
UnregisterProcessor(Lease, CloseReason)	取消注册 IEventProcessor 由 PartitionId指定的分区。 这会导致在 CloseAsync(PartitionContext, CloseReason) 基础事件处理程序上调用。
UnregisterProcessorAsync(Lease, CloseReason)	UnregisterProcessor(Lease, CloseReason) 的异步版本。

事件

EventProcessorLifeCycleManagerFaulted

表示事件中心内的使用者组。 此类为事件中心内的特定使用者组创建接收器。 这可以是默认使用者组，也可以是用户创建的另一个使用者组。