CosmosClientOptions.LimitToEndpoint Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.39.0
Source:
CosmosClientOptions.cs

Limits the operations to the provided endpoint on the CosmosClient.

public bool LimitToEndpoint { get; set; }
member this.LimitToEndpoint : bool with get, set
Public Property LimitToEndpoint As Boolean

Property Value

Boolean

Default value is false.

Remarks

When the value of this property is false, the SDK will automatically discover write and read regions, and use them when the configured application region is not available. When set to true, availability is limited to the endpoint specified on the CosmosClient constructor. Defining the ApplicationRegion or ApplicationPreferredRegions is not allowed when setting the value to true.

Applies to