CosmosClientOptions Klasse

Referenz

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Paket:: Microsoft.Azure.Cosmos v3.36.0

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Definiert alle konfigurierbaren Optionen, die für CosmosClient erforderlich sind.

public class CosmosClientOptions

type CosmosClientOptions = class

Public Class CosmosClientOptions

Vererbung: Object
CosmosClientOptions

Beispiele

Ein Beispiel zum Konfigurieren der Serialisierungsoption zum Ignorieren von NULL-Werten.

CosmosClientOptions clientOptions = new CosmosClientOptions()
{
    SerializerOptions = new CosmosSerializationOptions(){
        IgnoreNullValues = true
    },
    ConnectionMode = ConnectionMode.Gateway,
};

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

Konstruktoren

CosmosClientOptions()

Erstellt ein neues CosmosClientOptions-Element.

Eigenschaften

AllowBulkExecution	Ermöglicht die optimistische Batchverarbeitung von Anforderungen für den Dienst. Das Festlegen dieser Option kann sich auf die Latenz der Vorgänge auswirken. Daher wird diese Option nur für Szenarien empfohlen, die keine Latenzen berücksichtigen.
ApplicationName	Rufen Sie das Benutzer-Agent-Suffix ab, das in jede Azure Cosmos DB-Dienstinteraktion eingeschlossen werden soll, oder legen Sie es fest.
ApplicationPreferredRegions	Ruft die bevorzugten Regionen für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst ab und legt sie fest.
ApplicationRegion	Ruft den Speicherort ab, an dem die Anwendung ausgeführt wird, oder legt diese fest. Dies beeinflusst die Auswahl des SDK für die Azure Cosmos DB-Dienstinteraktion.
ConnectionMode	Rufen Sie den Verbindungsmodus ab, der vom Client beim Herstellen einer Verbindung mit dem Azure Cosmos DB-Dienst verwendet wird, oder legen Sie diesen fest.
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.
CosmosClientTelemetryOptions	Ruft Clienttelemetrieoptionen wie Featureflags und entsprechende Optionen ab oder legt diese fest.
CustomHandlers	Ruft die vor dem Prozess ausgeführten Handler ab.
EnableContentResponseOnWrite	Ruft den booleschen Wert ab, der nur die Header und status Code in der Cosmos DB-Antwort für Schreibvorgä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 reduziert, indem die Ressource nicht über das Netzwerk zurückgesendet und auf dem Client serialisiert wird.
EnableTcpConnectionEndpointRediscovery	Ruft das Flag ab, um die Aktualisierung des Adresscaches bei der TCP-Verbindungszurücksetzungsbenachrichtigung zu aktivieren, oder legt es fest.
GatewayModeMaxConnectionLimit	Rufen Sie die maximale Anzahl gleichzeitiger Verbindungen ab, die für den Zieldienstendpunkt im Azure Cosmos DB-Dienst zulässig sind, oder legen Sie diese fest.
HttpClientFactory	Ruft einen Delegaten ab, der zum Abrufen eines HttpClient-instance für die HTTPS-Kommunikation verwendet werden soll, oder legt diesen fest.
IdleTcpConnectionTimeout	(Direct/TCP) Steuert die Dauer der Leerlaufzeit, nach der nicht verwendete Verbindungen geschlossen werden.
LimitToEndpoint	Beschränkt die Vorgänge auf den bereitgestellten Endpunkt im CosmosClient.
MaxRequestsPerTcpConnection	(Direct/TCP) Steuert die Anzahl von Anforderungen, die gleichzeitig über eine einzelne TCP-Verbindung zulässig sind. Wenn mehr Anforderungen gleichzeitig ausgeführt werden, öffnet der direct/TCP-Client zusätzliche Verbindungen.
MaxRetryAttemptsOnRateLimitedRequests	Ruft die maximale Anzahl von Wiederholungsversuchen für den Fall ab, dass die Anforderung fehlschlägt, weil der Azure Cosmos DB-Dienst eine Ratenbegrenzung auf den Client angewendet hat, oder legt diese fest.
MaxRetryWaitTimeOnRateLimitedRequests	Ruft die maximale Wiederholungszeit in Sekunden für den Azure Cosmos DB-Dienst ab oder legt diese fest.
MaxTcpConnectionsPerEndpoint	(Direct/TCP) Steuert die maximale Anzahl von TCP-Verbindungen, die für jedes Cosmos DB-Back-End geöffnet werden können. Zusammen mit MaxRequestsPerTcpConnection begrenzt diese Einstellung die Anzahl der Anforderungen, die gleichzeitig an ein einzelnes Cosmos DB Back-End gesendet werden (MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint).
OpenTcpConnectionTimeout	(Direct/TCP) Steuert den Zeitraum, der für den Versuch, eine Verbindung herzustellen, zulässig ist.
PortReuseMode	(Direct/TCP) Steuert die Wiederverwendungsrichtlinie für Clientports, die vom Transportstapel verwendet wird.
RequestTimeout	Ruft das Anforderungstimeout in Sekunden ab, wenn eine Verbindung mit dem Azure Cosmos DB-Dienst hergestellt wird. Die Zahl gibt an, wie lange gewartet werden muss, bis die Antwort vom Netzwerkpeer zurückgegeben wird.
Serializer	Rufen Sie ab, um ein optionales JSON-Serialisierungsprogramm festzulegen. Der Client verwendet sie, um die Cosmos-Anforderung/-Antworten des Benutzers zu serialisieren oder zu de serialisieren. SDK-eigene Typen wie DatabaseProperties und ContainerProperties verwenden immer das SDK-Standardserialisierungsprogramm.
SerializerOptions	Rufen Sie auf, um optionale Serialisierungsoptionen festzulegen.
ServerCertificateCustomValidationCallback	Ein Rückrufdelegat zum Durchführen einer benutzerdefinierten Zertifikatüberprüfung für HTTP und TCP.
TokenCredentialBackgroundRefreshInterval	Das SDK führt eine Hintergrundaktualisierung basierend auf dem zum Aktualisieren der Tokenanmeldeinformationen festgelegten Zeitintervalls durch. Dadurch werden Latenzprobleme vermieden, da das alte Token verwendet wird, bis das neue Token abgerufen wird.
WebProxy	(Gateway/https) Rufen Sie die Proxyinformationen ab, die für Webanforderungen verwendet werden, oder legen Sie sie fest.

Gilt für:

Freigeben über