你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CosmosClientOptions.ApplicationPreferredRegions 属性

定义

命名空间:

Microsoft.Azure.Cosmos

程序集:

Microsoft.Azure.Cosmos.Client.dll

包:

Microsoft.Azure.Cosmos v3.39.0

Source:

CosmosClientOptions.cs

获取并设置 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)

属性值

IReadOnlyList<String>

示例

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

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

注解

在 CosmosClient 初始化期间，帐户信息（包括可用区域）从 Endpoint获取。 CosmosClient 将使用 的值 ApplicationPreferredRegions 填充首选列表，其中包含与其值相交的帐户可用区域。 如果 的值 ApplicationPreferredRegions 包含帐户中不是可用区域的区域，则将忽略这些值。 如果以后将这些无效区域添加到帐户中，CosmosClient 将使用它们（如果它们在优先顺序中较高）。

如果在 CosmosClient 初始化 Endpoint 期间无法访问 ，CosmosClient 将尝试恢复并获取向区域 ApplicationPreferredRegions 发出请求的帐户信息，其顺序为列出区域。

有关更多详细信息，另请参阅 诊断和排查 Cosmos SDK 的可用性 问题。

此配置是 的替代方法 ApplicationRegion，可以设置任一配置，但不能同时设置两者。