Aan de slag met Azure Cosmos DB voor MongoDB met .NET

Artikel
08/15/2024

VAN TOEPASSING OP: MongoDB

In dit artikel leest u hoe u verbinding maakt met Azure Cosmos DB voor MongoDB met behulp van .NET Core en de relevante NuGet-pakketten. Zodra u verbinding hebt gemaakt, kunt u bewerkingen uitvoeren op databases, verzamelingen en documenten.

Notitie

De voorbeeldcodefragmenten zijn beschikbaar op GitHub als een .NET Core-project.

Api voor MongoDB-referentiedocumentatie | MongoDB-pakket (NuGet)

Vereisten

Een Azure-account met een actief abonnement. Gratis een account maken
.NET 6.0
Azure-opdrachtregelinterface (CLI) of Azure PowerShell
Azure Cosmos DB voor MongoDB-resource

Een nieuwe .NET Core-app maken

Maak een nieuwe .NET Core-toepassing in een lege map met behulp van uw favoriete terminal. Voor dit scenario gebruikt u een consoletoepassing. Gebruik de dotnet new opdracht om de console-app te maken en een naam te geven.
```
dotnet new console -o app
```
Voeg het MongoDB NuGet-pakket toe aan het consoleproject. Gebruik de dotnet add package opdracht die de naam van het NuGet-pakket opgeeft.
```
dotnet add package MongoDB.Driver
```
Als u de app wilt uitvoeren, gebruikt u een terminal om naar de toepassingsmap te navigeren en de toepassing uit te voeren.
```
dotnet run
```

Verbinding maken met Azure Cosmos DB voor MongoDB met het systeemeigen MongoDB-stuurprogramma

Als u verbinding wilt maken met Azure Cosmos DB met het systeemeigen MongoDB-stuurprogramma, maakt u een exemplaar van de MongoClient klasse. Deze klasse is het startpunt om alle bewerkingen uit te voeren op MongoDb-databases. De meest voorkomende constructor voor MongoClient accepteert een verbindingsreeks, die u kunt ophalen met behulp van de volgende stappen:

Resourcenaam ophalen

Maak een shellvariabele voor resourceGroupName.

# Variable for resource group name
resourceGroupName="msdocs-cosmos"

Gebruik de az cosmosdb list opdracht om de naam van het eerste Azure Cosmos DB-account in uw resourcegroep op te halen en op te slaan in de accountName-shellvariabele .

# Retrieve most recently created account name
accountName=$(
    az cosmosdb list \
        --resource-group $resourceGroupName \
        --query "[0].name" \
        --output tsv
)

Maak een shellvariabele voor RESOURCE_GROUP_NAME.

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

Gebruik de cmdlet Get-AzCosmosDBAccountKey om de naam van het eerste Azure Cosmos DB-account in uw resourcegroep op te halen en op te slaan in de accountName-shellvariabele.
```
# Get the name of the first Azure Cosmos DB account in your resource group
$ACCOUNT_NAME = (Get-AzCosmosDBAccount -ResourceGroupName $RESOURCE_GROUP_NAME)[0].Name
```

De verbindingsreeks ophalen

Zoek de API voor MongoDB-verbindingsreeks in de lijst met verbindingsreeks s voor het account met de az cosmosdb keys list opdracht.
```
az cosmosdb keys list --type connection-strings \
    --resource-group $resourceGroupName \
    --name $accountName 
```
Noteer de WAARDEN VAN DE PRIMAIRE SLEUTEL . U gebruikt deze referenties later.

Zoek de VERBINDINGSREEKS uit de lijst met sleutels en verbindingsreeks s voor het account met de Get-AzCosmosDBAccountKey cmdlet.

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

Noteer de waarde CONNECTION STRING . U gebruikt deze referenties later.

Tip

Voor deze handleiding raden we u aan de naam msdocs-cosmosvan de resourcegroep te gebruiken.

Meld u aan bij het Azure-portaal.
Navigeer naar de bestaande azure Cosmos DB for MongoDB-accountpagina.
Selecteer op de pagina van het Azure Cosmos DB for MongoDB-account de menuoptie Verbindingsreeksnavigatie .
Noteer de waarde voor het veld PRIMAIRE VERBINDINGSREEKS . U gebruikt deze waarde in een latere stap.

Omgevingsvariabelen configureren

Als u de WAARDEN VOOR VERBINDINGSREEKS in uw code wilt gebruiken, stelt u deze waarde in in de lokale omgeving waarop de toepassing wordt uitgevoerd. Als u de omgevingsvariabele wilt instellen, gebruikt u de terminal van uw voorkeur om de volgende opdrachten uit te voeren:

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

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

Een .env bestand is een standaardmethode voor het opslaan van omgevingsvariabelen in een project. Maak een .env bestand in de hoofdmap van uw project. Voeg de volgende regels toe aan het .env bestand:

COSMOS_CONNECTION_STRING="<cosmos-connection-string>"

MongoClient maken met verbindingsreeks

Definieer een nieuw exemplaar van de MongoClient klasse met behulp van de constructor en de verbindingsreeks variabele die u eerder hebt ingesteld.

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

var settings = client.Settings;

Console.WriteLine(settings.Server.Host);

De MongoDB-clientklassen gebruiken met Azure Cosmos DB voor API voor MongoDB

Voordat u begint met het bouwen van de toepassing, gaan we kijken naar de hiërarchie van resources in Azure Cosmos DB. Azure Cosmos DB heeft een specifiek objectmodel dat wordt gebruikt voor het maken en openen van resources. Azure Cosmos DB maakt resources in een hiërarchie die bestaat uit accounts, databases, verzamelingen en documenten.

Diagram van de Azure Cosmos DB DB-hiërarchie, waaronder accounts, databases, verzamelingen en documenten.

Elk type resource wordt vertegenwoordigd door een of meer bijbehorende C#-klassen. Hier volgt een lijst met de meest voorkomende klassen:

Klas	Beschrijving
`MongoClient`	Deze klasse biedt een logische weergave aan de clientzijde voor de API voor MongoDB-laag in Azure Cosmos DB. Het clientobject wordt gebruikt om aanvragen aan de service te configureren en uitvoeren.
`MongoDatabase`	Deze klasse is een verwijzing naar een database die al dan niet bestaat in de service. De database wordt gevalideerd of gemaakt aan de serverzijde wanneer u een bewerking probeert uit te voeren.
`Collection`	Deze klasse is een verwijzing naar een verzameling die mogelijk nog niet bestaat in de service. De verzameling wordt gevalideerd aan de serverzijde wanneer u ermee probeert te werken.

In de volgende handleidingen ziet u hoe u elk van deze klassen gebruikt om uw toepassing te bouwen en gegevens te beheren.

Handleiding:

Zie ook

Volgende stappen

Nu u verbinding hebt gemaakt met een API voor MongoDB-account, gebruikt u de volgende handleiding voor het maken en beheren van databases.

Een database maken in Azure Cosmos DB voor MongoDB met behulp van .NET

Delen via