Začínáme se službou Azure Cosmos DB for NoSQL s využitím .NET
PLATÍ PRO: 
NoSQL
V tomto článku se dozvíte, jak se připojit ke službě Azure Cosmos DB for NoSQL pomocí sady .NET SDK. Po připojení můžete provádět operace s databázemi, kontejnery a položkami.
Referenční informace ke | zdrojovému kódu knihovny api pro balíčky (NuGet) | – | Referenční informace ke zdrojovému kódu knihovny |
Požadavky
- Účet Azure s aktivním předplatným. Vytvoření účtu zdarma
- Účet Služby Azure Cosmos DB for NoSQL Vytvořte účet rozhraní API pro NoSQL.
- .NET 6.0 nebo novější
- Rozhraní příkazového řádku Azure (CLI) nebo Azure PowerShell
Nastavení projektu
Pomocí příkazu se šablonou konzoly vytvořte novou aplikaci dotnet new .NET.
dotnet new console
Importujte balíček NuGet Microsoft.Azure.Cosmos pomocí dotnet add package příkazu.
dotnet add package Microsoft.Azure.Cosmos
Sestavte projekt pomocí dotnet build příkazu.
dotnet build
Připojení ke službě Azure Cosmos DB for NoSQL
Pokud se chcete připojit k rozhraní API pro NoSQL služby Azure Cosmos DB, vytvořte instanci CosmosClient třídy. Tato třída je výchozím bodem pro provádění všech operací s databázemi.
Pokud se chcete připojit k účtu API for NoSQL pomocí Microsoft Entra, použijte objekt zabezpečení. Přesný typ objektu zabezpečení bude záviset na tom, kde hostujete kód aplikace. Následující tabulka slouží jako stručná referenční příručka.
| Kde aplikace běží | Objekt zabezpečení |
|---|---|
| Místní počítač (vývoj a testování) | Identita uživatele nebo instanční objekt |
| Azure | Spravovaná identita |
| Servery nebo klienti mimo Azure | Instanční objekt |
Import Azure.Identity
Balíček NuGet Azure.Identity obsahuje základní funkce ověřování, které se sdílí mezi všemi knihovnami sady Azure SDK.
Importujte balíček NuGet Azure.Identity pomocí dotnet add package příkazu.
dotnet add package Azure.Identity
Znovu sestavte projekt pomocí dotnet build příkazu.
dotnet build
V editoru kódu přidejte direktivy using pro Azure.Core obory názvů a Azure.Identity obory názvů.
using Azure.Core;
using Azure.Identity;
Vytvoření CosmosClient s výchozí implementací přihlašovacích údajů
Pokud testujete na místním počítači nebo vaše aplikace bude běžet na službách Azure s přímou podporou spravovaných identit, získejte token OAuth vytvořením DefaultAzureCredential instance.
V tomto příkladu jsme instanci uložili do proměnné typu TokenCredential , protože jde o obecnější typ, který je opakovaně použitelný napříč sadami SDK.
// Credential class for testing on a local machine or Azure services
TokenCredential credential = new DefaultAzureCredential();
Vytvořte novou instanci třídy CosmosClient s COSMOS_ENDPOINT proměnnou prostředí a tokenCredential objekt jako parametry.
// New instance of CosmosClient class using a connection string
using CosmosClient client = new(
accountEndpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
tokenCredential: credential
);
Sestavení aplikace
Při vytváření aplikace bude váš kód primárně pracovat se čtyřmi typy prostředků:
Účet ROZHRANÍ API pro NoSQL, což je jedinečný obor názvů nejvyšší úrovně pro vaše data Azure Cosmos DB.
Databáze, které uspořádají kontejnery ve vašem účtu.
Kontejnery, které obsahují sadu jednotlivých položek v databázi.
Položky, které představují dokument JSON ve vašem kontejneru.
Na následujícím diagramu jsou vztahy těchto prostředků.
Hierarchický diagram znázorňující účet služby Azure Cosmos DB v horní části Účet má dva podřízené databázové uzly. Jeden z databázových uzlů zahrnuje dva podřízené uzly kontejneru. Druhý databázový uzel obsahuje jeden podřízený uzel kontejneru. Tento jeden uzel kontejneru má tři podřízené uzly položek.
Každý typ prostředku je reprezentován jednou nebo více přidruženými třídami .NET. Tady je seznam nejběžnějších tříd:
| Třída | Popis |
|---|---|
CosmosClient |
Tato třída poskytuje logickou reprezentaci na straně klienta pro službu Azure Cosmos DB. Objekt klienta slouží ke konfiguraci a spouštění požadavků na službu. |
Database |
Tato třída je odkazem na databázi, která může nebo nemusí existovat ve službě ještě. Databáze je ověřena na straně serveru, když se pokusíte o přístup k databázi nebo provedete operaci s ní. |
Container |
Tato třída je odkazem na kontejner, který ještě nemusí ve službě existovat. Kontejner se ověří na straně serveru, když se s ním pokusíte pracovat. |
Následující příručky vám ukážou, jak pomocí každé z těchto tříd sestavit aplikaci.
| Průvodce | Popis |
|---|---|
| Vytvoření databáze | Vytvoření databází |
| Vytvoření kontejneru | Vytvořte kontejnery |
| Čtení položky | Načtení konkrétní položky |
| Dotazování položek | Dotazování na více položek |