RetryOptions Class

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Client

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

RetryOptions class defines the parameters an application can set to customize the built-in retry policies in the Azure Cosmos DB service.

public class RetryOptions

type RetryOptions = class

Public Class RetryOptions

Inheritance: Object
RetryOptions

Remarks

The DocumentClient class supports retry on certain types of exceptions. This class provides options for applications to control the retry behavior.

Constructors

RetryOptions()

Creates a new instance of the RetryOptions class and intialize all properties to default values for the Azure Cosmos DB service.

Properties

MaxRetryAttemptsOnThrottledRequests	Gets or sets the maximum number of retries in the case where the request fails because the Azure Cosmos DB service has applied rate limiting on the client.
MaxRetryWaitTimeInSeconds	Gets or sets the maximum retry time in seconds for the Azure Cosmos DB service.

Applies to