Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

ConnectionPolicy.PreferredLocations Property

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.

Gets and sets the preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. For example, "East US" as the preferred location.

public System.Collections.ObjectModel.Collection<string> PreferredLocations { get; }
member this.PreferredLocations : System.Collections.ObjectModel.Collection<string>
Public ReadOnly Property PreferredLocations As Collection(Of String)

Property Value

Remarks

When EnableEndpointDiscovery is true and the value of this property is non-empty, the SDK uses the locations in the collection in the order they are specified to perform operations, otherwise if the value of this property is not specified, the SDK uses the write region as the preferred location for all operations.

If EnableEndpointDiscovery is set to false, the value of this property is ignored.

Applies to

Feedback

Was this page helpful?