CosmosClientOptions Klasse

Definition

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Paket:

Azure.Cosmos v4.0.0-preview3

Definiert alle konfigurierbaren Optionen, die der CosmosClient benötigt.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonCosmosClientOptionsConverter))]
public class CosmosClientOptions : Azure.Core.ClientOptions

[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonCosmosClientOptionsConverter))>]
type CosmosClientOptions = class
    inherit ClientOptions

Public Class CosmosClientOptions
Inherits ClientOptions

Vererbung

Object

ClientOptions

CosmosClientOptions

Attribute

JsonConverterAttribute

Beispiele

Beispiel zum Konfigurieren der Serialisierungsoption zum Ignorieren von NULL-Werten CosmosClientOptions = new CosmosClientOptions() { SerializerOptions = new CosmosSerializationOptions(){ IgnoreNullValues = true }, ConnectionMode = ConnectionMode. Gateway, };

CosmosClient-Client = new CosmosClient("endpoint", "key", clientOptions);

Konstruktoren

CosmosClientOptions()

Erstellt eine neue CosmosClientOptions

Eigenschaften

ApplicationName	Abrufen oder Festlegen des Benutzer-Agent-Suffixs, das in jede Azure Cosmos DB-Dienstinteraktion eingeschlossen werden soll.
ApplicationRegion	Rufen Sie die bevorzugte georeplizierte Region ab, die für die Azure Cosmos DB-Dienstinteraktion verwendet werden soll, oder legen Sie sie fest.
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.
Diagnostics	Ruft die Clientdiagnoseoptionen ab. (Geerbt von ClientOptions)
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.
IdleTcpConnectionTimeout	(Direct/TCP) Steuert die Leerlaufzeit, nach der nicht verwendete Verbindungen geschlossen werden.
LimitToEndpoint	Schränkt die Vorgänge auf den bereitgestellten Endpunkt im CosmosClient ein.
MaxRequestsPerTcpConnection	(Direct/TCP) Steuert die Anzahl von Anforderungen, die gleichzeitig über eine einzelne TCP-Verbindung zulässig sind. Wenn mehrere Anforderungen gleichzeitig im Flight ausgeführt werden, öffnet der Direct/TCP-Client zusätzliche Verbindungen.
MaxRetryAttemptsOnRateLimitedRequests	Rufen Sie die Häufigkeit ab, mit der der Client die Rate gedrosselter Anforderungen wiederholen soll, oder legen Sie sie fest.
MaxRetryWaitTimeOnRateLimitedRequests	Rufen Sie die maximale Zeit ab, oder legen Sie fest, dass der Client bei der Rate gedrosselter Anforderungen erneut versuchen darf.
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 schränkt diese Einstellung die Anzahl der Anforderungen ein, die gleichzeitig an ein einzelnes Cosmos DB-Back-End (MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint) gesendet werden.
OpenTcpConnectionTimeout	(Direct/TCP) Steuert die Zeit, die für den Versuch, eine Verbindung herzustellen, zulässig ist.
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ückkommt.
Retry	Ruft die Client-Wiederholungsoptionen ab. (Geerbt von ClientOptions)
RetryPolicy	Ruft die Richtlinie ab, die für Wiederholungen verwendet werden soll, oder legt sie fest. Wenn eine Richtlinie angegeben wird, wird sie anstelle der Retry -Eigenschaft verwendet. Der RetryPolicy Typ kann abgeleitet werden, um das Standardverhalten zu ändern, ohne die Wiederholungslogik vollständig implementieren zu müssen. Wenn Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) überschrieben oder ein benutzerdefinierter HttpPipelinePolicy Wert angegeben ist, liegt es in der Verantwortung des Implementierers, die ProcessingContext Werte zu aktualisieren. (Geerbt von ClientOptions)
Serializer	Rufen Sie zum Festlegen eines optionalen JSON-Serialisierungsprogramms ab. Der Client verwendet sie, um die Cosmos-Anforderungen/-antworten des Benutzers zu serialisieren oder zu de serialisieren. SDK-eigene Typen wie DatabaseProperties und ContainerProperties verwenden immer den SDK-Standardserialisierer.
SerializerOptions	Rufen Sie auf, um optionale Serialisierungsoptionen festzulegen.
Transport	Der HttpPipelineTransport , der für diesen Client verwendet werden soll. Standardmäßig wird ein instance von verwendetHttpClientTransport. (Geerbt von ClientOptions)
WebProxy	(Gateway/Https) Rufen Sie die Proxyinformationen ab, die für Webanforderungen verwendet werden, oder legen Sie sie fest.

Methoden

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Fügt der Clientpipeline eine Richtlinie hinzu HttpPipeline . Die Position der Richtlinie in der Pipeline wird durch den position -Parameter gesteuert. Wenn die Richtlinie einmal pro Clientanforderung ausgeführt werden soll, verwenden Sie PerCall andernfalls PerRetry die Verwendung, um die Richtlinie für jeden Wiederholungsversuch auszuführen. Beachten Sie, dass derselbe instance von policy allen Pipelines des Clients hinzugefügt wird, die mit diesem ClientOptions Objekt erstellt wurden. (Geerbt von ClientOptions)