CosmosClientOptions Classe

Définition

Espace de noms:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Paquet:

Azure.Cosmos v4.0.0-preview3

Définit toutes les options configurables requises par 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

Héritage

Object

ClientOptions

CosmosClientOptions

Attributs

JsonConverterAttribute

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, };

Client CosmosClient = new CosmosClient(« endpoint », « key », clientOptions);

Constructeurs

CosmosClientOptions()

Crée un cosmosClientOptions

Propriétés

ApplicationName	Obtenez ou définissez le suffixe user-agent à inclure dans chaque interaction de service Azure Cosmos DB.
ApplicationRegion	Obtenez ou définissez la région géorépliquée par défaut à utiliser 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.
Diagnostics	Obtient les options de diagnostic du client. (Hérité de ClientOptions)
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.
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	Obtenez ou définissez le nombre de fois où le client doit réessayer sur les demandes limitées au débit.
MaxRetryWaitTimeOnRateLimitedRequests	Obtenir ou définir la durée maximale du client est autorisé à réessayer sur le débit des requêtes limitées.
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.
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.
Retry	Obtient les options de nouvelle tentative du client. (Hérité de ClientOptions)
RetryPolicy	Obtient ou définit la stratégie à utiliser pour les nouvelles tentatives. Si une stratégie est spécifiée, elle sera utilisée à la place de la Retry propriété . Le RetryPolicy type peut être dérivé de pour modifier le comportement par défaut sans avoir à implémenter entièrement la logique de nouvelle tentative. Si Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) est remplacé ou si un personnalisé HttpPipelinePolicy est spécifié, il incombe à l’implémenteur de mettre à jour les ProcessingContext valeurs. (Hérité de ClientOptions)
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.
Transport	HttpPipelineTransport à utiliser pour ce client. Par défaut, un instance de HttpClientTransport. (Hérité de ClientOptions)
WebProxy	(Passerelle/https) Obtenez ou définissez les informations de proxy utilisées pour les requêtes web.

Méthodes

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Ajoute une HttpPipeline stratégie dans le pipeline client. La position de la stratégie dans le pipeline est contrôlée par le position paramètre . Si vous souhaitez que la stratégie s’exécute une fois par requête client, utilisez PerCallPerRetry sinon pour exécuter la stratégie pour chaque nouvelle tentative. Notez que le même instance de policy serait ajouté à tous les pipelines du client construits à l’aide de cet ClientOptions objet. (Hérité de ClientOptions)