CosmosClient.CreateAndInitializeAsync Método

Definición

Sobrecargas

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

Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

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

Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y AzureKeyCredential. AzureKeyCredential permite cambiar o actualizar master-key/ResourceToken mientras CosmosClient todavía está en uso.

Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

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

Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

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

Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

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

Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

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

La cadena de conexión a la cuenta de Cosmos. por ejemplo: AccountEndpoint=https://XXXXX.documents.azure.com:443/; AccountKey=SuperSecretKey;

containers
IReadOnlyList<ValueTuple<String,String>>

Los contenedores que se van a inicializar se identifican por el nombre de la base de datos y el nombre del contenedor.

cosmosClientOptions
CosmosClientOptions

(Opcional) opciones de cliente

cancellationToken
CancellationToken

(Opcional) Token de cancelación

Devoluciones

Objeto CosmosClient.

Ejemplos

CosmosClient se crea con los contenedores ConnectionString y 2 de la cuenta se inicializan.

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

Se aplica a

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

Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y AzureKeyCredential. AzureKeyCredential permite cambiar o actualizar master-key/ResourceToken mientras CosmosClient todavía está en uso.

Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

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

Punto de conexión de servicio de Cosmos que se va a usar

authKeyOrResourceTokenCredential
AzureKeyCredential

AzureKeyCredential con clave maestra o token de recurso.

containers
IReadOnlyList<ValueTuple<String,String>>

Los contenedores que se van a inicializar se identifican por el nombre de la base de datos y el nombre del contenedor.

cosmosClientOptions
CosmosClientOptions

(Opcional) opciones de cliente

cancellationToken
CancellationToken

(Opcional) Token de cancelación

Devoluciones

Objeto CosmosClient.

Ejemplos

CosmosClient se crea con los contenedores AccountEndpoint, AccountKey o ResourceToken y 2 de la cuenta se inicializan.

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

Comentarios

AzureKeyCredential permite cambiar o actualizar master-key/ResourceToken whle CosmosClient todavía está en uso.

Se aplica a

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

Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

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

Punto de conexión de servicio de Cosmos que se va a usar.

tokenCredential
TokenCredential

TokenCredentialToken para proporcionar el token de AAD para la autorización.

containers
IReadOnlyList<ValueTuple<String,String>>

Los contenedores que se van a inicializar se identifican por el nombre de la base de datos y el nombre del contenedor.

cosmosClientOptions
CosmosClientOptions

(Opcional) opciones de cliente

cancellationToken
CancellationToken

(Opcional) Token de cancelación

Devoluciones

Objeto CosmosClient.

Se aplica a

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

Crea un nuevo CosmosClient con la cadena de URI del punto de conexión de la cuenta y TokenCredential. Además de que inicializa el cliente con contenedores proporcionados, es decir, el SDK prepara las memorias caché y las conexiones antes de realizar la primera llamada al servicio. Úselo para obtener una latencia menor durante el inicio de la aplicación. CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

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

Punto de conexión de servicio de Cosmos que se va a usar

authKeyOrResourceToken
String

Clave de cuenta de Cosmos o token de recurso que se va a usar para crear el cliente.

containers
IReadOnlyList<ValueTuple<String,String>>

Los contenedores que se van a inicializar se identifican por el nombre de la base de datos y el nombre del contenedor.

cosmosClientOptions
CosmosClientOptions

(Opcional) opciones de cliente

cancellationToken
CancellationToken

(Opcional) Token de cancelación

Devoluciones

Objeto CosmosClient.

Ejemplos

CosmosClient se crea con los contenedores AccountEndpoint, AccountKey o ResourceToken y 2 de la cuenta se inicializan.

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

Comentarios

La referencia devuelta no garantiza credenciales ni validaciones de conectividad porque la inicialización no realiza ninguna llamada de red.

Se aplica a