Szybki start: biblioteka Azure Cosmos DB for NoSQL dla platformy .NET

DOTYCZY: NoSQL

• .NET
• JavaScript/Node.js
• Java
• Python
• Przejdź

Rozpocznij pracę z biblioteką klienta usługi Azure Cosmos DB for NoSQL dla platformy .NET, aby wykonywać zapytania o dane w kontenerach i wykonywać typowe operacje na poszczególnych elementach. Wykonaj następujące kroki, aby wdrożyć minimalne rozwiązanie w środowisku przy użyciu interfejsu wiersza polecenia dla deweloperów platformy Azure.

Dokumentacja interfejsu API — pakiet | kodu | źródłowego biblioteki (NuGet) | Interfejs wiersza polecenia dla deweloperów platformy Azure

Wymagania wstępne

• Konto platformy Azure z aktywną subskrypcją. Utwórz konto bezpłatnie.
• Konto usługi GitHub

• Konto platformy Azure z aktywną subskrypcją. Utwórz konto bezpłatnie.
• Interfejs wiersza polecenia dla deweloperów platformy Azure
• Docker Desktop

Konfigurowanie

Wdróż kontener projektowy w swoim środowisku. Następnie użyj interfejsu wiersza polecenia dla deweloperów platformy Azure (azd), aby utworzyć konto usługi Azure Cosmos DB for NoSQL i wdrożyć konteneryzowaną przykładową aplikację. Przykładowa aplikacja używa biblioteki klienta do zarządzania, tworzenia, odczytywania i wykonywania zapytań dotyczących przykładowych danych.

Ważne

Konta usługi GitHub obejmują uprawnienia do magazynowania i godzin podstawowych bez ponoszenia kosztów. Aby uzyskać więcej informacji, zobacz uwzględnione godziny magazynowania i rdzeni dla kont usługi GitHub.

1. Otwórz terminal w katalogu głównym projektu.

2. Uwierzytelnianie w interfejsie wiersza polecenia dla deweloperów platformy Azure przy użyciu polecenia azd auth login. Wykonaj kroki określone przez narzędzie, aby uwierzytelnić się w interfejsie wiersza polecenia przy użyciu preferowanych poświadczeń platformy Azure.

   azd auth login
   

3. Użyj azd init polecenia , aby zainicjować projekt.

   azd init
   

4. Podczas inicjowania skonfiguruj unikatową nazwę środowiska.

   Napiwek

   Nazwa środowiska będzie również używana jako nazwa docelowej grupy zasobów. W tym przewodniku Szybki start rozważ użycie polecenia msdocs-cosmos-db-.

5. Wdróż konto usługi Azure Cosmos DB przy użyciu polecenia azd up. Szablony Bicep wdrażają również przykładową aplikację internetową.

   azd up
   

6. Podczas procesu aprowizacji wybierz subskrypcję i żądaną lokalizację. Poczekaj na zakończenie procesu aprowizacji. Proces może potrwać około pięciu minut.

7. Po zakończeniu aprowizacji zasobów platformy Azure adres URL uruchomionej aplikacji internetowej zostanie uwzględniony w danych wyjściowych.

   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. Użyj adresu URL w konsoli, aby przejść do aplikacji internetowej w przeglądarce. Obserwuj dane wyjściowe uruchomionej aplikacji.

   

Instalowanie biblioteki klienta

Biblioteka klienta jest dostępna za pośrednictwem pakietu NuGet Microsoft.Azure.Cosmos .

1. Otwórz terminal i przejdź do /src/web folderu.

   cd ./src/web
   

2. Jeśli pakiet nie został jeszcze zainstalowany, zainstaluj go Microsoft.Azure.Cosmos przy użyciu polecenia dotnet add package.

   dotnet add package Microsoft.Azure.Cosmos
   

3. Ponadto zainstaluj Azure.Identity pakiet, jeśli nie został jeszcze zainstalowany.

   dotnet add package Azure.Identity
   

4. Otwórz i przejrzyj plik src/web/Cosmos.Samples.NoSQL.Quickstart.Web.csproj , aby sprawdzić, czy Microsoft.Azure.CosmosAzure.Identity oba wpisy istnieją.

Model obiektów

Nazwa/nazwisko	opis
CosmosClient	Ta klasa jest podstawową klasą klienta i służy do zarządzania metadanymi lub bazami danych dla całego konta.
Database	Ta klasa reprezentuje bazę danych w ramach konta.
Container	Ta klasa jest używana głównie do wykonywania operacji odczytu, aktualizacji i usuwania w kontenerze lub elementach przechowywanych w kontenerze.
PartitionKey	Ta klasa reprezentuje klucz partycji logicznej. Ta klasa jest wymagana w przypadku wielu typowych operacji i zapytań.

