CosmosClient Classe

Définition

Espace de noms:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Paquet:

Microsoft.Azure.Cosmos v3.39.0

Source:

CosmosClient.cs

Fournit une représentation logique côté client du compte Azure Cosmos DB. Ce client peut être utilisé pour configurer et exécuter des requêtes dans le service de base de données Azure Cosmos DB.

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 class CosmosClient : IDisposable

type CosmosClient = class
    interface IDisposable

Public Class CosmosClient
Implements IDisposable

Héritage

Object

CosmosClient

Implémente

IDisposable

Exemples

Cet exemple crée un CosmosClient, Databaseet un Container. 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(
            "connection-string-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

Cet exemple crée un CosmosClient, Databaseet un Container. 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,
            });

Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

Cet exemple crée un CosmosClient, Databaseet un Container. CosmosClient est créé via le modèle de générateur à l’aide de CosmosClientBuilder.

using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.Fluent;

CosmosClient cosmosClient = new CosmosClientBuilder("connection-string-from-portal")
    .WithApplicationRegion("East US 2")
    .Build();

Database db = await cosmosClient.CreateDatabaseAsync("database-id")
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

Remarques

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

Constructeurs

CosmosClient()	Créer un cosmosClient utilisé pour les tests fictifs
CosmosClient(String, AzureKeyCredential, CosmosClientOptions)	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é. 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.
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 efficace des connexions et des performances. Reportez-vous au guide des 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 efficace des connexions et des performances. Reportez-vous au guide des 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 efficace des connexions et des performances. Reportez-vous au guide des performances.

Propriétés

ClientOptions	Le CosmosClientOptions utilisé initialise CosmosClient.
Endpoint	Obtient l’URI de point de terminaison pour le service Azure Cosmos DB.
ResponseFactory	Fabrique de réponse utilisée pour créer des types de réponse CosmosClient.

Méthodes

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, 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, 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.
CreateDatabaseAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	Envoie une demande de création d’une base de données. Une base de données gère les utilisateurs, les autorisations et un ensemble de conteneurs. Chaque compte de base de données Azure Cosmos DB peut prendre en charge plusieurs bases de données nommées indépendantes, la base de données étant le conteneur logique pour les données. Chaque base de données se compose d’un ou plusieurs conteneurs, chacun contenant à son tour un ou plusieurs documents. Étant donné que les bases de données sont une ressource d’administration, la clé principale de service est nécessaire pour accéder à toute action et y parvenir à l’aide des API utilisateur.
CreateDatabaseAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	Envoie une demande de création d’une base de données. Une base de données gère les utilisateurs, les autorisations et un ensemble de conteneurs. Chaque compte de base de données Azure Cosmos DB peut prendre en charge plusieurs bases de données nommées indépendantes, la base de données étant le conteneur logique pour les données. Chaque base de données se compose d’un ou plusieurs conteneurs, chacun contenant à son tour un ou plusieurs documents. Étant donné que les bases de données sont une ressource d’administration, la clé principale de service est nécessaire pour accéder à toute action et y parvenir à l’aide des API utilisateur.
CreateDatabaseIfNotExistsAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	Vérifiez si une base de données existe et, si ce n’est pas le cas, créez-la. Seul l’ID de base de données est utilisé pour vérifier s’il existe une base de données existante. D’autres propriétés de base de données, telles que le débit, ne sont pas validées et peuvent être différentes des propriétés passées. Une base de données gère les utilisateurs, les autorisations et un ensemble de conteneurs. Chaque compte de base de données Azure Cosmos DB peut prendre en charge plusieurs bases de données nommées indépendantes, la base de données étant le conteneur logique pour les données. Chaque base de données se compose d’un ou plusieurs conteneurs, chacun contenant à son tour un ou plusieurs documents. Étant donné que les bases de données sont une ressource d’administration, la clé principale de service est nécessaire pour accéder à toute action et y parvenir à l’aide des API utilisateur.
CreateDatabaseIfNotExistsAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	Vérifiez si une base de données existe et, si ce n’est pas le cas, créez-la. Seul l’ID de base de données est utilisé pour vérifier s’il existe une base de données existante. D’autres propriétés de base de données, telles que le débit, ne sont pas validées et peuvent être différentes des propriétés passées. Une base de données gère les utilisateurs, les autorisations et un ensemble de conteneurs. Chaque compte de base de données Azure Cosmos DB peut prendre en charge plusieurs bases de données nommées indépendantes, la base de données étant le conteneur logique pour les données. Chaque base de données se compose d’un ou plusieurs conteneurs, chacun contenant à son tour un ou plusieurs documents. Étant donné que les bases de données sont une ressource d’administration, la clé principale de service est nécessaire pour accéder à toute action et y parvenir à l’aide des API utilisateur.
CreateDatabaseStreamAsync(DatabaseProperties, Nullable<Int32>, RequestOptions, CancellationToken)	Envoyez une demande de création d’une base de données. Une base de données gère les utilisateurs, les autorisations et un ensemble de conteneurs. Chaque compte de base de données Azure Cosmos DB peut prendre en charge plusieurs bases de données nommées indépendantes, la base de données étant le conteneur logique pour les données. Chaque base de données se compose d’un ou plusieurs conteneurs, chacun contenant à son tour un ou plusieurs documents. Étant donné que les bases de données sont une ressource d’administration, la clé principale de service est nécessaire pour accéder à toute action et y parvenir à l’aide des API utilisateur.
Dispose()	Supprimer le client Cosmos
Dispose(Boolean)	Supprimer le client Cosmos
GetContainer(String, String)	Retourne une référence proxy à un conteneur.
GetDatabase(String)	Retourne une référence proxy à une base de données.
GetDatabaseQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)	Cette méthode crée une requête pour les bases de données sous un compte Cosmos DB à l’aide d’une instruction SQL avec des valeurs paramétrables. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition.
GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions)	Cette méthode crée une requête pour les bases de données sous un compte Cosmos DB à l’aide d’une instruction SQL. Elle retourne un FeedIterator.
GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions)	Cette méthode crée une requête pour les bases de données sous un compte Cosmos DB à l’aide d’une instruction SQL avec des valeurs paramétrables. Elle retourne un FeedIterator. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition.
GetDatabaseQueryStreamIterator(String, String, QueryRequestOptions)	Cette méthode crée une requête pour les bases de données sous un compte Cosmos DB à l’aide d’une instruction SQL. Elle retourne un FeedIterator.
ReadAccountAsync()	Lit pour AccountProperties le compte Azure Cosmos DB.

Voir aussi

• CosmosClientBuilder
• CosmosClientOptions