CosmosClientOptions Clase

Definición

Espacio de nombres:

Microsoft.Azure.Cosmos

Ensamblado:

Microsoft.Azure.Cosmos.Client.dll

Paquete:

Microsoft.Azure.Cosmos v3.36.0

Define todas las opciones configurables que requiere CosmosClient.

public class CosmosClientOptions

type CosmosClientOptions = class

Public Class CosmosClientOptions

Herencia

Object

CosmosClientOptions

Ejemplos

Ejemplo sobre cómo configurar la opción de serialización para omitir los valores NULL.

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

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

Constructores

CosmosClientOptions()

Crea una instancia de CosmosClientOptions

Propiedades

AllowBulkExecution	Permite el procesamiento por lotes optimista de solicitudes al servicio. Establecer esta opción podría afectar a la latencia de las operaciones. Por lo tanto, esta opción solo se recomienda para escenarios confidenciales que no son de latencia.
ApplicationName	Obtenga o establezca el sufijo user-agent para incluirlo con cada interacción del servicio de Azure Cosmos DB.
ApplicationPreferredRegions	Obtiene y establece las regiones preferidas para las cuentas de base de datos con replicación geográfica en el servicio Azure Cosmos DB.
ApplicationRegion	Obtiene o establece la ubicación donde se ejecuta la aplicación. Esto influirá en la elección del SDK 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.
CosmosClientTelemetryOptions	Obtiene o establece opciones de telemetría de cliente, como las marcas de características y las opciones correspondientes.
CustomHandlers	Obtiene los controladores que se ejecutan antes del proceso.
EnableContentResponseOnWrite	Obtiene o establece el valor booleano para devolver solo los encabezados y el código de estado en la respuesta de Cosmos DB para la operación de elemento de escritura, como Create, Upsert, Patch y Replace. Si se establece la opción en false, la respuesta tendrá un recurso nulo. Esto reduce la carga de red y CPU al no devolver el recurso a través de la red y serializarlo en el cliente.
EnableTcpConnectionEndpointRediscovery	Obtiene o establece la marca para habilitar la actualización de la caché de direcciones en la notificación de restablecimiento de conexión TCP.
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.
HttpClientFactory	Obtiene o establece un delegado que se va a usar para obtener una instancia httpClient que se va a usar para la comunicación HTTPS.
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 directo/TCP abrirá conexiones adicionales.
MaxRetryAttemptsOnRateLimitedRequests	Obtiene o establece el número máximo de reintentos en caso de que se produzca un error en la solicitud porque el servicio Azure Cosmos DB ha aplicado la limitación de velocidad en el cliente.
MaxRetryWaitTimeOnRateLimitedRequests	Obtiene o establece el tiempo máximo de reintento en segundos para el servicio Azure Cosmos DB.
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.
PortReuseMode	(Directo/TCP) Controla la directiva de reutilización de puertos de cliente usada por la pila de transporte.
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.
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 propiedad del SDK, como DatabaseProperties y ContainerProperties, siempre usarán el serializador predeterminado del SDK.
SerializerOptions	Obtenga para establecer las opciones opcionales del serializador.
ServerCertificateCustomValidationCallback	Delegado de devolución de llamada para realizar la validación de certificados personalizada para HTTP y TCP.
TokenCredentialBackgroundRefreshInterval	El SDK realiza una actualización en segundo plano en función del intervalo de tiempo establecido para actualizar las credenciales del token. Esto evita problemas de latencia porque el token anterior se usa hasta que se recupera el nuevo token.
WebProxy	(Puerta de enlace/Https) Obtiene o establece la información de proxy usada para las solicitudes web.