EventHubConsumerGroup クラス

定義

イベント ハブ内のコンシューマー グループを表します。 このクラスは、イベント ハブ内の特定のコンシューマー グループのレシーバーを作成します。 既定のコンシューマー グループまたは別のユーザーが作成したコンシューマー グループを指定できます。

public sealed class EventHubConsumerGroup : Microsoft.ServiceBus.Messaging.ClientEntity
type EventHubConsumerGroup = class
    inherit ClientEntity
Public NotInheritable Class EventHubConsumerGroup
Inherits 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()

クリーンアップ メッセージを Service Bus に送信して、エンティティの使用の完了を通知します。

(継承元 ClientEntity)
CloseAsync()

クリーンアップ メッセージを Service Bus に非同期的に送信して、エンティティの使用の完了を通知します。

(継承元 ClientEntity)
CreateReceiver(String, DateTime, Int64, ReceiverOptions)

指定した日付と時刻から始まる、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。

CreateReceiver(String, DateTime, ReceiverOptions)

指定した日付と時刻から始まる、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。

CreateReceiver(String, EventPosition, Nullable<Int64>, ReceiverOptions)

指定したパーティション内の、指定した開始位置に新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。

CreateReceiver(String, Int64, ReceiverOptions)

指定したパーティションと指定したエポック値に新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。

CreateReceiver(String, ReceiverOptions)

指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。

CreateReceiver(String, String, Boolean, Int64, ReceiverOptions)

指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。

CreateReceiver(String, String, Boolean, ReceiverOptions)

指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。

CreateReceiver(String, String, Int64, ReceiverOptions)

指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。

CreateReceiver(String, String, ReceiverOptions)

指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを 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)

から指定した PartitionId に対して Event Hubs からのイベントの使用を開始するために、 の実装IEventProcessorを登録しますOffset。 このオーバーロードを使用して、 のカスタム実装 ICheckpointManagerを使用してメッセージ オフセットをチェックポイント処理するイベント プロセッサを作成します。

RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions)

から指定した PartitionId に対して Event Hubs からのイベントの使用を開始するために、 の実装IEventProcessorを登録しますOffset。 このオーバーロードを使用して、 のカスタム実装 ICheckpointManagerを使用してメッセージ オフセットをチェックポイント処理するイベント プロセッサを作成します。

RegisterProcessorAsync<T>(Lease, ICheckpointManager)

RegisterProcessor<T>(Lease, ICheckpointManager) の非同期バージョン。

RegisterProcessorAsync<T>(Lease, ICheckpointManager, EventProcessorOptions)

RegisterProcessor<T>(Lease, ICheckpointManager, EventProcessorOptions) の非同期バージョン。

RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory)

IEventProcessorFactoryPartitionId指定されたパーティションのIEventProcessorイベントの使用を開始するために、 のインスタンスの作成に使用される オブジェクトを Offsetから登録します。 このオーバーロードを使用して、 のカスタム実装 ICheckpointManagerを使用してメッセージ オフセットをチェックポイント処理するイベント プロセッサを作成します。

RegisterProcessorFactory(Lease, ICheckpointManager, IEventProcessorFactory, EventProcessorOptions)

IEventProcessorFactoryPartitionId指定されたパーティションのIEventProcessorイベントの使用を開始するために、 のインスタンスの作成に使用される オブジェクトを Offsetから登録します。 このオーバーロードを使用して、 のカスタム実装 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)

IEventProcessorPartitionId指定されたパーティションの登録を解除します。 これにより、 CloseAsync(PartitionContext, CloseReason) 基になるイベント プロセッサでが呼び出されます。

UnregisterProcessorAsync(Lease, CloseReason)

UnregisterProcessor(Lease, CloseReason) の非同期バージョン。

イベント

EventProcessorLifeCycleManagerFaulted

イベント ハブ内のコンシューマー グループを表します。 このクラスは、イベント ハブ内の特定のコンシューマー グループのレシーバーを作成します。 既定のコンシューマー グループまたは別のユーザーが作成したコンシューマー グループを指定できます。

適用対象