你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
CheckpointStore interface
检查点存储存储和检索事件中心实例的给定使用者组中每个分区的分区所有权信息和检查点详细信息。
用户不打算实现 CheckpointStore。
用户应选择此接口的现有实现，将其实例化，并在实例化客户端时将其 EventHubConsumerClient 传递给类构造函数。
用户不应在检查点存储上使用任何方法，这些方法由客户端在内部使用。
CheckpointStore可以通过搜索前缀为 @azure/eventhub-checkpointstore- 的包，在 npm 上找到 的实现。
方法
| claim |
调用 以声明分区列表的所有权。 这将返回已成功拥有的分区列表。 |
| list |
列出给定命名空间、eventhub 和使用者组的数据存储中的所有检查点。 |
| list |
调用 以从基础数据存储中获取所有现有分区所有权的列表。 如果没有现有所有权信息，可能会返回空结果。 |
| update |
汇报分区数据存储中的检查点。 |
方法详细信息
claimOwnership(PartitionOwnership[], OperationOptions)
调用 以声明分区列表的所有权。 这将返回已成功拥有的分区列表。
function claimOwnership(partitionOwnership: PartitionOwnership[], options?: OperationOptions): Promise<PartitionOwnership[]>参数
- partitionOwnership
此实例声明拥有的分区所有权列表。
返回
Promise<PartitionOwnership[]>
此实例成功声明所有权的分区列表。
listCheckpoints(string, string, string, OperationOptions)
列出给定命名空间、eventhub 和使用者组的数据存储中的所有检查点。
function listCheckpoints(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<Checkpoint[]>参数
- fullyQualifiedNamespace
-
string
完全限定的事件中心命名空间。 这可能类似于 .servicebus.windows.net。
- eventHubName
-
string
事件中心名称。
- consumerGroup
-
string
使用者组名称。
返回
Promise<Checkpoint[]>
给定命名空间、eventhub 和使用者组的检查点列表。
listOwnership(string, string, string, OperationOptions)
调用 以从基础数据存储中获取所有现有分区所有权的列表。 如果没有现有所有权信息，可能会返回空结果。
function listOwnership(fullyQualifiedNamespace: string, eventHubName: string, consumerGroup: string, options?: OperationOptions): Promise<PartitionOwnership[]>参数
- fullyQualifiedNamespace
-
string
完全限定的事件中心命名空间。 这可能类似于 .servicebus.windows.net。
- eventHubName
-
string
事件中心名称。
- consumerGroup
-
string
使用者组名称。
返回
Promise<PartitionOwnership[]>
具有/拥有所有者的所有分区的分区所有权详细信息列表。
updateCheckpoint(Checkpoint, OperationOptions)
汇报分区数据存储中的检查点。
function updateCheckpoint(checkpoint: Checkpoint, options?: OperationOptions): Promise<void>参数
- checkpoint
- Checkpoint
检查点。
返回
Promise<void>