EventHubConsumerClient.ReadEventsFromPartitionAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken) |
要求されたパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、パーティションでイベントが使用できない場合に、 |
| ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken) |
要求されたパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、パーティションでイベントが使用できない場合に、 |
ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)
要求されたパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。
この列挙子は、パーティションでイベントが使用できない場合に、 await の不確定な時間をブロックする場合があり、制御を返すために を cancellationToken 介した取り消しを要求する必要があります。 より決定的な最大待機時間が必要なシナリオでは、読み取り動作を構成するための一連のオプションを受け入れるオーバーロードを呼び出することをお勧めします。
public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsFromPartitionAsync (string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition startingPosition, System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsFromPartitionAsync (partitionId As String, startingPosition As EventPosition, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)パラメーター
- partitionId
- String
イベントの受信元となる Event Hub パーティションの識別子。
- startingPosition
- EventPosition
コンシューマーがイベントの読み取りを開始するパーティション内の位置。
- cancellationToken
- CancellationToken
操作を取り消す要求を通知する省略可能 CancellationToken なインスタンス。
戻り値
パーティション内の IAsyncEnumerable<T> イベントの反復処理に使用する 。
例外
別のリーダーが排他的所有権をアサートしたために、 が要求された Event Hub パーティションから読み取れない場合 EventHubConsumerClient に発生します。 この場合、 EventHubsException.FailureReason は に ConsumerDisconnected設定されます。
注釈
イベントの各リーダーには、独立した反復子が表示されます。複数のリーダーがある場合、それぞれが競合するのではなく、処理するイベントの独自のコピーを受け取ります。
こちらもご覧ください
適用対象
ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)
要求されたパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。
この列挙子は、パーティションでイベントが使用できない場合に、 await の不確定な時間をブロックする場合があり、制御を返すために を cancellationToken 介した取り消しを要求する必要があります。 より決定的な最大待機時間が必要なシナリオでは、 を設定 MaximumWaitTime することをお勧めします。
public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsFromPartitionAsync (string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition startingPosition, Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions, System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsFromPartitionAsync (partitionId As String, startingPosition As EventPosition, readOptions As ReadEventOptions, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)パラメーター
- partitionId
- String
イベントの受信元となる Event Hub パーティションの識別子。
- startingPosition
- EventPosition
コンシューマーがイベントの読み取りを開始するパーティション内の位置。
- readOptions
- ReadEventOptions
読み取り動作の構成に使用するオプションのセット。指定しない場合は、既定値が使用されます。
- cancellationToken
- CancellationToken
操作を取り消す要求を通知する省略可能 CancellationToken なインスタンス。
戻り値
パーティション内の IAsyncEnumerable<T> イベントの反復処理に使用する 。
例外
別のリーダーが排他的所有権をアサートしたために、 が要求された Event Hub パーティションから読み取れない場合 EventHubConsumerClient に発生します。 この場合、 EventHubsException.FailureReason は に ConsumerDisconnected設定されます。
注釈
イベントの各リーダーには、独立した反復子が表示されます。複数のリーダーがある場合、それぞれが競合するのではなく、処理するイベントの独自のコピーを受け取ります。
こちらもご覧ください
適用対象
Azure SDK for .NET