From dec1e19bdf21abe57efa093745da6118100540c0 Mon Sep 17 00:00:00 2001 From: Richard Park Date: Fri, 18 Sep 2020 15:53:30 -0700 Subject: [PATCH] Update documentation to indicate that there are updates to the checkpoint store that are made when the subscription is closed. --- sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts b/sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts index ca51306d3614..93413b5a8d08 100644 --- a/sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts +++ b/sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts @@ -209,6 +209,10 @@ export interface SubscribeOptions { export interface Subscription { /** * Stops the subscription from receiving more messages. + * + * If a checkpoint store has been configured this will also mark this subscription's + * partitions as abandoned, freeing them up to be read by other consumers. + * * @returns Promise * @throws Error if the underlying connection encounters an error while closing. */