CosmosClientOptions.ApplicationRegion プロパティ

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.39.0

ソース:

CosmosClientOptions.cs

アプリケーションが実行されている場所を取得または設定します。 これは、Azure Cosmos DB サービスの相互作用に対する SDK の選択に影響します。

public string ApplicationRegion { get; set; }

member this.ApplicationRegion : string with get, set

Public Property ApplicationRegion As String

プロパティ値

String

例

アカウントが米国西部、米国東部、西ヨーロッパを含む複数のリージョンで構成されている場合、次の例のようなクライアントを構成すると、CosmosClient によって米国東部への近接性に基づいて並べ替えられた優先リージョンが生成されます。 CosmosClient は米国東部に要求を送信します。そのリージョンが使用できなくなった場合は、米国西部 (近接して 2 番目) にフォールバックし、米国西部が使用できなくなった場合は最後に西ヨーロッパにフォールバックします。

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

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

注釈

CosmosClient の初期化中に、使用可能なリージョンを含むアカウント情報が から取得されます Endpoint。 CosmosClient では、 の ApplicationRegion 値を使用して、指定されたリージョンに地理的に近い順に並べ替えられたアカウントの使用可能なリージョンを優先リストに設定します。 の ApplicationRegion 値がアカウントで使用可能なリージョンでない場合でも、同じメカニズムに従って優先リストが設定されますが、指定されたリージョンは含まれません。

CosmosClient の初期化中に が Endpoint 到達できない場合、CosmosClient は、 に近接してすべての要求 Regions を発行するアカウント情報の回復と取得を ApplicationRegion試みます。 選択したリージョンをより細かく制御したり、カスタム条件に基づいてリストを定義したりするには、 ではなく ApplicationRegionを使用ApplicationPreferredRegionsします。

詳細については、「 Cosmos SDK の可用性を診断してトラブルシューティングする」 も参照してください。

この構成は、 に ApplicationPreferredRegions代わるものになりますが、両方を設定することはできません。

こちらもご覧ください

• WithApplicationRegion(String)