CosmosClient Constructeurs

Définition

Espace de noms:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.36.0

Surcharges

CosmosClient()	Créer un cosmosClient utilisé pour les tests fictifs
CosmosClient(String, CosmosClientOptions)	Crée un cosmosClient avec le chaîne de connexion. 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 et des performances efficaces des connexions. Reportez-vous au guide de performances.
CosmosClient(String, AzureKeyCredential, CosmosClientOptions)	Crée un cosmosClient avec la chaîne URI du point de terminaison de compte et AzureKeyCredential. AzureKeyCredential permet de modifier/mettre à jour master-key/ResourceToken pendant que CosmosClient est toujours en cours d’utilisation. 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 et des performances efficaces des connexions. Reportez-vous au guide de performances.
CosmosClient(String, TokenCredential, CosmosClientOptions)	Crée un CosmosClient avec la chaîne d’URI du point de terminaison de compte et TokenCredential. 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 et des performances efficaces des connexions. Reportez-vous au guide de performances.
CosmosClient(String, String, CosmosClientOptions)	Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et la clé de compte. 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 et des performances efficaces des connexions. Reportez-vous au guide de performances.

CosmosClient()

Créer un cosmosClient utilisé pour les tests fictifs

protected CosmosClient ();

Protected Sub New ()

CosmosClient(String, CosmosClientOptions)

Crée un cosmosClient avec le chaîne de connexion.

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 et des performances efficaces des connexions. Reportez-vous au guide de performances.

public CosmosClient (string connectionString, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (connectionString As String, Optional clientOptions As CosmosClientOptions = Nothing)

Paramètres

connectionString

String

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

clientOptions

CosmosClientOptions

Options clientes (facultatives)

Exemples

CosmosClient est créé avec le chaîne de connexion et configuré pour utiliser la région « USA Est 2 ».

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            "account-key-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

// Dispose cosmosClient at application exit

Remarques

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

Voir aussi

• CosmosClientBuilder
• CosmosClientOptions

CosmosClient(String, AzureKeyCredential, CosmosClientOptions)

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

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 et des performances efficaces des connexions. Reportez-vous au guide de performances.

public CosmosClient (string accountEndpoint, Azure.AzureKeyCredential authKeyOrResourceTokenCredential, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * Azure.AzureKeyCredential * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (accountEndpoint As String, authKeyOrResourceTokenCredential As AzureKeyCredential, Optional clientOptions As CosmosClientOptions = Nothing)

Paramètres

accountEndpoint

String

Point de terminaison de service cosmos à utiliser

authKeyOrResourceTokenCredential

AzureKeyCredential

AzureKeyCredential avec master clé ou jeton de ressource.

clientOptions

CosmosClientOptions

Options clientes (facultatives)

Exemples

CosmosClient est créé avec la région AccountEndpoint, AccountKey ou ResourceToken et configuré pour utiliser la région « USA Est 2 ».

using Microsoft.Azure.Cosmos;

AzureKeyCredential keyCredential = new AzureKeyCredential("account-master-key/ResourceToken");
CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            keyCredential, 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

....

// 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 whle CosmosClient est toujours en cours d’utilisation. La référence retournée ne garantit pas les informations d’identification ou les validations de connectivité, car la création n’effectue aucun appel réseau.

Voir aussi

• CosmosClientBuilder
• CosmosClientOptions

CosmosClient(String, TokenCredential, CosmosClientOptions)

Crée un CosmosClient avec la chaîne d’URI du point de terminaison de compte et TokenCredential.

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 et des performances efficaces des connexions. Reportez-vous au guide de performances.

public CosmosClient (string accountEndpoint, Azure.Core.TokenCredential tokenCredential, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * Azure.Core.TokenCredential * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (accountEndpoint As String, tokenCredential As TokenCredential, Optional clientOptions As CosmosClientOptions = Nothing)

Paramètres

accountEndpoint

String

Point de terminaison de service cosmos à utiliser.

tokenCredential

TokenCredential

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

clientOptions

CosmosClientOptions

Options clientes (facultatives)

Remarques

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

CosmosClient(String, String, CosmosClientOptions)

Crée un cosmosClient avec la chaîne d’URI du point de terminaison de compte et la clé de compte.

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 et des performances efficaces des connexions. Reportez-vous au guide de performances.

public CosmosClient (string accountEndpoint, string authKeyOrResourceToken, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * string * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (accountEndpoint As String, authKeyOrResourceToken As String, Optional clientOptions As CosmosClientOptions = Nothing)

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.

clientOptions

CosmosClientOptions

Options clientes (facultatives)

Exemples

CosmosClient est créé avec la région AccountEndpoint, AccountKey ou ResourceToken et configuré pour utiliser la région « USA Est 2 ».

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            "account-key-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

// Dispose cosmosClient at application exit

Remarques

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

Voir aussi

• CosmosClientBuilder
• CosmosClientOptions