Przykłady kodu

• Uwierzytelnianie użytkownika
• Pobieranie bazy danych
• Pobieranie kontenera
• Tworzenie elementu
• Pobieranie elementu
• Elementy kwerend

Przykładowy kod w szablonie używa bazy danych o nazwie i kontenera o nazwie cosmicworksproducts. Kontener products zawiera szczegóły, takie jak nazwa, kategoria, ilość, unikatowy identyfikator i flaga sprzedaży dla każdego produktu. Kontener używa /category właściwości jako klucza partycji logicznej.

Uwierzytelnianie użytkownika

Żądania aplikacji do większości usług platformy Azure muszą być autoryzowane. DefaultAzureCredential Użyj typu jako preferowanego sposobu implementacji połączenia bez hasła między aplikacjami i usługą Azure Cosmos DB for NoSQL. DefaultAzureCredential obsługuje wiele metod uwierzytelniania i określa, która metoda powinna być używana w czasie wykonywania.

Ważne

Możesz również autoryzować żądania do usług platformy Azure przy użyciu haseł, parametry połączenia lub innych poświadczeń bezpośrednio. Należy jednak zachować ostrożność przy użyciu tego podejścia. Deweloperzy muszą być sumienni, aby nigdy nie ujawniać tych wpisów tajnych w niezabezpieczonej lokalizacji. Każdy, kto uzyskuje dostęp do hasła lub klucza tajnego, może uwierzytelnić się w usłudze bazy danych. DefaultAzureCredential oferuje ulepszone korzyści związane z zarządzaniem i zabezpieczeniami za pośrednictwem klucza konta, aby umożliwić uwierzytelnianie bez hasła bez ryzyka przechowywania kluczy.

Ten przykład tworzy nowe wystąpienie CosmosClient klasy i uwierzytelnia się przy użyciu DefaultAzureCredential wystąpienia.

CosmosClient client = new(
    accountEndpoint: builder.Configuration["AZURE_COSMOS_DB_NOSQL_ENDPOINT"]!,
    tokenCredential: new DefaultAzureCredential()
);

Pobieranie bazy danych

Użyj client.GetDatabase polecenia , aby pobrać istniejącą bazę danych o nazwie cosmicworks.

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

Pobieranie kontenera

Pobierz istniejący products kontener przy użyciu polecenia database.GetContainer.

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

Tworzenie elementu

Skompiluj typ rekordu języka C# ze wszystkimi elementami członkowskimi, które chcesz serializować w formacie JSON. W tym przykładzie typ ma unikatowy identyfikator i pola dla kategorii, nazwy, ilości, ceny i sprzedaży.

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

Utwórz element w kontenerze przy użyciu polecenia container.UpsertItem. Ta metoda "upserts" element skutecznie zastępuje element, jeśli już istnieje.

Product item = new(
    id: "68719518391",
    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")
);

Odczytywanie elementu

Wykonaj operację odczytu punktu przy użyciu pól unikatowego identyfikatora (id) i klucza partycji. Służy container.ReadItem do wydajnego pobierania określonego elementu.

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

Elementy kwerend

Wykonaj zapytanie dotyczące wielu elementów w kontenerze przy użyciu polecenia container.GetItemQueryIterator. Znajdź wszystkie elementy w określonej kategorii przy użyciu tego sparametryzowanego zapytania:

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

var query = new QueryDefinition(
    query: "SELECT * FROM products p WHERE p.category = @category"
)
    .WithParameter("@category", "gear-surf-surfboards");

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

Przeanalizuj wyniki zapytania podzielonego na strony, wykonując pętlę na każdej stronie wyników przy użyciu polecenia feed.ReadNextAsync. Użyj feed.HasMoreResults polecenia , aby określić, czy istnieją jakiekolwiek wyniki pozostawione na początku każdej pętli.

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

Czyszczenie zasobów

Jeśli nie potrzebujesz już przykładowej aplikacji lub zasobów, usuń odpowiednie wdrożenie i wszystkie zasoby.

azd down

W usłudze GitHub Codespaces usuń działającą przestrzeń kodu, aby zmaksymalizować uprawnienia magazynu i rdzenia.

Powiązana zawartość

• Przewodnik Szybki start dotyczący języka JavaScript/Node.js
• Przewodnik Szybki start dla języka Java
• Przewodnik Szybki start dla języka Python
• Szybki start dla języka Go

Następny krok

Samouczek: tworzenie aplikacji konsolowej platformy .NET