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

Article
06/01/2023

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.

Prérequis

Compte Azure avec un abonnement actif. Créez un compte gratuitement.
Compte Azure Cosmos DB for Table. Créer une API pour un compte Table.
.NET 6.0 ou version ultérieure
Interface de ligne de commande Azure (CLI) ou Azure PowerShell

Configuration de votre projet

Créez une application console .NET

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. Il existe deux méthodes principales pour se connecter à un compte d’API pour Table à l’aide de la classe TableServiceClient :

Se connecter avec une chaîne de connexion d’API pour Table

Se connecter avec une chaîne de connexion

Le constructeur le plus courant pour TableServiceClient n’a qu’un seul paramètre :

Paramètre	Valeur d'exemple	Description
`connectionString`	`COSMOS_CONNECTION_STRING` variable d’environnement	Chaîne de connexion au compte d’API pour Table

Récupérer votre chaîne de connexion de compte

Azure CLI
PowerShell

Utilisez la commande az cosmosdb list pour récupérer le nom du premier compte Azure Cosmos DB dans votre groupe de ressources et le stocker dans la variable d’interpréteur de commandes accountName.
```
# Retrieve most recently created account name
accountName=$(
    az cosmosdb list \
        --resource-group $resourceGroupName \
        --query "[0].name" \
        --output tsv
)
```

Recherchez la CHAÎNE DE CONNEXION PRIMAIRE dans la liste des chaînes de connexion pour le compte avec la commande az-cosmosdb-keys-list.

az cosmosdb keys list \
    --resource-group $resourceGroupName \
    --name $accountName \
    --type "connection-strings" \
    --query "connectionStrings[?description == \`Primary Table Connection String\`] | [0].connectionString"

Utilisez la cmdlet Get-AzCosmosDBAccount pour récupérer le nom du premier compte Azure Cosmos DB dans votre groupe de ressources et le stocker dans la variable d’interpréteur de commandes ACCOUNT_NAME.

# Retrieve most recently created account name
$parameters = @{
    ResourceGroupName = $RESOURCE_GROUP_NAME
}
$ACCOUNT_NAME = (
    Get-AzCosmosDBAccount @parameters |
        Select-Object -Property Name -First 1
).Name

Recherchez la CHAÎNE DE CONNEXION PRIMAIRE dans la liste des chaînes de connexion pour le compte avec la cmdlet Get-AzCosmosDBAccountKey.

$parameters = @{
    ResourceGroupName = $RESOURCE_GROUP_NAME
    Name = $ACCOUNT_NAME
    Type = "ConnectionStrings"
}    
Get-AzCosmosDBAccountKey @parameters |
    Select-Object -Property "Primary Table Connection String" -First 1

Pour utiliser la valeur CHAÎNE DE CONNEXION PRIMAIRE dans votre code .NET, conservez-la dans une nouvelle variable d’environnement sur l’ordinateur local exécutant l’application.

Windows
Linux / macOS

$env:COSMOS_CONNECTION_STRING = "<cosmos-account-PRIMARY-CONNECTION-STRING>"

export COSMOS_CONNECTION_STRING="<cosmos-account-PRIMARY-CONNECTION-STRING>"

Créer TableServiceClient avec une chaîne de connexion

Créez une instance de la classe TableServiceClient avec la variable d’environnement COSMOS_CONNECTION_STRING en tant que seul paramètre.

// New instance of TableServiceClient class using a connection string
TableServiceClient client = new(
    connectionString: Environment.GetEnvironmentVariable("COSMOS_CONNECTION_STRING")!
);

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