CosmosClientBuilder.WithApplicationPreferredRegions Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos.Fluent

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: CosmosClientBuilder.cs

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.

Set the preferred regions for geo-replicated database accounts in the Azure Cosmos DB service.

public Microsoft.Azure.Cosmos.Fluent.CosmosClientBuilder WithApplicationPreferredRegions (System.Collections.Generic.IReadOnlyList<string> applicationPreferredRegions);

member this.WithApplicationPreferredRegions : System.Collections.Generic.IReadOnlyList<string> -> Microsoft.Azure.Cosmos.Fluent.CosmosClientBuilder

Public Function WithApplicationPreferredRegions (applicationPreferredRegions As IReadOnlyList(Of String)) As CosmosClientBuilder

Parameters

applicationPreferredRegions: IReadOnlyList<String>

A list of preferred Azure regions used for SDK to define failover order.

Returns

CosmosClientBuilder

The current CosmosClientBuilder.

Examples

The example below creates a new CosmosClientBuilder with a of preferred regions.

CosmosClientBuilder cosmosClientBuilder = new CosmosClientBuilder(
    accountEndpoint: "https://testcosmos.documents.azure.com:443/",
    authKeyOrResourceToken: "SuperSecretKey")
.WithApplicationPreferredRegions(new[] {Regions.EastUS, Regions.EastUS2});
CosmosClient client = cosmosClientBuilder.Build();

Remarks

This function is an alternative to WithApplicationRegion(String), either one can be set but not both.

Applies to

Share via