Démarrage d’Azure Cosmos DB for MongoDB à l’aide de .NET

Article
08/15/2024

S’APPLIQUE À : MongoDB

Cet article explique comment vous connecter à Azure Cosmos DB for MongoDB à l’aide de .NET Core et des packages NuGet pertinents. Une fois connecté, vous pouvez effectuer des opérations sur des bases de données, des collections et des documents.

Notes

Les exemples d’extraits de code sont disponibles sur GitHub en tant que projet .NET Core.

Documentation de référence sur l’API pour MongoDB | Package MongoDB (NuGet)

Prérequis

Compte Azure avec un abonnement actif. Créez un compte gratuitement.
.NET 6.0
Interface de ligne de commande Azure (CLI) ou Azure PowerShell
Ressource Azure Cosmos DB for MongoDB

Créer une application .NET Core

Créez une application .NET Core dans un dossier vide à l’aide de votre terminal préféré. Pour ce scénario, vous allez utiliser une application de console. Utilisez la commande dotnet new pour créer et nommer l’application console.
```
dotnet new console -o app
```
Ajoutez le package NuGet MongoDB au projet de console. Utilisez la commande dotnet add package spécifiant le nom du package NuGet.
```
dotnet add package MongoDB.Driver
```
Pour exécuter l’application, utilisez un terminal pour accéder au répertoire de l’application et exécuter l’application.
```
dotnet run
```

Se connecter à Azure Cosmos DB for MongoDB avec le pilote natif MongoDB

Pour se connecter à Azure Cosmos DB avec le pilote natif MongoDB, créez une instance de la classe MongoClient. Cette classe est le point de départ pour effectuer toutes les opérations sur des bases de données MongoDb. Le constructeur le plus courant pour MongoClient accepte une chaîne de connexion, que vous pouvez récupérer à l’aide des étapes suivantes :

Obtenir le nom de la ressource

Créez une variable d’interpréteur de commandes pour resourceGroupName.
```
# Variable for resource group name
resourceGroupName="msdocs-cosmos"
```
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
)
```

Créez une variable d’interpréteur de commandes pour RESOURCE_GROUP_NAME.

# Variable for resource group name
$RESOURCE_GROUP_NAME = "msdocs-cosmos"

Utilisez la cmdlet Get-AzCosmosDBAccountKey pour récupérer le nom du premier compte Azure Cosmos DB de votre groupe de ressources et le stocker dans la variable d’interpréteur de commandes accountName.
```
# Get the name of the first Azure Cosmos DB account in your resource group
$ACCOUNT_NAME = (Get-AzCosmosDBAccount -ResourceGroupName $RESOURCE_GROUP_NAME)[0].Name
```

Récupération de votre chaîne de connexion

Recherchez la chaîne de connexion de l’API MongoDB dans la liste des chaînes de connexion du compte à l’aide de la commande az cosmosdb keys list.
```
az cosmosdb keys list --type connection-strings \
    --resource-group $resourceGroupName \
    --name $accountName 
```
Enregistrez les valeurs de CLÉ PRIMAIRE. Vous aurez besoin de ces informations d’identification ultérieurement.

Recherchez la CHAÎNE DE CONNEXION dans la liste des chaînes de connexion du compte à l’aide de l’applet de commande Get-AzCosmosDBAccountKey.

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

Enregistrez la valeur de CHAÎNE DE CONNEXION. Vous aurez besoin de ces informations d’identification ultérieurement.

Conseil

Pour ce guide, nous vous recommandons d’utiliser le nom du groupe de ressources msdocs-cosmos.

Connectez-vous au portail Azure.
Accédez à la page du compte Azure Cosmos DB for MongoDB existant.
Dans la page du compte Azure Cosmos DB for MongoDB, sélectionnez l’option de menu de navigation Chaîne de connexion.
Enregistrez la valeur du champ CHAÎNE DE CONNEXION PRINCIPALE. Vous utiliserez cette valeur ultérieurement.

Configuration des variables d’environnement

Pour utiliser les valeurs de CHAÎNE DE CONNEXION dans votre code, définissez cette valeur dans l’environnement local exécutant l’application. Pour définir la variable d’environnement, utilisez votre terminal préféré pour exécuter les commandes suivantes :

$env:COSMOS_CONNECTION_STRING = "<cosmos-connection-string>"

export COSMOS_CONNECTION_STRING="<cosmos-connection-string>"

L’utilisation d’un fichier .env constitue la méthode standard de stockage des variables d’environnement dans un projet. Créez un fichier .env à la racine de votre projet. Ajoutez les lignes suivantes au fichier .env :

COSMOS_CONNECTION_STRING="<cosmos-connection-string>"

Créer un client MongoClient avec une chaîne de connexion

Définissez une nouvelle instance de la classe MongoClient en utilisant le constructeur et la variable de chaîne de connexion que vous avez définie plus tôt.

// New instance of CosmosClient class
var client = new MongoClient(Environment.GetEnvironmentVariable("COSMOS_CONNECTION_STRING"));

var settings = client.Settings;

Console.WriteLine(settings.Server.Host);

Utiliser les classes de clients MongoDB avec l’API Azure Cosmos DB for MongoDB

Avant de commencer à générer l’application, examinons la hiérarchie des ressources dans Azure Cosmos DB. Azure Cosmos DB a un modèle objet spécifique utilisé pour créer et accéder aux ressources. Azure Cosmos DB crée des ressources dans une hiérarchie qui se compose de comptes, de bases de données, de collections et de documents.

Diagramme de la hiérarchie de base de données d’Azure Cosmos DB comprenant les comptes, les bases de données, les collections et les documents.

Chaque type de ressource est représenté par une ou plusieurs classes C# associées. Voici une liste des classes les plus courantes :

Classe	Description
`MongoClient`	Cette classe fournit une représentation logique côté client pour la couche d’API MongoDB dans Azure Cosmos DB. Ce client est utilisé pour configurer et exécuter des requêtes sur le service.
`MongoDatabase`	Cette classe est une référence à une base de données qui peut, ou non, exister dans le service. La base de données est validée ou créée côté serveur lorsque vous tentez d’effectuer une opération sur celle-ci.
`Collection`	Cette classe est une référence à une collection qui n’existe pas encore dans le service. La collection est validée côté serveur lorsque vous tentez de l’utiliser.

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

Guide :

Voir aussi

Étapes suivantes

Maintenant que vous êtes connecté à un compte d’API MongoDB, utilisez le guide suivant pour créer et gérer des bases de données.

Créer une base de données dans Azure Cosmos DB for MongoDB à l’aide de .NET

Partager via