CosmosClientOptions Classe

Définition

Espace de noms:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.36.0

Définit toutes les options configurables requises par CosmosClient.

public class CosmosClientOptions

type CosmosClientOptions = class

Public Class CosmosClientOptions

Héritage

Object

CosmosClientOptions

Exemples

Exemple de configuration de l’option de sérialisation pour ignorer les valeurs null.

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

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

Constructeurs

CosmosClientOptions()

Crée un cosmosClientOptions

Propriétés

AllowBulkExecution	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.
ApplicationName	Obtenez ou définissez le suffixe user-agent à inclure dans chaque interaction de service Azure Cosmos DB.
ApplicationPreferredRegions	Obtient et définit 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.
ApplicationRegion	Obtient ou définit l’emplacement où l’application s’exécute. Cela influence le choix du KIT de développement logiciel (SDK) pour l’interaction du service Azure Cosmos DB.
ConnectionMode	Obtenez ou définissez le mode de connexion utilisé par le client lors de la connexion au service Azure Cosmos DB.
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.
CosmosClientTelemetryOptions	Obtient ou définit les options de télémétrie du client, comme les indicateurs de fonctionnalité et les options correspondantes
CustomHandlers	Obtient les gestionnaires exécutés avant le processus
EnableContentResponseOnWrite	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.
EnableTcpConnectionEndpointRediscovery	Obtient ou définit l’indicateur pour activer l’actualisation du cache d’adresses lors de la notification de réinitialisation de connexion TCP.
GatewayModeMaxConnectionLimit	Obtenez ou définissez le nombre maximal de connexions simultanées autorisées pour le point de terminaison de service cible dans le service Azure Cosmos DB.
HttpClientFactory	Obtient ou définit un délégué à utiliser pour obtenir un instance HttpClient à utiliser pour la communication HTTPS.
IdleTcpConnectionTimeout	(Direct/TCP) Contrôle le temps d’inactivité après lequel les connexions inutilisées sont fermées.
LimitToEndpoint	Limite les opérations au point de terminaison fourni sur CosmosClient.
MaxRequestsPerTcpConnection	(Direct/TCP) Contrôle le nombre de requêtes autorisées simultanément sur une seule connexion TCP. Lorsque d’autres requêtes sont en cours d’exécution simultanément, le client direct/TCP ouvre des connexions supplémentaires.
MaxRetryAttemptsOnRateLimitedRequests	Obtient ou définit le nombre maximal de nouvelles tentatives en cas d’échec de la demande, car le service Azure Cosmos DB a appliqué la limitation de débit sur le client.
MaxRetryWaitTimeOnRateLimitedRequests	Obtient ou définit la durée maximale des nouvelles tentatives en secondes pour le service Azure Cosmos DB.
MaxTcpConnectionsPerEndpoint	(Direct/TCP) Contrôle le nombre maximal de connexions TCP qui peuvent être ouvertes à chaque serveur principal Cosmos DB. Avec MaxRequestsPerTcpConnection, ce paramètre limite le nombre de requêtes envoyées simultanément à un seul back-end Cosmos DB (MaxRequestsPerTcpConnection x MaxTcpConnectionperEndpoint).
OpenTcpConnectionTimeout	(Direct/TCP) Contrôle le temps nécessaire pour tenter d’établir une connexion.
PortReuseMode	(Direct/TCP) Contrôle la stratégie de réutilisation du port client utilisée par la pile de transport.
RequestTimeout	Obtient le délai d’expiration de la requête en secondes lors de la connexion au service Azure Cosmos DB. Le nombre spécifie le délai d’attente pour que la réponse revienne de l’homologue réseau.
Serializer	Obtenez pour définir un sérialiseur JSON facultatif. Le client l’utilisera pour sérialiser ou désérialiser la demande/les réponses cosmos de l’utilisateur. Les types appartenant au Kit de développement logiciel (SDK), tels que DatabaseProperties et ContainerProperties, utilisent toujours le sérialiseur par défaut du SDK.
SerializerOptions	Obtenez pour définir des options de sérialiseur facultatives.
ServerCertificateCustomValidationCallback	Délégué de rappel pour effectuer la validation de certificat personnalisé pour HTTP et TCP.
TokenCredentialBackgroundRefreshInterval	Le Kit de développement logiciel (SDK) effectue une actualisation en arrière-plan en fonction de l’intervalle de temps défini pour actualiser les informations d’identification du jeton. Cela évite les problèmes de latence, car l’ancien jeton est utilisé jusqu’à ce que le nouveau jeton soit récupéré.
WebProxy	(Passerelle/https) Obtenez ou définissez les informations de proxy utilisées pour les requêtes web.