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

EventPosition interface

表示事件中心分区中事件的位置，通常在对 subscribe() 调用 EventHubConsumerClient 方法时使用，以指定要从中接收事件的分区中的位置。

若要获取表示流的开始或结尾的 EventPosition，请分别使用常量 earliestEventPosition 和 latestEventPosition。

属性

enqueuedOn	此位置标识的事件的排队时间（UTC）。作为数字提供时，此值是自 Unix Epoch 以来的毫秒数。如果刚从序列号或偏移量创建位置，则预期为未定义。
isInclusive	指示指定的偏移量是否包含它标识的事件。仅当事件位置由偏移量或序列号标识时，才会重发此信息。默认值：`false`。
offset	由此位置标识的事件偏移量。如果刚从序列号或排队时间创建位置，则预期为未定义。偏移量是分区上下文中事件的相对位置。不应将偏移量视为稳定值。相同的偏移量可能引用不同的事件，因为事件达到保留期限制，并且不再在分区中可见。
sequenceNumber	此位置标识的事件的序列号。如果刚从偏移量或排队时间创建位置，则预期为未定义。

此位置标识的事件的排队时间（UTC）。作为数字提供时，此值是自 Unix Epoch 以来的毫秒数。如果刚从序列号或偏移量创建位置，则预期为未定义。

enqueuedOn?: number | Date

number | Date

指示指定的偏移量是否包含它标识的事件。仅当事件位置由偏移量或序列号标识时，才会重发此信息。默认值：false。

isInclusive?: boolean

boolean

由此位置标识的事件偏移量。如果刚从序列号或排队时间创建位置，则预期为未定义。

偏移量是分区上下文中事件的相对位置。不应将偏移量视为稳定值。相同的偏移量可能引用不同的事件，因为事件达到保留期限制，并且不再在分区中可见。

offset?: string

string

此位置标识的事件的序列号。如果刚从偏移量或排队时间创建位置，则预期为未定义。

sequenceNumber?: number

number