CosmosClientOptions.ApplicationPreferredRegions プロパティ

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.39.0

ソース:

CosmosClientOptions.cs

Azure Cosmos DB サービス内の geo レプリケートされたデータベース アカウントの優先リージョンを取得および設定します。

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代わるものになりますが、両方を設定することはできません。