Übung: Erstellen einer .NET-App und eines Referenz-SDK

  • 7 Minuten

Als ersten Schritt zum Erstellen der Anwendung Ihres Projekts müssen Sie ein .NET-Projekt erstellen. Erinnern Sie sich daran, dass das .NET-Projekt das Microsoft.Azure.Cosmos-SDK verwenden sollte, um sich mit dem Konto zu verbinden, das Sie bereits erstellt haben. Derzeit gibt es drei wichtige Anforderungen:

  • Erstellen eines .NET-Projekts.
  • Hinzufügen eines Paketverweises auf das SDK.
  • Herstellen einer Verbindung mithilfe der Clientklassen.

Illustration of icons of an Azure Cosmos DB account and .NET application.

Nachdem Sie diese Übung abgeschlossen haben, verfügen Sie über eine einfache .NET-Anwendung, die erfolgreich eine Verbindung mit Ihrem API für NoSQL-Konto herstellt, aber noch keine Vorgänge ausführt.

Erstellen eines .NET-Konsolenprojekts

Die .NET CLI erstellt und verwaltet .NET-Projekte in einem angegebenen Verzeichnis. Hier verwenden Sie die Befehlszeilenschnittstelle, um eine neue Konsolenanwendung zu erstellen und einen Paketverweis zum SDK hinzuzufügen.

  1. Erstellen Sie eine neue Konsolenanwendung im aktuellen Verzeichnis.

    dotnet new console

    Tipp

    Da Sie weder einen Projektnamen noch ein Verzeichnis angegeben haben, erstellt der Befehl das neue Projekt im aktuellen Verzeichnis und nennt das Projekt entsprechend dem Namen des Verzeichnisses (inventory).

  2. Fügen Sie einen Paketverweis auf Version 3 des Microsoft.Azure.Cosmos SDK aus NuGet hinzu.

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

  3. Erstellen Sie das .NET-Projekt, um sicherzustellen, dass Sie Ihr Projekt korrekt konfiguriert haben.

    dotnet build

    Die Ausgabe des Befehls sollte dem folgenden Beispiel ähneln:

    MSBuild version 17.5.0+6f08c67f3 for .NET
  Determining projects to restore...
  All projects are up-to-date for restore.
  dotnet-env-azure-cosmos-db -> /workspaces/dotnet-env-azure-cosmos-db/bin/Debug/net7.0/dotnet-env-azure-cosmos-db.dll

Build succeeded.
    0 Warning(s)
    0 Error(s)

Time Elapsed 00:00:05.96

Herstellen einer Verbindung mit dem Konto

Jetzt sollte das .NET-Projekt erstellt und bereit sein, damit Sie Ihren eigenen benutzerdefinierten Code hinzufügen können. Sie haben Zugriff auf den Microsoft.Azure.Cosmos-Namespace und alle Klassen, die zum Herstellen einer Verbindung mit der API für NoSQL erforderlich sind. Hier öffnen Sie die Datei Program.cs und implementieren Code zum Herstellen einer Verbindung mit dem Konto mithilfe der Clientklassen des SDK.

  1. Öffnen Sie im Code-Editor die Datei Program.cs.

  2. Löschen Sie jeglichen vorhandenen Code in der Datei.

  3. Fügen Sie using-Anweisungen für die folgenden Namespaces hinzu:

    using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.Fluent;
using Microsoft.Azure.Cosmos.Linq;

  4. Erstellen Sie eine Zeichenfolgenvariable für eine Konstante namens connectionString. Legen Sie den Wert der Variablen auf die Verbindungszeichenfolge fest, die Sie zuvor in diesem Modul notiert haben.

    const string connectionString = "<your-azure-cosmos-db-connection-string>";

    Tipp

    Angenommen, der Name des Azure Cosmos DB-Kontos ist nybncrsna76fo-cosmos-nosql und der Schlüssel ist Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==, dann würden Sie die Verbindungszeichenfolge wie in diesem Beispiel konfigurieren:

    const string connectionString = "AccountEndpoint=https://nybncrsna76fo-cosmos-nosql.documents.azure.com:443/;AccountKey=Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==;";

  5. Geben Sie die Verbindungszeichenfolge in die Konsole aus.

    Console.WriteLine($"[Connection string]:\t{connectionString}");

  6. Erstellen Sie eine neue Instanz der CosmosSerializationOptions-Klasse namens serializerOptions. Legen Sie die PropertyNamingPolicy-Eigenschaft auf den Wert CamelCase aus der CamelCase-Enumeration fest.

    CosmosSerializationOptions serializerOptions = new()
{
    PropertyNamingPolicy = CosmosPropertyNamingPolicy.CamelCase
};

  7. Erstellen Sie eine neue Instanz der CosmosClientBuilder-Klasse, indem Sie die Verbindungszeichenfolge an den Konstruktor übergeben. Verketten Sie als Nächstes die Fluent-Methode WithSerializerOptions(CosmosSerializationOptions), und legen Sie den Parameter dieser Methode auf serializerOptions fest. Verketten Sie die Build()-Methode, um eine Instanz des Typs CosmosClient namens client zu erstellen. Umschließen Sie schließlich die Erstellung der Clientvariablen mit einer using-Anweisung.

    using CosmosClient client = new CosmosClientBuilder(connectionString)
    .WithSerializerOptions(serializerOptions)
    .Build();

  8. Geben Sie eine Nachricht aus, die angibt, dass Ihr Client bereit ist.

    Console.WriteLine("[Client ready]");

  9. Speichern Sie die Datei Program.cs.

Arbeit überprüfen

Die Anwendung ist jetzt ausführungsbereit und kann eine Verbindung mit Azure Cosmos DB for NoSQL herstellen. Hier vergleichen Sie Ihren Anwendungscode mit dem Beispiel. Überprüfen Sie anschließend, ob Ihre Anwendung wie erwartet funktioniert, indem Sie den Code ausführen.

  1. Ausführen der .NET-Anwendung im Terminal

    dotnet run

  2. Beobachten Sie die Ausgabe der Ausführung der Anwendung. Die Ausgabe sollte dem folgenden Beispiel entsprechen.

    [Connection string]:    <your-azure-cosmos-db-connection-string>
[Client ready]

Hinweis

Wenn das Erstellen oder Ausführen der .NET-Anwendung zu einem Fehler führt, wechseln Sie zur Registerkarte Überprüfen von Code, um zu überprüfen, ob Ihr Code dem Beispiel entspricht.