Quickstart: Azure Cosmos DB for NoSQL-bibliotheek voor .NET

Artikel
01/10/2024

VAN TOEPASSING OP: NoSQL

Ga aan de slag met de Azure Cosmos DB for NoSQL-clientbibliotheek voor .NET om gegevens in uw containers op te vragen en algemene bewerkingen uit te voeren op afzonderlijke items. Volg deze stappen om een minimale oplossing in uw omgeving te implementeren met behulp van de Azure Developer CLI.

Api-referentiedocumentatiebibliotheek | broncodepakket | (NuGet) | Azure Developer CLI

Vereisten

Een Azure-account met een actief abonnement. Gratis een account maken
Een GitHub-account

Een Azure-account met een actief abonnement. Gratis een account maken
Azure Developer CLI
Docker Desktop

Instellen

Implementeer de ontwikkelcontainer van dit project in uw omgeving. Gebruik vervolgens de Azure Developer CLI (azd) om een Azure Cosmos DB for NoSQL-account te maken en een containervoorbeeldtoepassing te implementeren. De voorbeeldtoepassing maakt gebruik van de clientbibliotheek voor het beheren, maken, lezen en opvragen van voorbeeldgegevens.

Belangrijk

GitHub-accounts bevatten gratis rechten voor opslag en kernuren. Zie inbegrepen opslag- en kernuren voor GitHub-accounts voor meer informatie.

Open een terminal in de hoofdmap van het project.
Verifiëren bij de Azure Developer CLI met behulp van azd auth login. Volg de stappen die door het hulpprogramma zijn opgegeven om te verifiëren bij de CLI met behulp van uw favoriete Azure-referenties.
```
azd auth login
```
Gebruik azd init dit om het project te initialiseren.
```
azd init
```
Configureer tijdens de initialisatie een unieke omgevingsnaam.

Tip

De omgevingsnaam wordt ook gebruikt als de naam van de doelresourcegroep. Voor deze quickstart kunt u overwegen .msdocs-cosmos-db-
Implementeer het Azure Cosmos DB-account met behulp van azd up. De Bicep-sjablonen implementeren ook een voorbeeldwebtoepassing.
```
azd up
```
Selecteer tijdens het inrichtingsproces uw abonnement en gewenste locatie. Wacht tot het inrichtingsproces is voltooid. Het proces kan ongeveer vijf minuten duren.

Zodra het inrichten van uw Azure-resources is voltooid, wordt er een URL naar de actieve webtoepassing opgenomen in de uitvoer.

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.

Gebruik de URL in de console om naar uw webtoepassing in de browser te navigeren. Bekijk de uitvoer van de actieve app.

De clientbibliotheek installeren

De clientbibliotheek is beschikbaar via NuGet, als pakket Microsoft.Azure.Cosmos .

Open een terminal en navigeer naar de /src/web map.
```
cd ./src/web
```
Als dit nog niet is geïnstalleerd, installeert u het Microsoft.Azure.Cosmos pakket met behulp van dotnet add package.
```
dotnet add package Microsoft.Azure.Cosmos
```
Installeer ook het Azure.Identity pakket als dat nog niet is geïnstalleerd.
```
dotnet add package Azure.Identity
```
Open en controleer het bestand src/web/Cosmos.Samples.NoSQL.Quickstart.Web.csproj om te valideren dat de Microsoft.Azure.Cosmos en Azure.Identity beide vermeldingen bestaan.

Objectmodel

Name	Beschrijving
CosmosClient	Deze klasse is de primaire clientklasse en wordt gebruikt voor het beheren van metagegevens of databases voor het hele account.
Database	Deze klasse vertegenwoordigt een database binnen het account.
Container	Deze klasse wordt voornamelijk gebruikt om lees-, update- en verwijderbewerkingen uit te voeren op de container of de items die zijn opgeslagen in de container.
PartitionKey	Deze klasse vertegenwoordigt een logische partitiesleutel. Deze klasse is vereist voor veel algemene bewerkingen en query's.

De voorbeeldcode in de sjabloon maakt gebruik van een database met de naam cosmicworks en container.products De products container bevat details zoals naam, categorie, hoeveelheid, een unieke id en een verkoopvlag voor elk product. De container gebruikt de /category eigenschap als een logische partitiesleutel.

De client verifiëren

Toepassingsaanvragen voor de meeste Azure-services moeten worden geautoriseerd. Gebruik het DefaultAzureCredential type als voorkeursmethode om een wachtwoordloze verbinding tussen uw toepassingen en Azure Cosmos DB for NoSQL te implementeren. DefaultAzureCredential ondersteunt meerdere verificatiemethoden en bepaalt welke methode tijdens runtime moet worden gebruikt.

Belangrijk

U kunt aanvragen voor Azure-services ook rechtstreeks autoriseren met behulp van wachtwoorden, verbindingsreeks s of andere referenties. Deze aanpak moet echter met voorzichtigheid worden gebruikt. Ontwikkelaars moeten ijverig zijn om deze geheimen nooit zichtbaar te maken op een onbeveiligde locatie. Iedereen die toegang krijgt tot het wachtwoord of de geheime sleutel, kan zich verifiëren bij de databaseservice. DefaultAzureCredential biedt verbeterde beheer- en beveiligingsvoordelen ten opzichte van de accountsleutel om verificatie zonder wachtwoord mogelijk te maken zonder het risico dat sleutels worden opgeslagen.

In dit voorbeeld wordt een nieuw exemplaar van de CosmosClient klasse gemaakt en wordt geverifieerd met behulp van een DefaultAzureCredential exemplaar.

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

Een database ophalen

Gebruik client.GetDatabase deze om de bestaande database met de naam cosmicworksop te halen.

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

Een container ophalen

Haal de bestaande products container op met behulp van database.GetContainer.

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

Een item maken

Bouw een C#-recordtype met alle leden die u in JSON wilt serialiseren. In dit voorbeeld heeft het type een unieke id en velden voor categorie, naam, hoeveelheid, prijs en verkoop.

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

Maak een item in de container met behulp van container.UpsertItem. Met deze methode wordt het item effectief vervangen als het al bestaat.

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")
);

Een item lezen

Voer een puntleesbewerking uit met behulp van zowel de unieke id (id) als de partitiesleutelvelden. Gebruik container.ReadItem dit om het specifieke item efficiënt op te halen.

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

Query-items

Voer een query uit op meerdere items in een container met behulp van container.GetItemQueryIterator. Zoek alle items in een opgegeven categorie met behulp van deze geparameteriseerde query:

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
);

Parseer de gepagineerde resultaten van de query door elke pagina met resultaten te doorlopen met behulp feed.ReadNextAsyncvan . Gebruik feed.HasMoreResults dit om te bepalen of er resultaten achterblijven aan het begin van elke lus.

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;
}

Resources opschonen

Wanneer u de voorbeeldtoepassing of resources niet meer nodig hebt, verwijdert u de bijbehorende implementatie en alle resources.

azd down

Verwijder in GitHub Codespaces de actieve codespace om uw opslag- en kernrechten te maximaliseren.

Volgende stap

Zelfstudie: Een .NET-consoletoepassing ontwikkelen