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

Neste início rápido, você implanta um aplicativo básico do Azure Cosmos DB para NoSQL usando o SDK do Azure para .NET. O Azure Cosmos DB para NoSQL é um armazenamento de dados sem esquema que permite que os aplicativos armazenem dados não estruturados na nuvem. Consulte dados em seus contêineres e execute operações comuns em itens individuais usando o SDK do Azure para .NET.

Documentação de referência da API | Código-fonte da biblioteca | Pacote (NuGet) | CLI para Desenvolvimento no 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 para NoSQL 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. Caso ainda não esteja autenticado, autentique-se no Azure Developer CLI usando azd auth login. 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 up. Os modelos Bicep também implementam uma aplicação 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 Microsoft.Azure.Cosmos usando dotnet add package.

   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.

Importar bibliotecas

Importe os namespaces Azure.Identity e Microsoft.Azure.Cosmos no código do seu aplicativo.

using Azure.Identity;

using Microsoft.Azure.Cosmos;

Modelo de objeto

Exemplos de código

• Autenticar o cliente
• Obter uma base de dados
• Obtenha 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: credential
);

Obter uma base de dados

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

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

Obtenha um contentor

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

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.UpsertItem. Este método insere ou atualiza o item, substituindo efetivamente o item se ele já existir.

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

Leia o 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 num recipiente usando container.GetItemQueryIterator. 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 queryDefinition = new QueryDefinition(query)
  .WithParameter("@category", "gear-surf-surfboards");

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

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

Explore os seus dados

Utilize a extensão do Visual Studio Code para o Azure Cosmos DB para explorar os seus dados NoSQL. Você pode executar operações principais do banco de dados, incluindo, mas não limitado a:

• Executando consultas usando um álbum de recortes ou o editor de consultas
• Modificando, atualizando, criando e excluindo itens
• Importando dados em massa de outras fontes
• Gerenciando bancos de dados e contêineres

Para obter mais informações, consulte Como usar a extensão de código do Visual Studio para explorar o Azure Cosmos DB para dados NoSQL.

Limpeza de recursos

Quando já não precisar da aplicação ou dos recursos de amostra, remova a implementação correspondente e todos os recursos.

azd down

Conteúdo relacionado

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