ConnectionPolicy Klasse

Definition

Namespace:

Microsoft.Azure.Documents.Client

Assemblys:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Pakete:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Stellt die Verbindungsrichtlinie dar, die einem DocumentClient zugeordnet ist, um eine Verbindung mit dem Azure Cosmos DB-Dienst herzustellen.

public sealed class ConnectionPolicy

type ConnectionPolicy = class

Public NotInheritable Class ConnectionPolicy

Vererbung

Object

ConnectionPolicy

Konstruktoren

ConnectionPolicy()

Initialisiert einen neuen instance der ConnectionPolicy -Klasse, um eine Verbindung mit dem Azure Cosmos DB-Dienst herzustellen.

Eigenschaften

ConnectionMode	Ruft den Verbindungsmodus ab, der vom Client beim Herstellen einer Verbindung mit dem Azure Cosmos DB-Dienst verwendet wird, oder legt diesen fest.
ConnectionProtocol	Ruft das Verbindungsprotokoll ab, wenn eine Verbindung mit dem Azure Cosmos DB-Dienst hergestellt wird, oder legt es fest.
Default	Ruft die Standardverbindungsrichtlinie ab, die zum Herstellen einer Verbindung mit dem Azure Cosmos DB-Dienst verwendet wird.
EnableEndpointDiscovery	Ruft das Flag ab, um die Endpunktermittlung für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst zu aktivieren, oder legt es fest.
EnableReadRequestsFallback	Ruft ab oder legt fest, ob Lesevorgänge in mehrere Regionen gelangen, die für ein Konto des Azure Cosmos DB-Diensts konfiguriert sind.
EnableTcpConnectionEndpointRediscovery	Ruft das Flag ab, um die Aktualisierung des Adresscaches bei der Benachrichtigung zum Zurücksetzen der Verbindung zu aktivieren, oder legt es fest.
IdleTcpConnectionTimeout	(Direct/TCP) Steuert die Dauer der Leerlaufzeit, nach der nicht verwendete Verbindungen geschlossen werden.
MaxConnectionLimit	Ruft die maximale Anzahl gleichzeitiger Verbindungen ab, die für den Zieldienstendpunkt im Azure Cosmos DB-Dienst zulässig sind, oder legt diese fest.
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.
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 von Anforderungen, die gleichzeitig an ein einzelnes Cosmos DB-Back-End (MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint) gesendet werden.
MediaReadMode	Ruft beim Herstellen einer Verbindung mit dem Azure Cosmos DB-Dienst den Downloadmodus für Anlageninhalte (auch Als Medien) ab oder legt diesen fest.
MediaRequestTimeout	Ruft das Medienanforderungstimeout in Sekunden ab, wenn eine Verbindung mit dem Azure Cosmos DB-Dienst hergestellt wird, oder legt dieses fest. Die Zahl gibt die Zeit an, in der gewartet wird, bis die Antwort vom Netzwerkpeer für Anlageninhaltsvorgänge (auch als Medienvorgänge bezeichnet) zurückgegeben wird.
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.
PreferredLocations	Ruft die bevorzugten Standorte (Regionen) für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst ab und legt sie fest. Beispiel: "USA, Osten" als bevorzugter Standort.
QueryPlanGenerationMode	Ruft ein Flag für die Abfrageausführung ab, um zu steuern, wie der ABFRAGEplan vom SDK instance abgerufen wird, oder legt dieses fest. ServiceInterop funktioniert nur unter Windows mit einer Anwendung, die in x64 ausgeführt wird, und ermöglicht es dem SDK, den Abfrageplan lokal zu generieren.
RequestTimeout	Ruft das Anforderungstimeout in Sekunden ab, wenn eine Verbindung mit dem Azure Cosmos DB-Dienst hergestellt wird, oder legt dieses fest. Die Zahl gibt an, wie lange gewartet werden muss, bis die Antwort vom Netzwerkpeer zurückgegeben wird.
RetryOptions	Ruft den ab, der RetryOptions im Azure Cosmos DB-Dienst zugeordnet ist, oder legt diese fest DocumentClient .
UseMultipleWriteLocations	Ruft das Flag ab, um Schreibvorgänge an beliebigen Standorten (Regionen) für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst zu aktivieren, oder legt dieses fest.
UserAgentSuffix	Ein Suffix, das dem Standardbenutzer-Agent für den Azure Cosmos DB-Dienst hinzugefügt werden soll.

Methoden

SetCurrentLocation(String)

Füllt automatisch die PreferredLocations für georeplizierte Datenbankkonten im Azure Cosmos DB-Dienst auf, basierend auf der aktuellen Region, in der der Client ausgeführt wird.