CosmosClientOptions.ApplicationRegion 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 ou define o local em que o aplicativo está em execução. Isso influenciará a escolha do SDK para a interação do serviço do Azure Cosmos DB.

public string ApplicationRegion { get; set; }

member this.ApplicationRegion : string with get, set

Public Property ApplicationRegion As String

Valor da propriedade

String

Exemplos

Se uma conta estiver configurada com várias regiões, incluindo Oeste dos EUA, Leste dos EUA e Europa Ocidental, configurar um cliente como o exemplo abaixo resultaria no CosmosClient gerando regiões preferenciais classificadas com base na proximidade com o Leste dos EUA. O CosmosClient enviará solicitações para o Leste dos EUA, se essa região ficar indisponível, retornará para o Oeste dos EUA (segundo em proximidade) e, finalmente, para a Europa Ocidental se o Oeste dos EUA ficar indisponível.

CosmosClientOptions clientOptions = new CosmosClientOptions()
{
    ApplicationRegion = Regions.EastUS
};

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 ApplicationRegion para preencher a lista preferencial com as regiões disponíveis da conta ordenadas pela proximidade geográfica com a região indicada. Se o valor de ApplicationRegion não for uma região disponível na conta, a lista preferencial ainda será preenchida seguindo o mesmo mecanismo, mas não incluirá a região indicada.

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 todas as Regions solicitações ordenadas pela proximidade com o ApplicationRegion. Para obter um controle mais granular sobre as regiões selecionadas ou para definir uma lista com base em critérios personalizados, use ApplicationPreferredRegions em vez de ApplicationRegion.

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

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

Confira também

• WithApplicationRegion(String)