CosmosClientOptions.ApplicationPreferredRegions Propriedade

Definição

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Pacote:

Microsoft.Azure.Cosmos v3.39.0

Origem:

CosmosClientOptions.cs

Obtém e define as regiões preferenciais para contas de banco de dados replicadas geograficamente no serviço do Azure Cosmos DB.

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)

Valor da propriedade

IReadOnlyList<String>

Exemplos

CosmosClientOptions clientOptions = new CosmosClientOptions()
{
    ApplicationPreferredRegions = new List<string>(){ Regions.EastUS, Regions.WestUS }
};

CosmosClient client = new CosmosClient("endpoint", "key", clientOptions);

Comentários

Durante a inicialização do CosmosClient, as informações da conta, incluindo as regiões disponíveis, são obtidas do Endpoint. O CosmosClient usará o valor de ApplicationPreferredRegions para preencher a lista preferencial com as regiões disponíveis da conta que se cruzam com seu valor. Se o valor de ApplicationPreferredRegions contiver regiões que não são uma região disponível na conta, os valores serão ignorados. Se essas regiões inválidas forem adicionadas posteriormente à conta, o CosmosClient as usará se forem mais altas na ordem de preferência.

Se durante a inicialização do CosmosClient, o Endpoint não for acessível, o CosmosClient tentará recuperar e obter as informações da conta que emitem solicitações para as regiões na ordem em ApplicationPreferredRegions que estão listadas.

Confira também Diagnosticar e solucionar problemas da disponibilidade de SDKs do Cosmos para obter mais detalhes.

Essa configuração é uma alternativa a ApplicationRegion, qualquer uma pode ser definida, mas não ambas.