EventHubConsumerGroup.CreateReceiver メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| CreateReceiver(String, ReceiverOptions) |
指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で |
| CreateReceiver(String, DateTime, ReceiverOptions) |
指定した日付と時刻から開始して、指定したパーティションに新しい Event Hubs レシーバーを作成します。
作成したレシーバーを使用して、 で |
| CreateReceiver(String, Int64, ReceiverOptions) |
指定したパーティションと指定したエポック値に新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で |
| CreateReceiver(String, String, ReceiverOptions) |
指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で |
| CreateReceiver(String, EventPosition, Nullable<Int64>, ReceiverOptions) |
指定した開始位置にある、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で |
| CreateReceiver(String, DateTime, Int64, ReceiverOptions) |
指定した日付と時刻から開始して、指定したパーティションに新しい Event Hubs レシーバーを作成します。
作成したレシーバーを使用して、 で |
| CreateReceiver(String, String, Boolean, ReceiverOptions) |
指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で |
| CreateReceiver(String, String, Int64, ReceiverOptions) |
指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 |
| CreateReceiver(String, String, Boolean, Int64, ReceiverOptions) |
指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で |
CreateReceiver(String, ReceiverOptions)
指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で partitionId指定された 1 つの Event Hubs パーティションのイベントを受信できます。
public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);member this.CreateReceiver : string * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiverPublic Function CreateReceiver (partitionId As String, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiverパラメーター
- partitionId
- String
パーティションの ID。
- receiverOptions
- ReceiverOptions
イベント ハブ レシーバーのオプション。
戻り値
指定された EventHubReceiver Event Hubs パーティションに関連付けられている オブジェクトを返します。
例外
サービスで一時的なエラーが発生した場合にスローされます。
クライアントがサービスへの接続に問題がある場合にスローされます。
が、 プロパティによって決定される、想定される範囲内にない場合 partitionId に PartitionCount スローされます。
によって指定されたパーティションに現在接続されているレシーバーの数が、サービスによって partitionId 設定された最大許容クォータを超えた場合にスローされます。
で指定されたパーティションに現在接続されているレシーバーがある場合に partitionIdスローされます。
注釈
チェックポイントが EventHubConsumerGroup 有効になっている場合、チェックポイントが有効な ConsumerGroup ではエポックが機能する必要があるため、このオーバーロードは常に InvalidOperationException をスローします (入力引数としてエポックを提供するオーバーロードを使用してください)。 チェックポイントが無効になっている場合、受信側は、イベント ハブのメッセージ保持ポリシーによって決定されたイベント ストリームの先頭からメッセージを受け取ります。
適用対象
CreateReceiver(String, DateTime, ReceiverOptions)
指定した日付と時刻から開始して、指定したパーティションに新しい Event Hubs レシーバーを作成します。
作成したレシーバーを使用して、 で partitionId指定された 1 つの Event Hubs パーティションのイベントを受信できます。
public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, DateTime startingDateTimeUtc, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);member this.CreateReceiver : string * DateTime * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiverPublic Function CreateReceiver (partitionId As String, startingDateTimeUtc As DateTime, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiverパラメーター
- partitionId
- String
パーティションの ID。
- startingDateTimeUtc
- DateTime
メッセージを受信するための開始 UTC 時刻。
- receiverOptions
- ReceiverOptions
イベント ハブ レシーバーのオプション。
戻り値
EventHubReceiver を返します。
例外
サービスで一時的なエラーが発生した場合にスローされます。
クライアントがサービスへの接続に問題がある場合にスローされます。
が、 プロパティによって決定される、想定される範囲内にない場合 partitionId に PartitionCount スローされます。
によって指定されたパーティションに現在接続されているレシーバーの数が、サービスによって partitionId 設定された最大許容クォータを超えた場合にスローされます。
で指定されているパーティションに接続されているレシーバーが現在存在し、 が指定 partitionIdされている場合に startingDateTimeUtc スローされます。
注釈
サービスでは、次に配信するイベントを決定するときに、これを startingDateTimeUtc 近似としてのみ使用します。
クライアント時刻とサービス時間の間にはクロック スキューが発生する可能性があるので、イベント配信での重複を処理するようにユーザー アプリケーションを設計する必要があることに注意してください。
適用対象
CreateReceiver(String, Int64, ReceiverOptions)
指定したパーティションと指定したエポック値に新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で partitionId指定された 1 つの Event Hubs パーティションのイベントを受信できます。
public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);member this.CreateReceiver : string * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiverPublic Function CreateReceiver (partitionId As String, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiverパラメーター
- partitionId
- String
パーティションの ID。
- epoch
- Int64
エポック値。 サービスでは、この値を使用してパーティション/リース所有権を適用します。
- receiverOptions
- ReceiverOptions
イベント ハブ レシーバーのオプション。
戻り値
EventHubReceiver を返します。
例外
サービスで一時的なエラーが発生した場合にスローされます。
クライアントがサービスへの接続に問題がある場合にスローされます。
が、 プロパティによって決定される、想定される範囲内にない場合 partitionId に PartitionCount スローされます。
注釈
に EventHubConsumerGroup チェックポイントが有効になっている場合、受信側はチェックポイント オフセットから次のメッセージを受け取ります。 チェックポイントが無効になっている場合、受信側は、イベント ハブのメッセージ保持ポリシーによって決定されたイベント ストリームの先頭からメッセージを取得します。
適用対象
CreateReceiver(String, String, ReceiverOptions)
指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で partitionId指定された 1 つの Event Hubs パーティションのイベントを受信できます。
public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, string startingOffset, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);member this.CreateReceiver : string * string * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiverPublic Function CreateReceiver (partitionId As String, startingOffset As String, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiverパラメーター
- partitionId
- String
パーティションの ID。
- startingOffset
- String
メッセージの受信を開始する開始オフセット。
- receiverOptions
- ReceiverOptions
イベント ハブ レシーバーのオプション。
戻り値
EventHubReceiver を返します。
例外
が、 プロパティによって決定される、想定される範囲内にない場合 partitionId に PartitionCount スローされます。
によって指定されたパーティションに現在接続されているレシーバーの数が、サービスによって partitionId 設定された最大許容クォータを超えた場合にスローされます。
で指定されているパーティションに接続されているレシーバーが現在存在し、 が指定 partitionIdされている場合に startingOffset スローされます。
適用対象
CreateReceiver(String, EventPosition, Nullable<Int64>, ReceiverOptions)
指定した開始位置にある、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で partitionId指定された 1 つの Event Hubs パーティションのイベントを受信できます。
public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, Microsoft.ServiceBus.Messaging.EventPosition position, long? epoch = default, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);member this.CreateReceiver : string * Microsoft.ServiceBus.Messaging.EventPosition * Nullable<int64> * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiverPublic Function CreateReceiver (partitionId As String, position As EventPosition, Optional epoch As Nullable(Of Long) = Nothing, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiverパラメーター
- partitionId
- String
パーティションの ID。
- position
- EventPosition
メッセージの受信を EventPosition 開始する開始位置の 。
- receiverOptions
- ReceiverOptions
イベント ハブ レシーバーのオプション。
戻り値
EventHubReceiver を返します。
適用対象
CreateReceiver(String, DateTime, Int64, ReceiverOptions)
指定した日付と時刻から開始して、指定したパーティションに新しい Event Hubs レシーバーを作成します。
作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。
public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, DateTime startingDateTimeUtc, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);member this.CreateReceiver : string * DateTime * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiverPublic Function CreateReceiver (partitionId As String, startingDateTimeUtc As DateTime, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiverパラメーター
- partitionId
- String
パーティションの ID。
- startingDateTimeUtc
- DateTime
メッセージを受信するための開始 UTC 時刻。
- epoch
- Int64
エポック値。 サービスでは、この値を使用してパーティション/リース所有権を適用します。
- receiverOptions
- ReceiverOptions
イベント ハブ レシーバーのオプション。
戻り値
EventHubReceiver を返します。
例外
サービスで一時的なエラーが発生した場合にスローされます。
クライアントがサービスへの接続に問題がある場合にスローされます。
が、 プロパティによって決定される、想定される範囲内にない場合 partitionId に PartitionCount スローされます。
注釈
サービスでは、次に配信するイベントを決定するときに、これを startingDateTimeUtc 近似としてのみ使用します。
クライアント時刻とサービス時間の間にはクロック スキューが発生する可能性があるので、イベント配信での重複を処理するようにユーザー アプリケーションを設計する必要があることに注意してください。
適用対象
CreateReceiver(String, String, Boolean, ReceiverOptions)
指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。
public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, string startingOffset, bool offsetInclusive, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);member this.CreateReceiver : string * string * bool * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiverPublic Function CreateReceiver (partitionId As String, startingOffset As String, offsetInclusive As Boolean, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiverパラメーター
- partitionId
- String
パーティションの ID。
- startingOffset
- String
メッセージの受信を開始する開始オフセット。
- offsetInclusive
- Boolean
が包括オフセットとして扱われるかどうかを startingOffset 示すブール値。つまり、イベント ハブ レシーバーの最初のオプションです。 返されるイベントは、開始オフセットを含むイベントです。 通常、最初に返されるイベントは、開始オフセットの後のイベントです。
- receiverOptions
- ReceiverOptions
戻り値
EventHubReceiver を返します。
適用対象
CreateReceiver(String, String, Int64, ReceiverOptions)
指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。
public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, string startingOffset, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);member this.CreateReceiver : string * string * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiverPublic Function CreateReceiver (partitionId As String, startingOffset As String, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiverパラメーター
- partitionId
- String
パーティションの ID。
- startingOffset
- String
メッセージの受信を開始する開始オフセット。 ストリームの開始を指定するには、「」を参照してください StartOfStream。
- epoch
- Int64
エポック値。 サービスでは、この値を使用してパーティション/リース所有権を適用します。
- receiverOptions
- ReceiverOptions
イベント ハブ レシーバーのオプション。
戻り値
EventHubReceiver を返します。
例外
サービスで一時的なエラーが発生した場合にスローされます。
クライアントがサービスへの接続に問題がある場合にスローされます。
が プロパティによって決定された範囲内にない場合 partitionId に PartitionCount スローされます。
適用対象
CreateReceiver(String, String, Boolean, Int64, ReceiverOptions)
指定した開始オフセットで、指定したパーティションに新しい Event Hubs レシーバーを作成します。 作成したレシーバーを使用して、 で指定された 1 つの Event Hubs パーティションのイベントを partitionId受信できます。
public Microsoft.ServiceBus.Messaging.EventHubReceiver CreateReceiver (string partitionId, string startingOffset, bool offsetInclusive, long epoch, Microsoft.ServiceBus.Messaging.ReceiverOptions receiverOptions = default);member this.CreateReceiver : string * string * bool * int64 * Microsoft.ServiceBus.Messaging.ReceiverOptions -> Microsoft.ServiceBus.Messaging.EventHubReceiverPublic Function CreateReceiver (partitionId As String, startingOffset As String, offsetInclusive As Boolean, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiverパラメーター
- partitionId
- String
パーティションの ID。
- startingOffset
- String
メッセージの受信を開始する開始オフセット。
- offsetInclusive
- Boolean
が包括オフセットとして扱われるかどうかを startingOffset 示すブール値。つまり、返される最初のイベントは開始オフセットを含むイベントです。 通常、最初に返されるイベントは、開始オフセットの後のイベントです。
- epoch
- Int64
エポック値。 サービスでは、この値を使用してパーティション/リース所有権を適用します。
- receiverOptions
- ReceiverOptions
イベント ハブ レシーバーのオプション。
戻り値
EventHubReceiver を返します。
適用対象
Azure SDK for .NET