EventHubConsumerClient クラス

定義

名前空間:

Azure.Messaging.EventHubs.Consumer

アセンブリ:

Azure.Messaging.EventHubs.dll

パッケージ:

Azure.Messaging.EventHubs v5.11.3

ソース:

EventHubConsumerClient.cs

特定のコンシューマー グループのメンバーとして特定のイベント ハブからの読み取 EventData りを担当するクライアント。

コンシューマーは排他的であり、コンシューマー グループの関連付けられたパーティションに対して所有権をアサートし、そのグループの 1 つのコンシューマーのみがパーティションから を読み取れるようにします。 これらの排他的コンシューマーは、"エポック コンシューマー" と呼ばれることもあります。

コンシューマーは非排他的な場合もあり、同じコンシューマー グループの複数のコンシューマーが特定のパーティションからイベントをアクティブに読み取れるようにすることができます。 これらの非排他的コンシューマーは、"非エポック コンシューマー" と呼ばれることもあります。

public class EventHubConsumerClient : IAsyncDisposable

type EventHubConsumerClient = class
    interface IAsyncDisposable

Public Class EventHubConsumerClient
Implements IAsyncDisposable

継承

Object

EventHubConsumerClient

実装

IAsyncDisposable

注釈

EventHubConsumerClientは、アプリケーションの有効期間中はキャッシュして使用しても安全です。これは、アプリケーションがイベントを定期的または半定期的に読み取る場合のベスト プラクティスです。 コンシューマーは、効率的なネットワーク、CPU、メモリの使用を確保する責任があります。 アプリケーションのシャットダウン時に または DisposeAsync() をCloseAsync(CancellationToken)呼び出すと、ネットワーク リソースやその他のアンマネージド オブジェクトが適切にクリーンアップされます。

コンストラクター

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

Event Hubs サービスの既定のコンシューマー グループの名前。

プロパティ

ConsumerGroup	このコンシューマーが関連付けられているコンシューマー グループの名前。 イベントは、このグループのコンテキストでのみ読み取られます。
EventHubName	コンシューマーが接続されている Event Hub の名前。コンシューマーが含まれる Event Hubs 名前空間に固有です。
FullyQualifiedNamespace	コンシューマーが関連付けられている完全修飾 Event Hubs 名前空間。 これは と似ている {yournamespace}.servicebus.windows.net可能性があります。
Identifier	このコンシューマーを識別するために使用される一意の名前。
IsClosed	これが EventHubConsumerClient 閉じられているかどうかを示します。

メソッド

CloseAsync(CancellationToken)	コンシューマーを閉じます。
DisposeAsync()	によって使用されるリソースをクリーンするために必要なタスクをEventHubConsumerClient実行します。これには、クライアント自体が閉じられているかの確認が含まれます。
GetEventHubPropertiesAsync(CancellationToken)	存在するパーティションの数とその識別子など、接続が関連付けられているイベント ハブに関する情報を取得します。
GetPartitionIdsAsync(CancellationToken)	イベント ハブのパーティションの識別子のセットを取得します。
GetPartitionPropertiesAsync(String, CancellationToken)	パーティション イベント ストリームで使用可能なイベントを記述する要素など、Event Hub の特定のパーティションに関する情報を取得します。
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)	イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために をcancellationToken介した取り消しを要求する必要があるため、不確定な時間awaitブロックする可能性があります。 より決定的な最大待機時間が必要なシナリオでは、 を設定 MaximumWaitTime することをお勧めします。
ReadEventsAsync(CancellationToken)	イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために をcancellationToken介した取り消しを要求する必要があるため、不確定な時間awaitブロックする可能性があります。 より決定的な最大待機時間が必要なシナリオでは、 を設定 MaximumWaitTime することをお勧めします。
ReadEventsAsync(ReadEventOptions, CancellationToken)	イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために をcancellationToken介した取り消しを要求する必要があるため、不確定な時間awaitブロックする可能性があります。 より決定的な最大待機時間が必要なシナリオでは、 を設定 MaximumWaitTime することをお勧めします。
ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)	要求されたパーティションから非同期列挙可能としてイベントを読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために をcancellationToken介した取り消しを要求する必要があるため、不確定な時間awaitブロックする可能性があります。 より決定的な最大待機時間が必要なシナリオでは、読み取り動作を構成するための一連のオプションを受け入れるオーバーロードを呼び出することをお勧めします。
ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)	要求されたパーティションから非同期列挙可能としてイベントを読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために をcancellationToken介した取り消しを要求する必要があるため、不確定な時間awaitブロックする可能性があります。 より決定的な最大待機時間が必要なシナリオでは、 を設定 MaximumWaitTime することをお勧めします。