EventProcessorClient.ListCheckpointsAsync(CancellationToken) Method


Produces a list of the available checkpoints for the Event Hub and consumer group associated with the event processor instance, so that processing for a given set of partitions can be properly initialized.

protected override System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.Primitives.EventProcessorCheckpoint>> ListCheckpointsAsync (System.Threading.CancellationToken cancellationToken);
override this.ListCheckpointsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.Primitives.EventProcessorCheckpoint>>
Protected Overrides Function ListCheckpointsAsync (cancellationToken As CancellationToken) As Task(Of IEnumerable(Of EventProcessorCheckpoint))



A CancellationToken instance to signal the request to cancel the processing. This is most likely to occur when the processor is shutting down.



The set of checkpoints for the processor to take into account when initializing partitions.


Should a partition not have a corresponding checkpoint, the DefaultStartingPosition will be used to initialize the partition for processing.

In the event that a custom starting point is desired for a single partition, or each partition should start at a unique place, it is recommended that this method express that intent by returning checkpoints for those partitions with the desired custom starting location set.

Applies to