CosmosClientOptions Classe

Referência

Definição

Namespace:: Azure.Cosmos

Assembly:: Azure.Cosmos.dll

Pacote:: Azure.Cosmos v4.0.0-preview3

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Define todas as opções configuráveis que o CosmosClient requer.

[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

Herança: Object

ClientOptions
CosmosClientOptions

Atributos: JsonConverterAttribute

Exemplos

Um exemplo sobre como configurar a opção de serialização para ignorar valores nulos CosmosClientOptions clientOptions = new CosmosClientOptions() { SerializerOptions = new CosmosSerializationOptions(){ IgnoreNullValues = true }, ConnectionMode = ConnectionMode.Gateway, };

Cliente CosmosClient = novo CosmosClient("endpoint", "key", clientOptions);

Construtores

CosmosClientOptions()

Cria um novo CosmosClientOptions

Propriedades

ApplicationName	Obtenha ou defina o sufixo de agente do usuário para incluir com cada interação de serviço do Azure Cosmos DB.
ApplicationRegion	Obtenha ou defina a região de replicação geográfica preferencial a ser usada para interação de serviço do Azure Cosmos DB.
ConnectionMode	Obtenha ou defina o modo de conexão usado pelo cliente ao se conectar ao serviço do Azure Cosmos DB.
ConsistencyLevel	Isso pode ser usado para enfraquecer o nível de consistência da conta de banco de dados para operações de leitura. Se isso não for definido, o nível de consistência da conta de banco de dados será usado para todas as solicitações.
Diagnostics	Obtém as opções de diagnóstico do cliente. (Herdado de ClientOptions)
GatewayModeMaxConnectionLimit	Obtenha ou defina o número máximo de conexões simultâneas permitidas para o ponto de extremidade de serviço de destino no serviço do Azure Cosmos DB.
IdleTcpConnectionTimeout	(Direto/TCP) Controla a quantidade de tempo ocioso após o qual as conexões não utilizados são fechadas.
LimitToEndpoint	Limita as operações ao ponto de extremidade fornecido no CosmosClient.
MaxRequestsPerTcpConnection	(Direto/TCP) Controla o número de solicitações permitidas simultaneamente em uma única conexão TCP. Quando mais solicitações estiverem em andamento simultaneamente, o cliente direto/TCP abrirá conexões adicionais.
MaxRetryAttemptsOnRateLimitedRequests	Obtenha ou defina o número de vezes que o cliente deve tentar novamente em solicitações limitadas por taxa.
MaxRetryWaitTimeOnRateLimitedRequests	Obter ou definir o tempo máximo para o cliente tem permissão para tentar novamente em solicitações limitadas por taxa.
MaxTcpConnectionsPerEndpoint	(Direto/TCP) Controla o número máximo de conexões TCP que podem ser abertas para cada back-end do Cosmos DB. Junto com MaxRequestsPerTcpConnection, essa configuração limita o número de solicitações que são enviadas simultaneamente a um único back-end do Cosmos DB (MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint).
OpenTcpConnectionTimeout	(Direto/TCP) Controla a quantidade de tempo permitida para tentar estabelecer uma conexão.
RequestTimeout	Obtém o tempo limite da solicitação em segundos ao se conectar ao serviço do Azure Cosmos DB. O número especifica o tempo de espera para que a resposta volte do par de rede.
Retry	Obtém as opções de repetição do cliente. (Herdado de ClientOptions)
RetryPolicy	Obtém ou define a política a ser usada para novas tentativas. Se uma política for especificada, ela será usada no lugar da Retry propriedade . O RetryPolicy tipo pode ser derivado de para modificar o comportamento padrão sem a necessidade de implementar totalmente a lógica de repetição. Se Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) for substituído ou um personalizado HttpPipelinePolicy for especificado, será responsabilidade do implementador atualizar os ProcessingContext valores. (Herdado de ClientOptions)
Serializer	Obtenha para definir um serializador JSON opcional. O cliente o usará para serializar ou desserializar as solicitações/respostas do cosmos do usuário. Tipos de propriedade do SDK, como DatabaseProperties e ContainerProperties, sempre usarão o serializador padrão do SDK.
SerializerOptions	Obtenha para definir opções opções opcionais de serializador.
Transport	O HttpPipelineTransport a ser usado para este cliente. O padrão é uma instância do HttpClientTransport. (Herdado de ClientOptions)
WebProxy	(Gateway/Https) Obtenha ou defina as informações de proxy usadas para solicitações da Web.

Métodos

AddPolicy(HttpPipelinePolicy, HttpPipelinePosition)

Adiciona uma HttpPipeline política ao pipeline do cliente. A posição da política no pipeline é controlada pelo position parâmetro . Se você quiser que a política seja executada uma vez por solicitação de cliente, use PerCall caso contrário, use PerRetry para executar a política para cada repetição. Observe que a mesma instância de policy seria adicionada a todos os pipelines do cliente construídos usando esse ClientOptions objeto .

(Herdado de ClientOptions)

Aplica-se a

Compartilhar via