CosmosClientOptions Classe

Definição

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Pacote:

Microsoft.Azure.Cosmos v3.36.0

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

public class CosmosClientOptions

type CosmosClientOptions = class

Public Class CosmosClientOptions

Herança

Object

CosmosClientOptions

Exemplos

Um exemplo de como configurar a opção de serialização para ignorar valores nulos.

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

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

Construtores

CosmosClientOptions()

Cria um novo CosmosClientOptions

Propriedades

AllowBulkExecution	Permite o envio em lote otimista de solicitações para o serviço. Definir essa opção pode afetar a latência das operações. Portanto, essa opção é recomendada apenas para cenários sensíveis à não latência.
ApplicationName	Obtenha ou defina o sufixo de agente do usuário para incluir com cada interação de serviço do Azure Cosmos DB.
ApplicationPreferredRegions	Obtém e define as regiões preferenciais para contas de banco de dados replicadas geograficamente no serviço do Azure Cosmos DB.
ApplicationRegion	Obtém ou define o local em que o aplicativo está em execução. Isso influenciará a escolha do SDK para a interação do 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.
CosmosClientTelemetryOptions	Obtém ou define opções de telemetria do cliente, como sinalizadores de recursos e opções correspondentes
CustomHandlers	Obtém os manipuladores executados antes do processo
EnableContentResponseOnWrite	Obtém ou define o booliano para retornar apenas os cabeçalhos e status código na resposta do Cosmos DB para a operação de item de gravação, como Criar, Upsert, Patch e Substituir. Definir a opção como false fará com que a resposta tenha um recurso nulo. Isso reduz a carga de rede e CPU, não enviando o recurso de volta pela rede e serializando-o no cliente.
EnableTcpConnectionEndpointRediscovery	Obtém ou define o sinalizador para habilitar a atualização do cache de endereços na notificação de redefinição de conexão TCP.
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.
HttpClientFactory	Obtém ou define um delegado a ser usado para obter uma instância HttpClient a ser usada para comunicação HTTPS.
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	Obtém ou define o número máximo de repetições no caso em que a solicitação falha porque o serviço do Azure Cosmos DB aplicou limitação de taxa ao cliente.
MaxRetryWaitTimeOnRateLimitedRequests	Obtém ou define o tempo máximo de repetição em segundos para o serviço do Azure Cosmos DB.
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 o MaxRequestsPerTcpConnection, essa configuração limita o número de solicitações que são enviadas simultaneamente para 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.
PortReuseMode	(Direto/TCP) Controla a política de reutilização de porta do cliente usada pela pilha de transporte.
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.
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.
ServerCertificateCustomValidationCallback	Um delegado de retorno de chamada para fazer a validação de certificado personalizado para HTTP e TCP.
TokenCredentialBackgroundRefreshInterval	O SDK faz uma atualização em segundo plano com base no intervalo de tempo definido para atualizar as credenciais do token. Isso evita problemas de latência porque o token antigo é usado até que o novo token seja recuperado.
WebProxy	(Gateway/Https) Obtenha ou defina as informações de proxy usadas para solicitações da Web.