Share via


你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

EventHubConsumerGroup.CreateReceiver 方法

定义

重载

CreateReceiver(String, ReceiverOptions)

在指定的分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

CreateReceiver(String, DateTime, ReceiverOptions)

从指定的日期和时间开始,在指定的分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

CreateReceiver(String, Int64, ReceiverOptions)

在指定的分区和指定的 epoch 值中创建一个新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

CreateReceiver(String, String, ReceiverOptions)

在指定的起始偏移量处在指定分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

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

在指定起始位置的指定分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

CreateReceiver(String, DateTime, Int64, ReceiverOptions)

从指定的日期和时间开始,在指定的分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

CreateReceiver(String, String, Boolean, ReceiverOptions)

在指定的起始偏移量处在指定分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

CreateReceiver(String, String, Int64, ReceiverOptions)

在指定的起始偏移量处在指定分区中创建新的事件中心接收器。

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

在指定的起始偏移量处在指定分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

CreateReceiver(String, ReceiverOptions)

在指定的分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

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.EventHubReceiver
Public Function CreateReceiver (partitionId As String, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver

参数

partitionId
String

分区的 ID。

receiverOptions
ReceiverOptions

事件中心接收器的选项。

返回

返回 EventHubReceiver 绑定到给定事件中心分区的对象。

例外

如果服务遇到暂时性错误,则引发。

如果客户端在连接到服务时遇到问题,则引发。

如果 partitionId 不在预期范围内(由 PartitionCount 属性确定),则引发。

如果当前连接到指定的 partitionId 分区的接收方数超过了服务设置的最大允许配额,则引发。

如果当前有接收器连接到 指定的 partitionId分区,则引发。

注解

EventHubConsumerGroup如果 启用了检查点,则此重载将始终引发 InvalidOperationException,因为启用了检查点的 ConsumerGroup 需要 epoch 才能正常工作 (请使用提供 epoch 的重载作为输入参数) 。 如果禁用了检查点,则接收方将从事件流的开头获取消息,由事件中心的消息保留策略确定。

适用于

CreateReceiver(String, DateTime, ReceiverOptions)

从指定的日期和时间开始,在指定的分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

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.EventHubReceiver
Public 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)

在指定的分区和指定的 epoch 值中创建一个新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

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.EventHubReceiver
Public Function CreateReceiver (partitionId As String, epoch As Long, Optional receiverOptions As ReceiverOptions = Nothing) As EventHubReceiver

参数

partitionId
String

分区的 ID。

epoch
Int64

epoch 值。 服务使用此值来强制实施分区/租约所有权。

receiverOptions
ReceiverOptions

事件中心接收器的选项。

返回

返回 EventHubReceiver

例外

如果服务遇到暂时性错误,则引发。

如果客户端在连接到服务时遇到问题,则引发。

如果 partitionId 不在预期范围内(由 PartitionCount 属性确定),则引发。

注解

EventHubConsumerGroup如果 已启用检查点,则接收方将从检查点偏移中获取下一条消息。 如果禁用检查点,则接收方将从事件流的开头获取消息,由事件中心的消息保留策略确定。

适用于

CreateReceiver(String, String, ReceiverOptions)

在指定的起始偏移量处在指定分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

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.EventHubReceiver
Public 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)

在指定起始位置的指定分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 partitionId指定的一个事件中心分区的事件。

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.EventHubReceiver
Public 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开始接收消息的起始时间。

epoch
Nullable<Int64>

epoch 值。 如果设置,服务将使用此值来强制实施分区/租用所有权。

receiverOptions
ReceiverOptions

事件中心接收器的选项。

返回

返回 EventHubReceiver

适用于

CreateReceiver(String, DateTime, Int64, ReceiverOptions)

从指定的日期和时间开始,在指定的分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 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.EventHubReceiver
Public 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

epoch 值。 服务使用此值来强制实施分区/租约所有权。

receiverOptions
ReceiverOptions

事件中心接收器的选项。

返回

返回 EventHubReceiver

例外

如果服务遇到暂时性错误,则引发。

如果客户端在连接到服务时遇到问题,则引发。

如果 partitionId 不在预期范围内(由 PartitionCount 属性确定),则引发。

注解

服务仅在确定下一个要传递的事件时将其 startingDateTimeUtc 用作近似值。

请记住,客户端时间和服务时间之间可能存在时钟偏差,因此应将用户应用程序设计为处理事件传递中的重复。

适用于

CreateReceiver(String, String, Boolean, ReceiverOptions)

在指定的起始偏移量处在指定分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 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.EventHubReceiver
Public 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)

在指定的起始偏移量处在指定分区中创建新的事件中心接收器。

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.EventHubReceiver
Public 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

epoch 值。 服务使用此值来强制实施分区/租约所有权。

receiverOptions
ReceiverOptions

事件中心接收器的选项。

返回

返回 EventHubReceiver

例外

如果服务遇到暂时性错误,则引发。

如果客户端在连接到服务时遇到问题,则引发。

如果 partitionId 不在预期范围内(由 PartitionCount 属性确定),则引发。

适用于

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

在指定的起始偏移量处在指定分区中创建新的事件中心接收器。 可以使用创建的接收器接收由 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.EventHubReceiver
Public 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

epoch 值。 服务使用此值来强制实施分区/租约所有权。

receiverOptions
ReceiverOptions

事件中心接收器的选项。

返回

返回 EventHubReceiver

适用于