Feedback

CosmosClientOptions.ApplicationPreferredRegions Property

  • Reference

Definition

Namespace:
Microsoft.Azure.Cosmos
Assembly:
Microsoft.Azure.Cosmos.Client.dll
Package:
Microsoft.Azure.Cosmos v3.28.0

Gets and sets the preferred regions for geo-replicated database accounts in the Azure Cosmos DB service.

public System.Collections.Generic.IReadOnlyList<string> ApplicationPreferredRegions { get; set; }
member this.ApplicationPreferredRegions : System.Collections.Generic.IReadOnlyList<string> with get, set
Public Property ApplicationPreferredRegions As IReadOnlyList(Of String)

Property Value

IReadOnlyList<String>

Remarks

When this property is specified, the SDK will use the region list in the provided order to define the endpoint failover order. This configuration is an alternative to ApplicationRegion, either one can be set but not both. See also Diagnose and troubleshoot the availability of Cosmos SDKs for more details.

Applies to