Compartir a través de


CosmosClientBuilder Clase

Definición

Se trata de una clase Builder que crea un cliente de Cosmos

public class CosmosClientBuilder
type CosmosClientBuilder = class
Public Class CosmosClientBuilder
Herencia
CosmosClientBuilder

Constructores

CosmosClientBuilder(String)

Extrae el punto de conexión y la clave de la cuenta de la cadena de conexión.

CosmosClientBuilder(String, AzureKeyCredential)

Inicialice una nueva clase CosmosConfiguration que contenga todas las propiedades que CosmosClient requiere con la cadena de URI del punto de conexión de la cuenta y AzureKeyCredential. AzureKeyCredential permite cambiar o actualizar master-key/ResourceToken mientras CosmosClient todavía está en uso.

CosmosClientBuilder(String, String)

Inicialice una nueva clase CosmosConfiguration que contenga todas las propiedades que requiere CosmosClient.

CosmosClientBuilder(String, TokenCredential)

Inicializa un nuevo CosmosClientBuilder con una TokenCredential instancia de .

Métodos

AddCustomHandlers(RequestHandler[])

Establece una matriz de controladores personalizados en la solicitud. Los controladores se encadenan en el orden indicado. InvokerHandler.InnerHandler debe ser NULL para permitir que la canalización encadene los controladores.

Build()

Un método para crear cosmos client CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

BuildAndInitializeAsync(IReadOnlyList<ValueTuple<String,String>>, CancellationToken)

Método para crear el cliente de Cosmos e inicializar los contenedores proporcionados. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

WithApplicationName(String)

Sufijo que se va a agregar al agente de usuario predeterminado para el servicio Azure Cosmos DB.

WithApplicationPreferredRegions(IReadOnlyList<String>)

Establezca las regiones preferidas para las cuentas de base de datos con replicación geográfica en el servicio Azure Cosmos DB.

WithApplicationRegion(String)

Establezca la región con replicación geográfica preferida que se usará en el servicio Azure Cosmos DB.

WithBulkExecution(Boolean)

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.

WithClientTelemetryOptions(CosmosClientTelemetryOptions)

Para habilitar las características de telemetría con las opciones correspondientes

WithConnectionModeDirect()

Establece el modo de conexión en Directo. El cliente usa esto al conectarse al servicio Azure Cosmos DB.

WithConnectionModeDirect(Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>, Nullable<PortReuseMode>, Nullable<Boolean>)

Establece el modo de conexión en Directo. El cliente usa esto al conectarse al servicio Azure Cosmos DB.

WithConnectionModeGateway(Nullable<Int32>, IWebProxy)

Establece el modo de conexión en Puerta de enlace. El cliente usa esto al conectarse al servicio Azure Cosmos DB.

WithConsistencyLevel(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.

WithContentResponseOnWrite(Boolean)

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.

WithCustomSerializer(CosmosSerializer)

Establezca un serializador JSON personalizado.

WithHttpClientFactory(Func<HttpClient>)

Establece un delegado que se usará para obtener una instancia httpClient que se usará para la comunicación HTTPS.

WithLimitToEndpoint(Boolean)

Limita las operaciones al punto de conexión proporcionado en el constructor CosmosClientBuilder.

WithRequestTimeout(TimeSpan)

Establece el tiempo de espera de la solicitud en segundos al conectarse al servicio Azure Cosmos DB.

WithSerializerOptions(CosmosSerializationOptions)

Establezca una opción de serializador personalizado.

WithThrottlingRetryOptions(TimeSpan, Int32)

Establece el tiempo máximo de espera entre el reintento y el número máximo de veces que se reintenta en las solicitudes limitadas.

Se aplica a