CosmosClientOptions.ApplicationPreferredRegions Propriété

Définition

Espace de noms:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.39.0

Source:

CosmosClientOptions.cs

Obtient et définit les régions préférées pour les comptes de base de données géorépliqués dans le service 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)

Valeur de propriété

IReadOnlyList<String>

Exemples

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

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

Remarques

Lors de l’initialisation de CosmosClient, les informations de compte, y compris les régions disponibles, sont obtenues à partir de Endpoint. CosmosClient utilise la valeur de ApplicationPreferredRegions pour remplir la liste par défaut avec les régions disponibles du compte qui se croisent avec sa valeur. Si la valeur de contient des ApplicationPreferredRegions régions qui ne sont pas disponibles dans le compte, les valeurs sont ignorées. Si ces régions non valides sont ajoutées ultérieurement au compte, cosmosClient les utilise si elles sont supérieures dans l’ordre de préférence.

Si, lors de l’initialisation de CosmosClient, le Endpoint n’est pas accessible, le CosmosClient tente de récupérer et d’obtenir les informations de compte qui émettent des demandes aux régions dans ApplicationPreferredRegions l’ordre dans lequel elles sont répertoriées.

Pour plus d’informations, consultez également Diagnostiquer et résoudre les problèmes de disponibilité des KITS de développement logiciel (SDK) Cosmos .

Cette configuration est une alternative à , l’une ou l’autre ApplicationRegionpeut être définie, mais pas les deux.