PartitionReceiver クラス

定義

Event Hub の特定のパーティションからイベントを読み取り、特定のコンシューマー グループのコンテキストで、Event Hubs サービスとの通信を他のイベント コンシューマーが提供するよりも高いレベルの制御で読み取ることができます。

public class PartitionReceiver : IAsyncDisposable
type PartitionReceiver = class
    interface IAsyncDisposable
Public Class PartitionReceiver
Implements IAsyncDisposable
継承
PartitionReceiver
実装

注釈

または は、ほとんどのシナリオでイベントの読み取りと処理に使用することをお勧めしますEventProcessorClientEventHubConsumerClient。 パーティションレシーバーは、より直接的な制御を必要とする特別なニーズを持つシナリオを可能にすることを目的としています。

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

コンストラクター

PartitionReceiver()

PartitionReceiver クラスの新しいインスタンスを初期化します。

PartitionReceiver(String, String, EventPosition, EventHubConnection, PartitionReceiverOptions)

PartitionReceiver クラスの新しいインスタンスを初期化します。

PartitionReceiver(String, String, EventPosition, String, PartitionReceiverOptions)

PartitionReceiver クラスの新しいインスタンスを初期化します。

PartitionReceiver(String, String, EventPosition, String, String, AzureNamedKeyCredential, PartitionReceiverOptions)

PartitionReceiver クラスの新しいインスタンスを初期化します。

PartitionReceiver(String, String, EventPosition, String, String, AzureSasCredential, PartitionReceiverOptions)

PartitionReceiver クラスの新しいインスタンスを初期化します。

PartitionReceiver(String, String, EventPosition, String, String, PartitionReceiverOptions)

PartitionReceiver クラスの新しいインスタンスを初期化します。

PartitionReceiver(String, String, EventPosition, String, String, TokenCredential, PartitionReceiverOptions)

PartitionReceiver クラスの新しいインスタンスを初期化します。

プロパティ

ConsumerGroup

このクライアントが関連付けられているコンシューマー グループの名前。 イベントは、このグループのコンテキストでのみ読み取られます。

EventHubName

クライアントが接続されているイベント ハブの名前。クライアントを含む Event Hubs 名前空間に固有です。

FullyQualifiedNamespace

クライアントが関連付けられている完全修飾 Event Hubs 名前空間。 これは と似ている {yournamespace}.servicebus.windows.net可能性があります。

Identifier

このレシーバーを識別するために使用される一意の名前。

InitialPosition

クライアントがイベントの読み取りを開始するパーティション内の位置。

IsClosed

これが PartitionReceiver 閉じられているかどうかを示します。

PartitionId

このクライアントが関連付けられている Event Hub パーティションの識別子。 イベントは、このパーティションからのみ読み取られます。

メソッド

CloseAsync(CancellationToken)

クライアントを閉じます。

DisposeAsync()

によって使用されるリソースをクリーンするために必要なタスクをPartitionReceiver実行します。これには、クライアント自体が閉じられているかの確認が含まれます。

GetPartitionPropertiesAsync(CancellationToken)

このクライアントが関連付けられているパーティションに関する情報 (パーティション イベント ストリームで使用可能なイベントを記述する要素を含む) を取得します。

ReadLastEnqueuedEventProperties()

イベントが Event Hubs サービスから受信されると観察される、このレシーバーに関連付けられているパーティションの最後のエンキューされたイベントに関する情報のセット。 これは、レシーバーが set で TrackLastEnqueuedEventProperties 作成された場合にのみ使用できます。 それ以外の場合、プロパティには既定値が含まれます。

ReceiveBatchAsync(Int32, CancellationToken)

このクライアントが関連付けられている Event Hub パーティションから の EventData バッチを受信します。

ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)

このクライアントが関連付けられている Event Hub パーティションから の EventData バッチを受信します。

適用対象

こちらもご覧ください