CosmosClientBuilder Classe
Definição
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.
Essa é uma classe do Construtor que cria um cliente cosmos
public class CosmosClientBuilder
type CosmosClientBuilder = class
Public Class CosmosClientBuilder
- Herança
-
CosmosClientBuilder
Construtores
CosmosClientBuilder(String) |
Extrai o ponto de extremidade e a chave da conta do cadeia de conexão. |
CosmosClientBuilder(String, AzureKeyCredential) |
Inicialize uma nova classe CosmosConfiguration que contém todas as propriedades que o CosmosClient requer com a cadeia de caracteres de URI do ponto de extremidade da conta e AzureKeyCredential. O AzureKeyCredential permite alterar/atualizar master-key/ResourceToken enquanto o CosmosClient ainda está em uso. |
CosmosClientBuilder(String, String) |
Inicialize uma nova classe CosmosConfiguration que contém todas as propriedades necessárias pelo CosmosClient. |
CosmosClientBuilder(String, TokenCredential) |
Inicializa um novo CosmosClientBuilder com uma TokenCredential instância. |
Métodos
AddCustomHandlers(RequestHandler[]) |
Define uma matriz de manipuladores personalizados para a solicitação. Os manipuladores serão encadeados na ordem listada. O InvokerHandler.InnerHandler é necessário para ser nulo para permitir que o pipeline encadeie os manipuladores. |
Build() |
Um método para criar o cosmos client CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho. |
BuildAndInitializeAsync(IReadOnlyList<ValueTuple<String,String>>, CancellationToken) |
Um método para criar o cliente cosmos e inicializar os contêineres fornecidos. Além disso, inicializa o cliente com contêineres fornecidos, ou seja, o SDK aquece os caches e as conexões antes que a primeira chamada para o serviço seja feita. Use isso para obter menor latência durante a inicialização do aplicativo. O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho. |
WithApplicationName(String) |
Um sufixo a ser adicionado ao agente de usuário padrão para o serviço do Azure Cosmos DB. |
WithApplicationPreferredRegions(IReadOnlyList<String>) |
Defina as regiões preferenciais para contas de banco de dados replicadas geograficamente no serviço do Azure Cosmos DB. |
WithApplicationRegion(String) |
Defina a região replicada geograficamente preferencial para ser usada no serviço do Azure Cosmos DB. |
WithBulkExecution(Boolean) |
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. |
WithClientTelemetryOptions(CosmosClientTelemetryOptions) |
Para habilitar recursos de telemetria com opções correspondentes |
WithConnectionModeDirect() |
Define o modo de conexão como Direct. Isso é usado pelo cliente ao se conectar ao serviço do Azure Cosmos DB. |
WithConnectionModeDirect(Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>, Nullable<PortReuseMode>, Nullable<Boolean>) |
Define o modo de conexão como Direct. Isso é usado pelo cliente ao se conectar ao serviço do Azure Cosmos DB. |
WithConnectionModeGateway(Nullable<Int32>, IWebProxy) |
Define o modo de conexão como Gateway. Isso é usado pelo cliente ao se conectar ao serviço do Azure Cosmos DB. |
WithConsistencyLevel(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. |
WithContentResponseOnWrite(Boolean) |
Obtém ou define o booliano para retornar apenas os cabeçalhos e status código na resposta do Cosmos DB para 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 rede e a carga da CPU, não enviando o recurso de volta pela rede e serializando-o no cliente. |
WithCustomSerializer(CosmosSerializer) |
Defina um serializador JSON personalizado. |
WithHttpClientFactory(Func<HttpClient>) |
Define um delegado a ser usado para obter uma instância httpClient a ser usada para comunicação HTTPS. |
WithLimitToEndpoint(Boolean) |
Limita as operações ao ponto de extremidade fornecido no construtor CosmosClientBuilder. |
WithRequestTimeout(TimeSpan) |
Define o tempo limite da solicitação em segundos ao se conectar ao serviço do Azure Cosmos DB. |
WithSerializerOptions(CosmosSerializationOptions) |
Defina uma opção de serializador personalizado. |
WithThrottlingRetryOptions(TimeSpan, Int32) |
Define o tempo máximo de espera entre a repetição e o número máximo de vezes para tentar novamente em solicitações limitadas. |
Aplica-se a
Azure SDK for .NET