Az Azure Cosmos DB for NoSQL használatának első lépései a .NET használatával
A KÖVETKEZŐRE VONATKOZIK: NoSQL
Ez a cikk bemutatja, hogyan csatlakozhat az Azure Cosmos DB for NoSQL-hez a .NET SDK használatával. A csatlakozás után műveleteket hajthat végre adatbázisokon, tárolókon és elemeken.
Package (NuGet) | Samples | API reference | Library source code | Give Feedback
Előfeltételek
- Egy Azure-fiók, aktív előfizetéssel. Fiók ingyenes létrehozása.
- Azure Cosmos DB for NoSQL-fiók. Hozzon létre egy API-t a NoSQL-fiókhoz.
- .NET 6.0 vagy újabb
- Azure Parancssori felület (CLI) vagy Azure PowerShell
A projekt beállítása
Hozzon létre egy új .NET-alkalmazást a dotnet new
konzolsablon parancsával.
dotnet new console
Importálja a Microsoft.Azure.Cosmos NuGet-csomagot a dotnet add package
paranccsal.
dotnet add package Microsoft.Azure.Cosmos
Hozza létre a projektet a dotnet build
paranccsal.
dotnet build
Csatlakozás az Azure Cosmos DB for NoSQL-hez
Az Azure Cosmos DB NoSQL-hez készült API-hoz való csatlakozáshoz hozza létre az osztály egy példányát CosmosClient
. Ez az osztály a kiindulópont az adatbázisokon végzett összes művelet végrehajtásához.
Ha a Microsoft Entra használatával szeretne csatlakozni a NoSQL-fiókhoz készült API-hoz, használjon egy egyszerű biztonsági nevet. Az egyszerűség pontos típusa attól függ, hogy hol tárolja az alkalmazás kódját. Az alábbi táblázat rövid útmutatóként szolgál.
Az alkalmazás futtatásának helye | Rendszerbiztonsági tag |
---|---|
Helyi gép (fejlesztés és tesztelés) | Felhasználói identitás vagy szolgáltatásnév |
Azure | Felügyelt identitás |
Azure-on kívüli kiszolgálók vagy ügyfelek | Szolgáltatásnév |
Az Azure.Identity importálása
Az Azure.Identity NuGet-csomag az összes Azure SDK-kódtár között megosztott alapvető hitelesítési funkciókat tartalmazza.
Importálja az Azure.Identity NuGet-csomagot a dotnet add package
paranccsal.
dotnet add package Azure.Identity
Építse újra a projektet a dotnet build
paranccsal.
dotnet build
A kódszerkesztőben adja hozzá a névterekre és Azure.Identity
a névterekre vonatkozó Azure.Core
irányelveket.
using Azure.Core;
using Azure.Identity;
CosmosClient létrehozása az alapértelmezett hitelesítő adatok implementálásával
Ha helyi gépen tesztel, vagy az alkalmazás a felügyelt identitások közvetlen támogatásával fog futni az Azure-szolgáltatásokban, szerezze be az OAuth-jogkivonatot egy DefaultAzureCredential
példány létrehozásával.
Ebben a példában egy típusváltozóba TokenCredential
mentettük a példányt, mivel ez egy általánosabb típus, amely az SDK-k között újra felhasználható.
// Credential class for testing on a local machine or Azure services
TokenCredential credential = new DefaultAzureCredential();
Hozzon létre egy új CosmosClient-példányt a COSMOS_ENDPOINT
környezeti változóval és a TokenCredential objektummal paraméterként.
// New instance of CosmosClient class using a connection string
using CosmosClient client = new(
accountEndpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
tokenCredential: credential
);
Az alkalmazás összeállítása
Az alkalmazás létrehozásakor a kód elsősorban négy erőforrástípussal fog működni:
Az API for NoSQL-fiók, amely az Azure Cosmos DB-adatok egyedi legfelső szintű névtere.
Adatbázisok, amelyek rendszerezik a tárolókat a fiókjában.
Tárolók, amelyek az adatbázis egyes elemeit tartalmazzák.
Elemek, amelyek egy JSON-dokumentumot jelölnek a tárolóban.
Az alábbi ábra az ezen erőforrások közötti kapcsolatot mutatja be.
Hierarchikus diagram egy Azure Cosmos DB-fiókot ábrázol felül. A fióknak két gyermekadatbázis-csomópontja van. Az adatbázis-csomópontok egyike két gyermektároló-csomópontot tartalmaz. A másik adatbáziscsomópont egyetlen gyermektároló-csomópontot tartalmaz. Az egyetlen tárolócsomópont három gyermekelem-csomópontból áll.
Minden erőforrástípust egy vagy több társított .NET-osztály jelöl. Íme a leggyakoribb osztályok listája:
Osztály | Leírás |
---|---|
CosmosClient |
Ez az osztály ügyféloldali logikai reprezentációt biztosít az Azure Cosmos DB szolgáltatáshoz. Az ügyfélobjektum a szolgáltatással kapcsolatos kérések konfigurálására és végrehajtására szolgál. |
Database |
Ez az osztály egy olyan adatbázisra mutató hivatkozás, amely lehet, hogy még létezik a szolgáltatásban. Az adatbázis kiszolgálóoldali érvényesítve van, amikor megpróbálja elérni, vagy műveletet hajt végre rajta. |
Container |
Ez az osztály egy olyan tárolóra mutató hivatkozás, amely még nem létezik a szolgáltatásban. A tároló kiszolgálóoldali érvényesítve lesz, amikor megpróbál dolgozni vele. |
Az alábbi útmutatók bemutatják, hogyan használhatja ezeket az osztályokat az alkalmazás létrehozásához.
Útmutató | Leírás |
---|---|
Adatbázis létrehozása | Adatbázisok létrehozására |
Tároló létrehozása | Tárolók létrehozása |
Elem olvasása | Adott elem pontolvasása |
Lekérdezési elemek | Több elem lekérdezése |