Začínáme se službou Azure Cosmos DB pro MongoDB s využitím .NET

Článek
08/15/2024

PLATÍ PRO: MongoDB

V tomto článku se dozvíte, jak se připojit ke službě Azure Cosmos DB pro MongoDB pomocí .NET Core a příslušných balíčků NuGet. Po připojení můžete provádět operace s databázemi, kolekcemi a dokumenty.

Poznámka:

Ukázkové fragmenty kódu jsou k dispozici na GitHubu jako projekt .NET Core.

Referenční dokumentace | k rozhraní API pro MongoDB – Balíček MongoDB (NuGet)

Požadavky

Účet Azure s aktivním předplatným. Vytvoření účtu zdarma
.NET 6.0
Rozhraní příkazového řádku Azure (CLI) nebo Azure PowerShell
Prostředek Azure Cosmos DB pro MongoDB

Vytvoření nové aplikace .NET Core

Pomocí upřednostňovaného terminálu vytvořte novou aplikaci .NET Core v prázdné složce. V tomto scénáři použijete konzolovou aplikaci. dotnet new Pomocí příkazu vytvořte a pojmenujte konzolovou aplikaci.
```
dotnet new console -o app
```
Přidejte balíček NuGet MongoDB do projektu konzoly. dotnet add package Použijte příkaz určující název balíčku NuGet.
```
dotnet add package MongoDB.Driver
```
Pokud chcete aplikaci spustit, přejděte pomocí terminálu do adresáře aplikace a spusťte aplikaci.
```
dotnet run
```

Připojení ke službě Azure Cosmos DB pro MongoDB pomocí nativního ovladače MongoDB

Pokud se chcete připojit ke službě Azure Cosmos DB pomocí nativního MongoClient ovladače MongoDB, vytvořte instanci třídy. Tato třída je výchozím bodem pro provádění všech operací s databázemi MongoDb. Nejběžnější konstruktor mongoClient přijímá připojovací řetězec, který můžete načíst pomocí následujícího postupu:

Získání názvu prostředku

Vytvořte proměnnou prostředí pro resourceGroupName.

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

az cosmosdb list Pomocí příkazu načtěte název prvního účtu služby Azure Cosmos DB ve vaší skupině prostředků a uložte ho do proměnné prostředí accountName.

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

Vytvořte proměnnou prostředí pro RESOURCE_GROUP_NAME.

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

Pomocí rutiny Get-AzCosmosDBAccountKey načtěte název prvního účtu služby Azure Cosmos DB ve vaší skupině prostředků a uložte ho do proměnné prostředí 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
```

Načtení připojovacího řetězce

V seznamu připojovací řetězec pro účet pomocí az cosmosdb keys list příkazu vyhledejte rozhraní API pro MongoDB připojovací řetězec.
```
az cosmosdb keys list --type connection-strings \
    --resource-group $resourceGroupName \
    --name $accountName 
```
Poznamenejte si hodnoty PRIMÁRNÍHO KLÍČE . Tyto přihlašovací údaje použijete později.

Vyhledejte PŘIPOJOVACÍ ŘETĚZEC ze seznamu klíčů a připojovací řetězec pro účet pomocí rutinyGet-AzCosmosDBAccountKey.

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

Poznamenejte si hodnotu CONNECTION STRING. Tyto přihlašovací údaje použijete později.

Tip

Pro tuto příručku doporučujeme použít název msdocs-cosmosskupiny prostředků .

Přihlaste se k portálu Azure.
Přejděte na existující stránku účtu Služby Azure Cosmos DB pro MongoDB.
Na stránce účtu Služby Azure Cosmos DB pro MongoDB vyberte možnost navigační nabídky Připojovací řetězec .
Poznamenejte si hodnotu pole PRIMÁRNÍ PŘIPOJOVACÍ ŘETĚZEC . Tuto hodnotu použijete v pozdějším kroku.

Konfigurace proměnných prostředí

Pokud chcete použít hodnoty CONNECTION STRING v kódu, nastavte tuto hodnotu v místním prostředí, ve kterém je aplikace spuštěná. Pokud chcete nastavit proměnnou prostředí, použijte upřednostňovaný terminál a spusťte následující příkazy:

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

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

Soubor .env je standardní způsob ukládání proměnných prostředí v projektu. Vytvořte .env soubor v kořenovém adresáři projektu. Do souboru přidejte následující řádky .env :

COSMOS_CONNECTION_STRING="<cosmos-connection-string>"

Vytvoření MongoClient pomocí připojovací řetězec

Definujte novou instanci MongoClient třídy pomocí konstruktoru a proměnné připojovací řetězec, kterou jste nastavili dříve.

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

var settings = client.Settings;

Console.WriteLine(settings.Server.Host);

Použití klientských tříd MongoDB se službou Azure Cosmos DB pro rozhraní API pro MongoDB

Než začnete vytvářet aplikaci, podívejme se na hierarchii prostředků ve službě Azure Cosmos DB. Azure Cosmos DB má konkrétní objektový model, který se používá k vytváření a přístupu k prostředkům. Azure Cosmos DB vytváří prostředky v hierarchii, které se skládají z účtů, databází, kolekcí a dokumentů.

Diagram hierarchie služby Azure Cosmos DB, včetně účtů, databází, kolekcí a dokumentů

Každý typ prostředku je reprezentován jednou nebo více přidruženými třídami jazyka C#. Tady je seznam nejběžnějších tříd:

Třída	Popis
`MongoClient`	Tato třída poskytuje logickou reprezentaci na straně klienta pro vrstvu ROZHRANÍ API pro MongoDB ve službě Azure Cosmos DB. Objekt klienta slouží ke konfiguraci a spouštění požadavků na službu.
`MongoDatabase`	Tato třída je odkazem na databázi, která může nebo nemusí existovat ve službě ještě. Databáze se ověří nebo vytvoří na straně serveru při pokusu o provedení operace.
`Collection`	Tato třída je odkazem na kolekci, která ještě nemusí ve službě existovat. Kolekce se ověří na straně serveru, když se s ní pokusíte pracovat.

Následující příručky ukazují, jak pomocí každé z těchto tříd sestavit aplikaci a spravovat data.

Průvodce:

Viz také

Další kroky

Teď, když jste se připojili k účtu ROZHRANÍ API pro MongoDB, použijte další příručku k vytváření a správě databází.

Vytvoření databáze ve službě Azure Cosmos DB pro MongoDB pomocí .NET

Sdílet prostřednictvím