CosmosClient.CreateAndInitializeAsync Método

Referência

Definição

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Pacote:: Microsoft.Azure.Cosmos v3.36.0

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.

Sobrecargas

CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential. 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.
CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Cria um novo CosmosClient 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. 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.
CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential. 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.
CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential. 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.

CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential. 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.

public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string connectionString, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member CreateAndInitializeAsync : string * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>

Public Shared Function CreateAndInitializeAsync (connectionString As String, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)

Parâmetros

connectionString: String

O cadeia de conexão para a conta do Cosmos. ex: AccountEndpoint=https://XXXXX.documents.azure.com:443/; AccountKey=SuperSecretKey;

containers: IReadOnlyList<ValueTuple<String,String>>

Contêineres a serem inicializados identificados pelo nome do banco de dados e pelo nome do contêiner.

cosmosClientOptions: CosmosClientOptions

Opções de cliente (opcional)

cancellationToken: CancellationToken

(Opcional) Token de cancelamento

Retornos

Task<CosmosClient>

Um objeto CosmosClient.

Exemplos

O CosmosClient é criado com o ConnectionString e dois contêineres na conta são inicializados

using Microsoft.Azure.Cosmos;
List<(string, string)> containersToInitialize = new List<(string, string)>
{ ("DatabaseName1", "ContainerName1"), ("DatabaseName2", "ContainerName2") };

CosmosClient cosmosClient = await CosmosClient.CreateAndInitializeAsync("connection-string-from-portal",
                                                                        containersToInitialize)

// Dispose cosmosClient at application exit

Aplica-se a

CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

Cria um novo CosmosClient 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.

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.

public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string accountEndpoint, Azure.AzureKeyCredential authKeyOrResourceTokenCredential, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member CreateAndInitializeAsync : string * Azure.AzureKeyCredential * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>

Public Shared Function CreateAndInitializeAsync (accountEndpoint As String, authKeyOrResourceTokenCredential As AzureKeyCredential, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)

Parâmetros

accountEndpoint: String

O ponto de extremidade de serviço do Cosmos a ser usado

authKeyOrResourceTokenCredential: AzureKeyCredential

AzureKeyCredential com master chave ou token de recurso.

containers: IReadOnlyList<ValueTuple<String,String>>

Contêineres a serem inicializados identificados pelo nome do banco de dados e pelo nome do contêiner.

cosmosClientOptions: CosmosClientOptions

Opções de cliente (opcional)

cancellationToken: CancellationToken

(Opcional) Token de cancelamento

Retornos

Task<CosmosClient>

Um objeto CosmosClient.

Exemplos

O CosmosClient é criado com os contêineres AccountEndpoint, AccountKey ou ResourceToken e 2 na conta são inicializados

using Microsoft.Azure.Cosmos;
List<(string, string)> containersToInitialize = new List<(string, string)>
{ ("DatabaseName1", "ContainerName1"), ("DatabaseName2", "ContainerName2") };

AzureKeyCredential keyCredential = new AzureKeyCredential("account-master-key/ResourceToken");
CosmosClient cosmosClient = await CosmosClient.CreateAndInitializeAsync("account-endpoint-from-portal", 
                                                                        keyCredential,
                                                                        containersToInitialize)

....

// To udpate key/credentials 
keyCredential.Update("updated master-key/ResourceToken");

// Dispose cosmosClient at application exit

Comentários

O AzureKeyCredential permite alterar/atualizar master-key/ResourceToken whle CosmosClient ainda está em uso.

Aplica-se a

CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string accountEndpoint, Azure.Core.TokenCredential tokenCredential, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member CreateAndInitializeAsync : string * Azure.Core.TokenCredential * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>

Public Shared Function CreateAndInitializeAsync (accountEndpoint As String, tokenCredential As TokenCredential, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)

Parâmetros

accountEndpoint: String

O ponto de extremidade de serviço cosmos a ser usado.

tokenCredential: TokenCredential

TokenCredentialO token para fornecer o token do AAD para autorização.

containers: IReadOnlyList<ValueTuple<String,String>>

Contêineres a serem inicializados identificados pelo nome do banco de dados e pelo nome do contêiner.

cosmosClientOptions: CosmosClientOptions

Opções de cliente (opcional)

cancellationToken: CancellationToken

(Opcional) Token de cancelamento

Retornos

Task<CosmosClient>

Um objeto CosmosClient.

Aplica-se a

CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential. 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, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.

public static System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient> CreateAndInitializeAsync (string accountEndpoint, string authKeyOrResourceToken, System.Collections.Generic.IReadOnlyList<(string databaseId, string containerId)> containers, Microsoft.Azure.Cosmos.CosmosClientOptions cosmosClientOptions = default, System.Threading.CancellationToken cancellationToken = default);

static member CreateAndInitializeAsync : string * string * System.Collections.Generic.IReadOnlyList<ValueTuple<string, string>> * Microsoft.Azure.Cosmos.CosmosClientOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.CosmosClient>

Public Shared Function CreateAndInitializeAsync (accountEndpoint As String, authKeyOrResourceToken As String, containers As IReadOnlyList(Of ValueTuple(Of String, String)), Optional cosmosClientOptions As CosmosClientOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CosmosClient)

Parâmetros

accountEndpoint: String

O ponto de extremidade de serviço do Cosmos a ser usado

authKeyOrResourceToken: String

A chave da conta cosmos ou o token de recurso a ser usado para criar o cliente.

containers: IReadOnlyList<ValueTuple<String,String>>

Contêineres a serem inicializados identificados pelo nome do banco de dados e pelo nome do contêiner.

cosmosClientOptions: CosmosClientOptions

Opções de cliente (opcional)

cancellationToken: CancellationToken

(Opcional) Token de cancelamento

Retornos

Task<CosmosClient>

Um objeto CosmosClient.

Exemplos

O CosmosClient é criado com os contêineres AccountEndpoint, AccountKey ou ResourceToken e 2 na conta são inicializados

using Microsoft.Azure.Cosmos;
List<(string, string)> containersToInitialize = new List<(string, string)>
{ ("DatabaseName1", "ContainerName1"), ("DatabaseName2", "ContainerName2") };

CosmosClient cosmosClient = await CosmosClient.CreateAndInitializeAsync("account-endpoint-from-portal", 
                                                                        "account-key-from-portal",
                                                                        containersToInitialize)

// Dispose cosmosClient at application exit

Comentários

A referência retornada não garante credenciais ou validações de conectividade porque a inicialização não faz chamadas de rede.

Aplica-se a

Compartilhar via

CosmosClient.CreateAndInitializeAsync Método

Definição

Sobrecargas

CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

Parâmetros

Retornos

Exemplos

Aplica-se a

CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

Parâmetros

Retornos

Exemplos

Comentários

Aplica-se a

CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

Parâmetros

Retornos

Aplica-se a

CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)

Parâmetros

Retornos

Exemplos

Comentários

Aplica-se a

Recursos adicionais