Övning – Skapa .NET-app och referens-SDK

  • 7 minuter

Som det första steget för att skapa projektets program måste du skapa ett .NET-projekt. Kom ihåg att .NET-projektet bör använda Microsoft.Azure.Cosmos SDK för att ansluta till det konto som du redan har skapat. Det finns tre viktiga krav just nu:

  • Skapa ett .NET-projekt
  • Lägga till en paketreferens till SDK
  • Anslut med hjälp av klientklasserna

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

När du har slutfört den här övningen har du ett enkelt .NET-program som ansluter till ditt API för NoSQL-konto, men som inte utför några åtgärder ännu.

Skapa ett .NET-konsolprojekt

.NET CLI skapar och hanterar .NET-projekt i en angiven katalog. Här använder du CLI för att skapa ett nytt konsolprogram och lägga till en paketreferens till SDK:n.

  1. Skapa ett nytt konsolprogram i den aktuella katalogen.

    dotnet new console

    Dricks

    Eftersom du inte angav något projektnamn eller en katalog skapar kommandot det nya projektet i den aktuella katalogen och namnger projektet så att det matchar katalogens namn (inventering).

  2. Lägg till en paketreferens till version 3 av Microsoft.Azure.Cosmos SDK från NuGet.

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

  3. Skapa .NET-projektet för att säkerställa att du har konfigurerat projektet korrekt.

    dotnet build

    Kommandots utdata bör likna det här exemplet:

    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

Anslut till kontot

Nu bör .NET-projektet skapas och vara redo för att du ska kunna lägga till din egen anpassade kod. Du har åtkomst till Microsoft.Azure.Cosmos namnområdet och alla klasser som krävs för att ansluta till API:et för NoSQL. Här öppnar du filen Program.cs och implementerar kod för att ansluta till kontot med hjälp av SDK:s klientklasser.

  1. Öppna filen Program.cs i kodredigeraren.

  2. Ta bort all befintlig kod från filen.

  3. Lägg till med hjälp av direktiv för följande namnområden:

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

  4. Skapa en konstant strängvariabel med namnet connectionString. Ange värdet för variabeln till den anslutningssträng som du registrerade tidigare i den här modulen.

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

    Dricks

    Förutsatt att namnet på Azure Cosmos DB-kontot är nybncrsna76fo-cosmos-nosql och nyckeln är Aj2OSQqWhXfFzkITIi4MIbocWAAoBCUWnSPzHlQbDYA3TiyZCJlk8A6R1l6WqD45BxAG5vrsyQ4SCXEkPS1pLh==konfigurerar du anslutningssträng som i det här exemplet:

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

  5. Skriv ut anslutningssträng till konsolen.

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

  6. Skapa en ny instans av CosmosSerializationOptions klassen serializerOptions. PropertyNamingPolicy Ange egenskapen till värdet CamelCase från CamelCase uppräkningen.

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

  7. Skapa en ny instans av CosmosClientBuilder klassen genom att skicka anslutningssträng till konstruktorn. Därefter kedjar WithSerializerOptions(CosmosSerializationOptions) du metoden fluent och anger parametern för den här metoden till serializerOptions. Build() Länka metoden för att skapa en instans av typen CosmosClient med namnet client. Slutligen omsluter du skapandet av klientvariabeln med en using-instruktion.

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

  8. Skriv ut ett meddelande som anger att klienten är klar.

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

  9. Spara filen Program.cs.

Kontrollera ditt arbete

Programmet är nu redo att köras och ansluta till Azure Cosmos DB för NoSQL. Här jämför du programkoden med vårt exempel. Sedan kontrollerar du att programmet fungerar som förväntat genom att köra koden.

  1. Kör .NET-programmet i terminalen

    dotnet run

  2. Observera utdata från körningen av programmet. Utdata ska matcha exemplet här.

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

Kommentar

Om det uppstår ett fel när du skapar eller kör .NET-programmet går du till fliken Granska kod för att kontrollera att koden matchar exemplet.