CosmosClientBuilder Classe

Définition

Espace de noms:

Microsoft.Azure.Cosmos.Fluent

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.36.0

Il s’agit d’une classe Builder qui crée un client cosmos

public class CosmosClientBuilder

type CosmosClientBuilder = class

Public Class CosmosClientBuilder

Héritage

Object

CosmosClientBuilder

Constructeurs

CosmosClientBuilder(String)	Extrait le point de terminaison et la clé du compte du chaîne de connexion.
CosmosClientBuilder(String, AzureKeyCredential)	Initialisez une nouvelle classe CosmosConfiguration qui contient toutes les propriétés requises par CosmosClient avec la chaîne URI du point de terminaison de compte et AzureKeyCredential. AzureKeyCredential permet de modifier/mettre à jour master-key/ResourceToken pendant que CosmosClient est toujours en cours d’utilisation.
CosmosClientBuilder(String, String)	Initialisez une nouvelle classe CosmosConfiguration qui contient toutes les propriétés requises par CosmosClient.
CosmosClientBuilder(String, TokenCredential)	Initialise un nouveau CosmosClientBuilder avec un TokenCredential instance.

Méthodes

AddCustomHandlers(RequestHandler[])	Définit un tableau de gestionnaires personnalisés pour la requête. Les gestionnaires seront chaînés dans l’ordre indiqué. InvokerHandler.InnerHandler doit avoir la valeur Null pour permettre au pipeline de chaîner les gestionnaires.
Build()	Une méthode permettant de créer le client cosmos CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion et des performances efficaces des connexions. Reportez-vous au guide de performances.
BuildAndInitializeAsync(IReadOnlyList<ValueTuple<String,String>>, CancellationToken)	Méthode permettant de créer le client cosmos et d’initialiser les conteneurs fournis. En plus de cela, il initialise le client avec des conteneurs fournis, c’est-à-dire que le KIT de développement logiciel (SDK) réchauffe les caches et les connexions avant que le premier appel au service ne soit effectué. Utilisez cette option pour obtenir une latence plus faible au démarrage de votre application. CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion et des performances efficaces des connexions. Reportez-vous au guide de performances.
WithApplicationName(String)	Suffixe à ajouter à l’agent utilisateur par défaut pour le service Azure Cosmos DB.
WithApplicationPreferredRegions(IReadOnlyList<String>)	Définissez les régions préférées pour les comptes de base de données géorépliqués dans le service Azure Cosmos DB.
WithApplicationRegion(String)	Définissez la région géorépliquée par défaut à utiliser dans le service Azure Cosmos DB.
WithBulkExecution(Boolean)	Permet le traitement par lots optimiste des demandes à traiter. La définition de cette option peut avoir un impact sur la latence des opérations. Par conséquent, cette option est recommandée uniquement pour les scénarios sensibles sans latence.
WithClientTelemetryOptions(CosmosClientTelemetryOptions)	Pour activer les fonctionnalités de télémétrie avec les options correspondantes
WithConnectionModeDirect()	Définit le mode de connexion sur Direct. Il est utilisé par le client lors de la connexion au service Azure Cosmos DB.
WithConnectionModeDirect(Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>, Nullable<PortReuseMode>, Nullable<Boolean>)	Définit le mode de connexion sur Direct. Il est utilisé par le client lors de la connexion au service Azure Cosmos DB.
WithConnectionModeGateway(Nullable<Int32>, IWebProxy)	Définit le mode de connexion sur Passerelle. Il est utilisé par le client lors de la connexion au service Azure Cosmos DB.
WithConsistencyLevel(ConsistencyLevel)	Cela peut être utilisé pour affaiblir le niveau de cohérence du compte de base de données pour les opérations de lecture. Si ce n’est pas défini, le niveau de cohérence du compte de base de données sera utilisé pour toutes les demandes.
WithContentResponseOnWrite(Boolean)	Obtient ou définit le booléen de façon à renvoyer uniquement les en-têtes et status code dans la réponse Cosmos DB pour l’opération d’écriture d’élément comme Create, Upsert, Patch et Replace. Si vous définissez l’option sur false, la réponse aura une ressource null. Cela réduit la charge du réseau et du processeur en ne renvoyant pas la ressource sur le réseau et en la sérialisant sur le client.
WithCustomSerializer(CosmosSerializer)	Définissez un sérialiseur JSON personnalisé.
WithHttpClientFactory(Func<HttpClient>)	Définit un délégué à utiliser pour obtenir un instance HttpClient à utiliser pour la communication HTTPS.
WithLimitToEndpoint(Boolean)	Limite les opérations au point de terminaison fourni sur le constructeur CosmosClientBuilder.
WithRequestTimeout(TimeSpan)	Définit le délai d’expiration de la requête en secondes lors de la connexion au service Azure Cosmos DB.
WithSerializerOptions(CosmosSerializationOptions)	Définissez une option de sérialiseur personnalisé.
WithThrottlingRetryOptions(TimeSpan, Int32)	Définit le temps d’attente maximal entre la nouvelle tentative et le nombre maximal de nouvelles tentatives sur les demandes limitées.