CosmosClientBuilder Klasse

Definition

Namespace:

Microsoft.Azure.Cosmos.Fluent

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paket:

Microsoft.Azure.Cosmos v3.36.0

Dies ist eine Builder-Klasse, die einen Cosmos-Client erstellt.

public class CosmosClientBuilder

type CosmosClientBuilder = class

Public Class CosmosClientBuilder

Vererbung

Object

CosmosClientBuilder

Konstruktoren

CosmosClientBuilder(String)	Extrahiert den Kontoendpunkt und den Schlüssel aus dem Verbindungszeichenfolge.
CosmosClientBuilder(String, AzureKeyCredential)	Initialisieren Sie eine neue CosmosConfiguration-Klasse, die alle von CosmosClient benötigten Eigenschaften mit der URI-Zeichenfolge des Kontoendpunkts und AzureKeyCredential enthält. AzureKeyCredential ermöglicht das Ändern/Aktualisieren master-key/ResourceToken, während CosmosClient noch verwendet wird.
CosmosClientBuilder(String, String)	Initialisieren Sie eine neue CosmosConfiguration-Klasse, die alle Eigenschaften enthält, die CosmosClient benötigt.
CosmosClientBuilder(String, TokenCredential)	Initialisiert einen neuen CosmosClientBuilder mit einem TokenCredential instance.

Methoden

AddCustomHandlers(RequestHandler[])	Legt ein Array benutzerdefinierter Handler auf die Anforderung fest. Die Handler werden in der aufgeführten Reihenfolge verkettet. Der InvokerHandler.InnerHandler muss NULL sein, damit die Pipeline die Handler verketten kann.
Build()	Eine Methode zum Erstellen des CosmosClient-Clients ist threadsicher. Es wird empfohlen, eine einzelne instance von CosmosClient pro Lebensdauer der Anwendung beizubehalten, was eine effiziente Verbindungsverwaltung und -leistung ermöglicht. Weitere Informationen finden Sie im Leistungsleitfaden.
BuildAndInitializeAsync(IReadOnlyList<ValueTuple<String,String>>, CancellationToken)	Eine Methode zum Erstellen des Cosmos-Clients und zum Initialisieren der bereitgestellten Container. Darüber hinaus initialisiert es den Client mit bereitgestellten Containern, d. h. das SDK erwärmt die Caches und Verbindungen, bevor der erste Aufruf des Diensts erfolgt. Verwenden Sie dies, um beim Starten Ihrer Anwendung eine geringere Latenz zu erzielen. CosmosClient ist threadsicher. Es wird empfohlen, eine einzelne instance von CosmosClient pro Lebensdauer der Anwendung beizubehalten, was eine effiziente Verbindungsverwaltung und -leistung ermöglicht. Weitere Informationen finden Sie im Leistungsleitfaden.
WithApplicationName(String)	Ein Suffix, das dem Standardbenutzer-Agent für den Azure Cosmos DB-Dienst hinzugefügt werden soll.
WithApplicationPreferredRegions(IReadOnlyList<String>)	Legen Sie die bevorzugten Regionen für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst fest.
WithApplicationRegion(String)	Legen Sie die bevorzugte georeplizierte Region fest, die im Azure Cosmos DB-Dienst verwendet werden soll.
WithBulkExecution(Boolean)	Ermöglicht das optimistische Batching von Anforderungen an den Dienst. Das Festlegen dieser Option kann sich auf die Latenz der Vorgänge auswirken. Daher wird diese Option nur für Szenarien ohne Latenz empfohlen.
WithClientTelemetryOptions(CosmosClientTelemetryOptions)	So aktivieren Sie Telemetriefeatures mit entsprechenden Optionen
WithConnectionModeDirect()	Legt den Verbindungsmodus auf Direct fest. Dies wird vom Client verwendet, wenn eine Verbindung mit dem Azure Cosmos DB-Dienst hergestellt wird.
WithConnectionModeDirect(Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>, Nullable<PortReuseMode>, Nullable<Boolean>)	Legt den Verbindungsmodus auf Direct fest. Dies wird vom Client verwendet, wenn eine Verbindung mit dem Azure Cosmos DB-Dienst hergestellt wird.
WithConnectionModeGateway(Nullable<Int32>, IWebProxy)	Legt den Verbindungsmodus auf Gateway fest. Dies wird vom Client verwendet, wenn eine Verbindung mit dem Azure Cosmos DB-Dienst hergestellt wird.
WithConsistencyLevel(ConsistencyLevel)	Dies kann verwendet werden, um die Konsistenzebene des Datenbankkontos für Lesevorgänge zu schwächen. Wenn dies nicht festgelegt ist, wird die Datenbankkontokonsistenzebene für alle Anforderungen verwendet.
WithContentResponseOnWrite(Boolean)	Ruft den booleschen Wert ab, der nur die Header zurückgibt und status Code in der Cosmos DB-Antwort für Schreibelementvorgänge wie Create, Upsert, Patch und Replace zurückgibt, oder legt diesen fest. Wenn Sie die Option auf false festlegen, hat die Antwort eine NULL-Ressource. Dadurch wird die Netzwerk- und CPU-Last verringert, da die Ressource nicht über das Netzwerk zurückgesendet und auf dem Client serialisiert wird.
WithCustomSerializer(CosmosSerializer)	Legen Sie einen benutzerdefinierten JSON-Serialisierer fest.
WithHttpClientFactory(Func<HttpClient>)	Legt einen Delegaten fest, der zum Abrufen eines HttpClient-instance für die HTTPS-Kommunikation verwendet werden soll.
WithLimitToEndpoint(Boolean)	Schränkt die Vorgänge auf den bereitgestellten Endpunkt im CosmosClientBuilder-Konstruktor ein.
WithRequestTimeout(TimeSpan)	Legt das Anforderungstimeout in Sekunden fest, wenn eine Verbindung mit dem Azure Cosmos DB-Dienst hergestellt wird.
WithSerializerOptions(CosmosSerializationOptions)	Legen Sie eine benutzerdefinierte Serialisierungsoption fest.
WithThrottlingRetryOptions(TimeSpan, Int32)	Legt die maximale Wartezeit zwischen Wiederholungsversuchen und die maximale Anzahl von Wiederholungsversuchen für gedrosselte Anforderungen fest.