CosmosClientOptions Clase

Definición

Espacio de nombres:

Azure.Cosmos

Ensamblado:

Azure.Cosmos.dll

Paquete:

Azure.Cosmos v4.0.0-preview3

Define todas las opciones configurables que requiere CosmosClient.

[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

Herencia

Object

ClientOptions

CosmosClientOptions

Atributos

JsonConverterAttribute

Ejemplos

Ejemplo sobre cómo configurar la opción de serialización para omitir valores NULL CosmosClientOptions clientOptions = new CosmosClientOptions() { SerializerOptions = new CosmosSerializationOptions(){ IgnoreNullValues = true }, ConnectionMode = ConnectionMode =ConnectionMode.Gateway, };

Cliente de CosmosClient = new CosmosClient("endpoint", "key", clientOptions);

Constructores

CosmosClientOptions()

Crea una nueva instancia de CosmosClientOptions

Propiedades

ApplicationName	Obtenga o establezca el sufijo user-agent para incluir con cada interacción del servicio de Azure Cosmos DB.
ApplicationRegion	Obtenga o establezca la región con replicación geográfica preferida que se usará para la interacción del servicio Azure Cosmos DB.
ConnectionMode	Obtenga o establezca el modo de conexión que usa el cliente al conectarse al servicio Azure Cosmos DB.
ConsistencyLevel	Esto se puede usar para debilitar el nivel de coherencia de la cuenta de base de datos para las operaciones de lectura. Si no se establece el nivel de coherencia de la cuenta de base de datos se usará para todas las solicitudes.
Diagnostics	Obtiene las opciones de diagnóstico de cliente. (Heredado de ClientOptions)
GatewayModeMaxConnectionLimit	Obtenga o establezca el número máximo de conexiones simultáneas permitidas para el punto de conexión de servicio de destino en el servicio Azure Cosmos DB.
IdleTcpConnectionTimeout	(Directo/TCP) Controla la cantidad de tiempo de inactividad después de la cual se cierran las conexiones sin usar.
LimitToEndpoint	Limita las operaciones al punto de conexión proporcionado en CosmosClient.
MaxRequestsPerTcpConnection	(Directo/TCP) Controla el número de solicitudes permitidas simultáneamente a través de una única conexión TCP. Cuando haya más solicitudes en curso simultáneamente, el cliente direct/TCP abrirá conexiones adicionales.
MaxRetryAttemptsOnRateLimitedRequests	Obtenga o establezca el número de veces que el cliente debe reintentar en las solicitudes limitadas de velocidad.
MaxRetryWaitTimeOnRateLimitedRequests	Obtenga o establezca el tiempo máximo en el cliente para volver a intentar las solicitudes limitadas de velocidad.
MaxTcpConnectionsPerEndpoint	(Directo/TCP) Controla el número máximo de conexiones TCP que se pueden abrir en cada back-end de Cosmos DB. Junto con MaxRequestsPerTcpConnection, esta configuración limita el número de solicitudes que se envían simultáneamente a un único back-end de Cosmos DB(MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint).
OpenTcpConnectionTimeout	(Directo/TCP) Controla la cantidad de tiempo permitido para intentar establecer una conexión.
RequestTimeout	Obtiene el tiempo de espera de la solicitud en segundos al conectarse al servicio Azure Cosmos DB. El número especifica el tiempo de espera para que la respuesta vuelva del mismo nivel de red.
Retry	Obtiene las opciones de reintento de cliente. (Heredado de ClientOptions)
RetryPolicy	Obtiene o establece la directiva que se va a usar para los reintentos. Si se especifica una directiva, se usará en lugar de la Retry propiedad . El RetryPolicy tipo se puede derivar de para modificar el comportamiento predeterminado sin necesidad de implementar completamente la lógica de reintento. Si Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) se invalida o se especifica un personalizado HttpPipelinePolicy , es responsabilidad del implementador actualizar los ProcessingContext valores. (Heredado de ClientOptions)
Serializer	Obtenga para establecer un serializador JSON opcional. El cliente lo usará para serializar o des serializar las solicitudes o respuestas de cosmos del usuario. Los tipos de propiedad del SDK, como DatabaseProperties y ContainerProperties, siempre usarán el serializador predeterminado del SDK.
SerializerOptions	Obtenga para establecer opciones de serializador opcionales.
Transport	HttpPipelineTransport que se va a usar para este cliente. El valor predeterminado es una instancia de HttpClientTransport. (Heredado de ClientOptions)
WebProxy	(Puerta de enlace/Https) Obtiene o establece la información de proxy usada para las solicitudes web.

Métodos

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Agrega una HttpPipeline directiva a la canalización de cliente. El parámetro controla la position posición de la directiva en la canalización. Si desea que la directiva se ejecute una vez por solicitud de cliente, use PerCallPerRetry de lo contrario para ejecutar la directiva para cada reintento. Tenga en cuenta que la misma instancia de policy se agregaría a todas las canalizaciones de cliente construidas mediante este ClientOptions objeto. (Heredado de ClientOptions)