Skip to content

Fix: Update session retry optimization public docs#5153

Closed
dibahlfi wants to merge 5 commits intomasterfrom
users/dibahl/session-consistency-doc-update
Closed

Fix: Update session retry optimization public docs#5153
dibahlfi wants to merge 5 commits intomasterfrom
users/dibahl/session-consistency-doc-update

Conversation

@dibahlfi
Copy link
Copy Markdown
Member

This is a public documentation update for the Session Consistency Retries policy in the CosmosClientOption and CosmosClientBuilder to provide clarity on what the EnableRemoteRegion bool does for the client in terms of retries.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please follow the required format: "[Internal] Category: (Adds|Fixes|Refactors|Removes) Description"

Internal should be used for PRs that have no customer impact. This flag is used to help generate the changelog to know which PRs should be included. Examples:
Diagnostics: Adds GetElapsedClientLatency to CosmosDiagnostics
PartitionKey: Fixes null reference when using default(PartitionKey)
[v4] Client Encryption: Refactors code to external project
[Internal] Query: Adds code generator for CosmosNumbers for easy additions in the future.

/// <summary>
/// provides SessionTokenMismatchRetryPolicy optimization through customer supplied region switch hints
/// <summary>
/// Provides SessionTokenMismatchRetryPolicy optimization through customer supplied region switch hints which guide SDK-internal retry policies on how early to switch retries to a different region.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Provides SessionTokenMismatchRetryPolicy optimization through customer supplied region switch hints which guide SDK-internal retry policies on how early to switch retries to a different region.
/// Provides SessionTokenMismatchRetryPolicy optimization through customer supplied region switch hints which guide SDK-internal retry policies on how early to switch retries to a different region.
```suggestion
/// Provides SessionTokenMismatchRetryPolicy optimization through customer supplied region switch hints which guide SDK-internal retry policies on how early to fallback to a different region.

Co-authored-by: Kiran Kumar Kolli <kirankk@microsoft.com>
@kirankumarkolli
Copy link
Copy Markdown
Member

@dibahlfi can you please take a look?

@dibahlfi dibahlfi closed this Feb 1, 2026
@dibahlfi
Copy link
Copy Markdown
Member Author

dibahlfi commented Feb 1, 2026

no needed anymore its based on an older version which has already been updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants