CosmosClient.CreateAndInitializeAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.36.0

Surcharges

CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et TokenCredential. En outre, il initialise le client avec les conteneurs fournis, c’est-à-dire que le KIT de développement logiciel (SDK) réchauffe les caches et les connexions avant que le premier appel au service ne soit effectué. Utilisez cette option pour obtenir une latence plus faible au démarrage de votre application. CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances. Reportez-vous au guide des performances.
CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et AzureKeyCredential. AzureKeyCredential permet de modifier/mettre à jour master-key/ResourceToken pendant que CosmosClient est toujours utilisé. En outre, il initialise le client avec les conteneurs fournis, c’est-à-dire que le KIT de développement logiciel (SDK) réchauffe les caches et les connexions avant que le premier appel au service ne soit effectué. Utilisez cette option pour obtenir une latence plus faible au démarrage de votre application. CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances. Reportez-vous au guide des performances.
CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et TokenCredential. En outre, il initialise le client avec les conteneurs fournis, c’est-à-dire que le KIT de développement logiciel (SDK) réchauffe les caches et les connexions avant que le premier appel au service ne soit effectué. Utilisez cette option pour obtenir une latence plus faible au démarrage de votre application. CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances. Reportez-vous au guide des performances.
CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et TokenCredential. En outre, il initialise le client avec les conteneurs fournis, c’est-à-dire que le KIT de développement logiciel (SDK) réchauffe les caches et les connexions avant que le premier appel au service ne soit effectué. Utilisez cette option pour obtenir une latence plus faible au démarrage de votre application. CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances. Reportez-vous au guide des performances.

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

Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et TokenCredential. En outre, il initialise le client avec les conteneurs fournis, c’est-à-dire que le KIT de développement logiciel (SDK) réchauffe les caches et les connexions avant que le premier appel au service ne soit effectué. Utilisez cette option pour obtenir une latence plus faible au démarrage de votre application. CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances. Reportez-vous au guide des performances.

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)

Paramètres

connectionString

String

Le chaîne de connexion au compte cosmos. ex : AccountEndpoint=https://XXXXX.documents.azure.com:443/ ; AccountKey=SuperSecretKey ;

containers

IReadOnlyList<ValueTuple<String,String>>

Conteneurs à initialiser identifiés par son nom de base de données et son nom de conteneur.

cosmosClientOptions

CosmosClientOptions

Options clientes (facultatives)

cancellationToken

CancellationToken

(Facultatif) Jeton d’annulation

Retours

Task<CosmosClient>

Objet CosmosClient.

Exemples

CosmosClient est créé avec connectionString et 2 conteneurs dans le compte sont initialisés

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

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

Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et AzureKeyCredential. AzureKeyCredential permet de modifier/mettre à jour master-key/ResourceToken pendant que CosmosClient est toujours utilisé.

En outre, il initialise le client avec les conteneurs fournis, c’est-à-dire que le KIT de développement logiciel (SDK) réchauffe les caches et les connexions avant que le premier appel au service ne soit effectué. Utilisez cette option pour obtenir une latence plus faible au démarrage de votre application. CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances. Reportez-vous au guide des performances.

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)

Paramètres

accountEndpoint

String

Point de terminaison de service Cosmos à utiliser

authKeyOrResourceTokenCredential

AzureKeyCredential

AzureKeyCredential avec master clé ou jeton de ressource.

containers

IReadOnlyList<ValueTuple<String,String>>

Conteneurs à initialiser identifiés par son nom de base de données et son nom de conteneur.

cosmosClientOptions

CosmosClientOptions

Options clientes (facultatives)

cancellationToken

CancellationToken

(Facultatif) Jeton d’annulation

Retours

Task<CosmosClient>

Objet CosmosClient.

Exemples

CosmosClient est créé avec les conteneurs AccountEndpoint, AccountKey ou ResourceToken, et 2 conteneurs dans le compte sont initialisés

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

Remarques

AzureKeyCredential permet de modifier/mettre à jour master-key/ResourceToken lorsque CosmosClient est toujours en cours d’utilisation.

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

Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et TokenCredential. En outre, il initialise le client avec les conteneurs fournis, c’est-à-dire que le KIT de développement logiciel (SDK) réchauffe les caches et les connexions avant que le premier appel au service ne soit effectué. Utilisez cette option pour obtenir une latence plus faible au démarrage de votre application. CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances. Reportez-vous au guide des performances.

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)

Paramètres

accountEndpoint

String

Point de terminaison de service Cosmos à utiliser.

tokenCredential

TokenCredential

TokenCredentialJeton permettant de fournir un jeton AAD pour l’autorisation.

containers

IReadOnlyList<ValueTuple<String,String>>

Conteneurs à initialiser identifiés par son nom de base de données et son nom de conteneur.

cosmosClientOptions

CosmosClientOptions

Options clientes (facultatives)

cancellationToken

CancellationToken

(Facultatif) Jeton d’annulation

Retours

Task<CosmosClient>

Objet CosmosClient.

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

Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et TokenCredential. En outre, il initialise le client avec les conteneurs fournis, c’est-à-dire que le KIT de développement logiciel (SDK) réchauffe les caches et les connexions avant que le premier appel au service ne soit effectué. Utilisez cette option pour obtenir une latence plus faible au démarrage de votre application. CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion efficace des connexions et des performances. Reportez-vous au guide des performances.

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)

Paramètres

accountEndpoint

String

Point de terminaison de service Cosmos à utiliser

authKeyOrResourceToken

String

Clé de compte cosmos ou jeton de ressource à utiliser pour créer le client.

containers

IReadOnlyList<ValueTuple<String,String>>

Conteneurs à initialiser identifiés par son nom de base de données et son nom de conteneur.

cosmosClientOptions

CosmosClientOptions

Options clientes (facultatives)

cancellationToken

CancellationToken

(Facultatif) Jeton d’annulation

Retours

Task<CosmosClient>

Objet CosmosClient.

Exemples

CosmosClient est créé avec les conteneurs AccountEndpoint, AccountKey ou ResourceToken, et 2 conteneurs dans le compte sont initialisés

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

Remarques

La référence retournée ne garantit pas les validations d’informations d’identification ou de connectivité, car l’initialisation n’effectue aucun appel réseau.