CosmosClientOptions.ApplicationPreferredRegions Eigenschaft

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paket:

Microsoft.Azure.Cosmos v3.39.0

Quelle:

CosmosClientOptions.cs

Ruft die bevorzugten Regionen für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst ab und legt sie fest.

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)

Eigenschaftswert

IReadOnlyList<String>

Beispiele

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

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

Hinweise

Während der CosmosClient-Initialisierung werden die Kontoinformationen, einschließlich der verfügbaren Regionen, aus dem Endpointabgerufen. CosmosClient verwendet den Wert von ApplicationPreferredRegions , um die bevorzugte Liste mit den verfügbaren Regionen des Kontos aufzufüllen, die sich mit ihrem Wert überschneiden. Wenn der Wert von ApplicationPreferredRegions Regionen enthält, die keine verfügbare Region im Konto sind, werden die Werte ignoriert. Wenn diese ungültigen Regionen später dem Konto hinzugefügt werden, verwendet CosmosClient sie, wenn sie höher in der Einstellungsreihenfolge sind.

Wenn während der CosmosClient-Initialisierung nicht Endpoint erreichbar ist, versucht cosmosClient, die Kontoinformationen, die Anforderungen an die Regionen ausstellen, in der Reihenfolge, in ApplicationPreferredRegions der sie aufgelistet sind, wiederherzustellen und abzurufen.

Weitere Informationen finden Sie unter Diagnose und Problembehandlung für die Verfügbarkeit von Cosmos SDKs .

Diese Konfiguration ist eine Alternative zu ApplicationRegion, die entweder festgelegt werden kann, aber nicht beide.