Freigeben über

Schnellstart: Verwenden von Azure Cosmos DB for NoSQL mit dem Azure SDK für .NET

  • Artikel
  • Gilt für::
    ✅ NoSQL

In dieser Schnellstartanleitung stellen Sie eine einfache Azure Cosmos DB for Table-Anwendung mithilfe des Azure SDK für .NET bereit. Azure Cosmos DB for Table ist ein schemaloser Datenspeicher, der es Anwendungen ermöglicht, strukturierte NoSQL-Daten in der Cloud zu speichern. Sie erfahren, wie Sie Tabellen, Zeilen und grundlegende Aufgaben innerhalb Ihrer Azure Cosmos DB-Ressource mithilfe des Azure SDK für .NET erstellen.

API-Referenzdokumentation | Quellcode der Bibliothek | Paket (NuGet) | Azure Developer CLI

Voraussetzungen

  • Azure Developer CLI
  • Docker Desktop
  • .NET 9.0

Sollten Sie kein Azure-Konto haben, erstellen Sie zunächst ein kostenloses Konto.

Initialisieren des Projekts

Verwenden Sie die Azure Developer CLI (azd), um ein Azure Cosmos DB for Table-Konto zu erstellen und eine containerisierte Beispielanwendung bereitzustellen. Die Beispielanwendung verwendet die Clientbibliothek zum Verwalten, Erstellen, Lesen und Abfragen von Beispieldaten.

  1. Öffnen Sie ein Terminal in einem leeren Verzeichnis.

  2. Wenn Sie noch nicht authentifiziert sind, authentifizieren Sie sich mithilfe von azd auth login bei der Azure Developer CLI. Führen Sie die vom Tool angegebenen Schritte aus, um sich mit Ihren bevorzugten Azure-Anmeldeinformationen bei der CLI zu authentifizieren.

    azd auth login

  3. Verwenden Sie azd init, um das Projekt zu initialisieren.

    azd init --template cosmos-db-nosql-dotnet-quickstart

  4. Konfigurieren Sie während der Initialisierung einen eindeutigen Umgebungsnamen.

  5. Stellen Sie das Azure Cosmos DB-Konto mit azd up bereit. Die Bicep-Vorlagen stellen auch eine Beispielwebanwendung bereit.

    azd up

  6. Wählen Sie während des Bereitstellungsprozesses Ihr Abonnement, den gewünschten Standort und die Zielressourcengruppe aus. Warten Sie auf den Abschluss des Bereitstellungsvorgangs. Dieser Prozess kann ca. fünf Minuten dauern.

  7. Sobald die Bereitstellung Ihrer Azure-Ressourcen abgeschlossen ist, enthält die Ausgabe eine URL zur ausgeführten Webanwendung.

    Deploying services (azd deploy)

  (✓) Done: Deploying service web
- Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>

SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.

  8. Verwenden Sie die URL in der Konsole, um im Browser zu Ihrer Webanwendung zu navigieren. Sehen Sie sich die Ausgabe der ausgeführten App an.

Screenshot der ausgeführten Web-App.

Installieren der Clientbibliothek

Die Clientbibliothek ist über NuGet als Microsoft.Azure.Cosmos-Paket verfügbar.

  1. Öffnen Sie ein Terminal, und navigieren Sie zu dem /src/web-Ordner.

    cd ./src/web

  2. Installieren Sie das Microsoft.Azure.Cosmos-Paket mithilfe von dotnet add package, falls es noch nicht installiert ist.

    dotnet add package Microsoft.Azure.Cosmos --version 3.*

  3. Installieren Sie außerdem das Azure.Identity-Paket, wenn es noch nicht installiert ist.

    dotnet add package Azure.Identity --version 1.12.*

  4. Öffnen und überprüfen Sie die Datei src/web/Cosmos.Samples.NoSQL.Quickstart.Web.csproj, um zu bestätigen, dass die Einträge Microsoft.Azure.Cosmos und Azure.Identity vorhanden sind.

Objektmodell

