Guia de início rápido: usar o Azure Cosmos DB para NoSQL com o SDK do Azure para .NET

• Aplica-se a:

  ✅ NoSQL

• .NET
• Node.js
• Java
• Python
• Ir

Neste início rápido, você implanta um aplicativo básico do Azure Cosmos DB for Table usando o SDK do Azure para .NET. O Azure Cosmos DB for Table é um armazenamento de dados sem esquema que permite que os aplicativos armazenem dados de tabela estruturada na nuvem. Você aprende a criar tabelas, linhas e executar tarefas básicas em seu recurso do Azure Cosmos DB usando o SDK do Azure para .NET.

Documentação | de referência da API Pacote de código-fonte | da biblioteca (NuGet) | CLI do desenvolvedor do Azure

Pré-requisitos

• Azure Developer CLI
• Área de trabalho do Docker
• .NET 9.0

Se não tiver uma conta do Azure, crie uma conta gratuita antes de começar.

Inicializar o projeto

Use a CLI do Desenvolvedor do Azure (azd) para criar uma conta do Azure Cosmos DB for Table e implantar um aplicativo de exemplo em contêiner. O aplicativo de exemplo usa a biblioteca de cliente para gerenciar, criar, ler e consultar dados de exemplo.

1. Abra um terminal em um diretório vazio.

2. Se você ainda não estiver autenticado, autentique-se na CLI do Desenvolvedor do Azure usando azd auth logino . Siga as etapas especificadas pela ferramenta para autenticar na CLI usando suas credenciais preferidas do Azure.

   azd auth login
   

3. Use azd init para inicializar o projeto.

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

4. Durante a inicialização, configure um nome de ambiente exclusivo.

5. Implante a conta do Azure Cosmos DB usando azd upo . Os modelos Bicep também implantam um aplicativo Web de exemplo.

   azd up
   

6. Durante o processo de provisionamento, selecione sua assinatura, o local desejado e o grupo de recursos de destino. Aguarde a conclusão do processo de provisionamento. O processo pode levar aproximadamente cinco minutos.

7. Depois que o provisionamento dos recursos do Azure for concluído, uma URL para o aplicativo Web em execução será incluída na saída.

   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. Use o URL no console para navegar até seu aplicativo Web no navegador. Observe a saída do aplicativo em execução.

Instalar a biblioteca de cliente

A biblioteca do cliente está disponível através do NuGet, como o Microsoft.Azure.Cosmos pacote.

1. Abra um terminal e navegue até a /src/web pasta.

   cd ./src/web
   

2. Se ainda não estiver instalado, instale o pacote usando dotnet add packageo Microsoft.Azure.Cosmos .

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

3. Além disso, instale o Azure.Identity pacote se ainda não estiver instalado.

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

4. Abra e revise o arquivo src/web/Cosmos.Samples.NoSQL.Quickstart.Web.csproj para validar se as Microsoft.Azure.Cosmos entradas e Azure.Identity existem.

Modelo de objeto

Nome	Descrição
CosmosClient	Essa classe é a classe de cliente principal e é usada para gerenciar metadados ou bancos de dados em toda a conta.
Database	Essa classe representa um banco de dados dentro da conta.
Container	Essa classe é usada principalmente para executar operações de leitura, atualização e exclusão no contêiner ou nos itens armazenados dentro do contêiner.
PartitionKey	Esta classe representa uma chave de partição lógica. Essa classe é necessária para muitas operações e consultas comuns.

Exemplos de código

• Autenticar o cliente
• Obter uma base de dados
• Obter um contentor
• Criar um item
• Obter um item
• Itens de consulta

O código de exemplo no modelo usa um banco de dados chamado cosmicworks e um contêiner chamado products. O products recipiente contém detalhes como nome, categoria, quantidade, um identificador exclusivo e um sinalizador de venda para cada produto. O contêiner usa a /category propriedade como uma chave de partição lógica.

Autenticar o cliente

Este exemplo cria uma nova instância da CosmosClient classe e autentica usando uma DefaultAzureCredential instância.

DefaultAzureCredential credential = new();

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

Obter uma base de dados

Use client.GetDatabase para recuperar o banco de dados existente chamado cosmicworks.

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

Obter um contentor

Recupere o contêiner existente products usando database.GetContainero .

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

Criar um item

Crie um tipo de registro C# com todos os membros que você deseja serializar em JSON. Neste exemplo, o tipo tem um identificador exclusivo e campos para categoria, nome, quantidade, preço e venda.

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

Crie um item no contêiner usando container.UpsertItemo . Este método "upserts" o item efetivamente substituindo o item se ele já existe.

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

Ler um item

Execute uma operação de leitura pontual usando os campos identificador exclusivo (id) e chave de partição. Use container.ReadItem para recuperar eficientemente o item específico.

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

Itens de consulta

Execute uma consulta sobre vários itens em um contêiner usando container.GetItemQueryIteratoro . Encontre todos os itens dentro de uma categoria especificada usando esta consulta parametrizada:

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

Analise os resultados paginados da consulta fazendo um loop em cada página de resultados usando feed.ReadNextAsync. Use feed.HasMoreResults para determinar se há algum resultado restante no início de cada loop.

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

Clean up resources (Limpar recursos)

Quando você não precisar mais do aplicativo ou recursos de exemplo, remova a implantação correspondente e todos os recursos.

azd down

Conteúdos relacionados

• Guia de início rápido Node.js
• Início Rápido do Python
• Início Rápido do Java
• Ir Guia de início rápido