Partager via

Bien démarrer avec Azure Cosmos DB for Table à l’aide de .NET

  • Article

S’APPLIQUE À : Table

Cet article vous montre comment vous connecter à Azure Cosmos DB for Table à l’aide du SDK .NET. Une fois connecté, vous pouvez effectuer des opérations sur des tables et des éléments.

Package (NuGet) | Exemples | Référence API | Code source de la bibliothèque | Envoyer des commentaires |

Prérequis

Configuration de votre projet

Créez une application .NET à l’aide de la commande dotnet new avec le modèle de console.

dotnet new console

Importez le package NuGet Azure.Data.Tables à l’aide de la commande dotnet add package.

dotnet add package Azure.Data.Tables

Générez le projet avec la commande dotnet build.

dotnet build

Se connecter à Azure Cosmos DB for Table

Pour vous connecter à l’API pour Table d’Azure Cosmos DB, créez une instance de la classe TableServiceClient. Cette classe est le point de départ pour effectuer toutes les opérations sur les tables.

Pour vous connecter à votre API pour un compte NoSQL à l’aide de Microsoft Entra, utilisez un principal de sécurité. Le type exact de principal dépend de l’emplacement où vous hébergez votre code d’application. Le tableau ci-dessous sert de guide de référence rapide.

Emplacement d’exécution de l’application Principal de sécurité
Ordinateur local (développement et test) Identité de l’utilisateur ou principal du service
Azure Identité managée
Serveurs ou clients en dehors d’Azure Principal du service

Importer Azure.Identity

Le package NuGet Azure.Identity contient les fonctionnalités d’authentification principales partagées entre toutes les bibliothèques du kit de développement logiciel (SDK) Azure.

Importez le package NuGet Azure.Identity à l’aide de la commande dotnet add package.

dotnet add package Azure.Identity

Régénérez le projet avec la commande dotnet build.

dotnet build

Dans votre éditeur de code, ajoutez des directives d’utilisation pour des espaces de noms Azure.Core et Azure.Identity.

using Azure.Core;
using Azure.Identity;

Créer CosmosClient avec l’implémentation des informations d’identification par défaut

Si vous testez sur une machine locale ou que votre application s’exécute sur des services Azure avec prise en charge directe des identités managées, obtenez un jeton OAuth en créant une instance DefaultAzureCredential.

Pour cet exemple, nous avons enregistré l’instance dans une variable de type TokenCredential, car c’est un type plus générique réutilisable dans les kits SDK.

// Credential class for testing on a local machine or Azure services
TokenCredential credential = new DefaultAzureCredential();

Créez une instance de la classe CosmosClient avec la variable d’environnement COSMOS_ENDPOINT et l’objet TokenCredential en tant que paramètres.

// New instance of TableServiceClient class using Microsoft Entra
TableServiceClient client = new(
    endpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
    tokenCredential: credential
);

Générer votre application

À mesure que vous générez votre application, votre code interagit principalement avec quatre types de ressources :

  • Le compte d’API pour Table qui est l’unique espace de noms de niveau supérieur pour vos données Azure Cosmos DB.

  • Tables, qui contiennent un ensemble d’éléments de votre compte.

  • Éléments, qui représentent un élément de votre table.

Le diagramme suivant montre la relation entre ces ressources.

Schéma de la hiérarchie d’Azure Cosmos DB comprenant des comptes, des tables et des éléments.

Chaque type de ressource est représenté par une ou plusieurs classes ou interfaces .NET associées. Voici la liste des types les plus courants :

Classe Description
TableServiceClient Cette classe cliente fournit une représentation logique du côté client pour le service Azure Cosmos DB. Ce client est utilisé pour configurer et exécuter des requêtes sur le service.
TableClient Cette classe cliente est une référence à une table qui peut, ou non, exister dans le service. La table est validée côté serveur lorsque vous tentez d’y accéder ou d’effectuer une opération sur celle-ci.
ITableEntity Cette interface est l’interface de base pour tous les éléments créés dans la table ou interrogés à partir de la table. Cette interface inclut toutes les propriétés qui sont nécessaires pour les éléments de l’API pour Table.
TableEntity Cette classe est une implémentation générique de l’interface ITableEntity en tant que dictionnaire de paires clé-valeur.

Les guides suivants vous montrent comment utiliser chacune de ces classes pour générer votre application.

Guide Description
Création d'une table Créer des tables
Créer un élément Créer des éléments
Lire un élément Lire des éléments

Voir aussi

Étapes suivantes

Maintenant que vous êtes connecté à un compte d’API pour Table, utilisez le guide suivant pour créer et gérer les tables.

Créer une table dans Azure Cosmos DB for Table avec .NET