CosmosClient Classe

Référence

Définition

Espace de noms:: Azure.Cosmos

Assembly:: Azure.Cosmos.dll

Paquet:: Azure.Cosmos v4.0.0-preview3

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

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 efficace des connexions et des performances. Reportez-vous au guide de performances à l’adresse https://docs.microsoft.com/azure/cosmos-db/performance-tips.

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, CosmosDatabaseet un CosmosContainer. CosmosClient est créé avec la chaîne de connexion et configuré pour utiliser la région « USA Est 2 ».

using Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "connection-string-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

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

// Dispose cosmosClient at application exit

Cet exemple crée un CosmosClient, CosmosDatabaseet un CosmosContainer. CosmosClient est créé avec accountEndpoint, AccountKey ou ResourceToken et configuré pour utiliser la région « USA Est 2 ».

using Azure.Cosmos;

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

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

// Dispose cosmosClient at application exit

Cet exemple crée un CosmosClient, CosmosDatabaseet un CosmosContainer. CosmosClient est créé via le modèle de CosmosClientBuildergénérateur .

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

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

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

// Dispose cosmosClient at application exit

Remarques

https://docs.microsoft.com/azure/cosmos-db/performance-tips https://docs.microsoft.com/azure/cosmos-db/troubleshoot-dot-net-sdk https://docs.microsoft.com/azure/cosmos-db/distribute-data-globally https://docs.microsoft.com/azure/cosmos-db/partitioning-overview https://docs.microsoft.com/azure/cosmos-db/request-units

Constructeurs

CosmosClient()

Créer un cosmosClient utilisé pour les tests fictifs

CosmosClient(String, CosmosClientOptions)

Créer un cosmosClient avec la chaîne de connexion

CosmosClient(String, String, CosmosClientOptions)

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

Propriétés

ClientOptions	Initialiser CosmosClientOptions CosmosClient utilisé
Endpoint	Obtient l’URI de point de terminaison pour le service Azure Cosmos DB.

Méthodes

CreateDatabaseAsync(String, 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 à toutes les actions et les effectuer correctement à 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 à toutes les actions et les effectuer correctement à 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 à toutes les actions et les effectuer correctement à 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, CancellationToken)	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, CancellationToken)	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. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition surcharge.
GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions, CancellationToken)	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, CancellationToken)	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. Pour plus d’informations sur la préparation des instructions SQL avec des valeurs paramétrables, consultez QueryDefinition surcharge.
ReadAccountAsync()	Lire les propriétés du compte Azure Cosmos DB AccountProperties

S’applique à

Partager via