name Beschreibung
CosmosClient Diese Klasse ist die primäre Clientklasse und wird verwendet, um kontoweite Metadaten oder Datenbanken zu verwalten.
Database Diese Klasse stellt eine Datenbank innerhalb des Kontos dar.
Container Diese Klasse wird in erster Linie verwendet, um Lese-, Update- und Löschvorgänge für den Container oder die im Container gespeicherten Elemente auszuführen.
PartitionKey Diese Klasse stellt einen logischen Partitionsschlüssel dar. Diese Klasse ist für viele allgemeine Vorgänge und Abfragen erforderlich.

Codebeispiele

Der Beispielcode in der Vorlage verwendet eine Datenbank mit dem Namen cosmicworks und einen Container mit dem Namen products. Der products-Container enthält Details wie Name, Kategorie, Menge, eindeutiger Bezeichner und ein Verkaufsflag für jedes Produkt. Der Container verwendet die /category-Eigenschaft als logischen Partitionsschlüssel.

Authentifizieren des Clients

In diesem Beispiel wird eine neue Instanz der CosmosClient-Klasse erstellt und mithilfe einer DefaultAzureCredential-Instanz authentifiziert.

DefaultAzureCredential credential = new();

CosmosClient client = new(
    accountEndpoint: "<azure-cosmos-db-nosql-account-endpoint>",
    tokenCredential: new DefaultAzureCredential()
);

Datenbank abrufen

Verwenden Sie client.GetDatabase, um die vorhandene Datenbank mit dem Namen cosmicworks abzurufen.

Database database = client.GetDatabase("cosmicworks");

Container abrufen

Rufen Sie den vorhandenen products-Container mithilfe von database.GetContainer ab.

Container container = database.GetContainer("products");

Erstellen eines Elements

Erstellen Sie einen C#-Eintragstyp mit allen Membern, die Sie in JSON serialisieren möchten. In diesem Beispiel weist der Typ einen eindeutigen Bezeichner und Felder für Kategorie, Name, Menge, Preis und Verkauf auf.

public record Product(
    string id,
    string category,
    string name,
    int quantity,
    decimal price,
    bool clearance
);

Erstellen Sie mithilfe von container.UpsertItem ein Element im Container. Mit dieser Methode wird ein Upsertvorgang für das Element ausgeführt, wodurch es effektiv ersetzt wird (sofern schon vorhanden).

Product item = new(
    id: "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    category: "gear-surf-surfboards",
    name: "Yamba Surfboard",
    quantity: 12,
    price: 850.00m,
    clearance: false
);

ItemResponse<Product> response = await container.UpsertItemAsync<Product>(
    item: item,
    partitionKey: new PartitionKey("gear-surf-surfboards")
);

Lesen eines Elements

Führen Sie einen Punktlesevorgang aus, indem Sie sowohl die eindeutigen Bezeichner (id) als auch die Partitionsschlüsselfelder verwenden. Verwenden Sie container.ReadItem, um das jeweilige Element effizient abzurufen.

ItemResponse<Product> response = await container.ReadItemAsync<Product>(
    id: "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partitionKey: new PartitionKey("gear-surf-surfboards")
);

Abfrageelemente

Führen Sie mithilfe von container.GetItemQueryIterator eine Abfrage für mehrere Elemente in einem Container durch. Suchen Sie alle Elemente in einer angegebenen Kategorie mithilfe dieser parametrisierten Abfrage:

SELECT * FROM products p WHERE p.category = @category

string query = "SELECT * FROM products p WHERE p.category = @category"

var query = new QueryDefinition(query)
  .WithParameter("@category", "gear-surf-surfboards");

using FeedIterator<Product> feed = container.GetItemQueryIterator<Product>(
    queryDefinition: query
);

Parsen Sie die paginierten Ergebnisse der Abfrage, indem Sie jede Ergebnisseite mit feed.ReadNextAsync in einer Schleife durchlaufen. Verwenden Sie feed.HasMoreResults, um zu ermitteln, ob zu Beginn jeder Schleife Ergebnisse vorhanden sind.

List<Product> items = new();
while (feed.HasMoreResults)
{
    FeedResponse<Product> response = await feed.ReadNextAsync();
    foreach (Product item in response)
    {
        items.Add(item);
    }
}

Bereinigen von Ressourcen

Wenn Sie die Beispielanwendung oder Ressourcen nicht mehr benötigen, entfernen Sie die entsprechende Bereitstellung und alle Ressourcen.

azd down

Zugehöriger Inhalt