Introdução ao Azure Cosmos DB para NoSQL usando .NET

  • Artigo

APLICA-SE A: NoSQL

Este artigo mostra como se conectar ao Azure Cosmos DB para NoSQL usando o SDK do .NET. Uma vez conectado, você pode executar operações em bancos de dados, contêineres e itens.

Pacote (NuGet) | Exemplos | Referência | da API Código-fonte | da biblioteca Enviar comentários

Pré-requisitos

Configure o seu projeto

Criar o aplicativo de console .NET

Crie um novo aplicativo .NET usando o comando com o dotnet newmodelo de console .

dotnet new console

Importe o pacote NuGet do Microsoft.Azure.Cosmos usando o dotnet add packagecomando.

dotnet add package Microsoft.Azure.Cosmos

Crie o projeto com o dotnet build comando.

dotnet build

Conectar-se ao Azure Cosmos DB para NoSQL

Para se conectar à API para NoSQL do Azure Cosmos DB, crie uma instância da CosmosClient classe. Essa classe é o ponto de partida para executar todas as operações em bancos de dados. Há três maneiras principais de se conectar a uma API para conta NoSQL usando a classe CosmosClient :

Conecte-se com um ponto de extremidade e uma chave

O construtor mais comum para CosmosClient tem dois parâmetros:

Parâmetro Valor de exemplo Descrição
accountEndpoint COSMOS_ENDPOINT variável de ambiente API para ponto de extremidade NoSQL a ser usado para todas as solicitações
authKeyOrResourceToken COSMOS_KEY variável de ambiente Chave de conta ou token de recurso a ser usado ao autenticar

Recuperar o ponto final e a chave da sua conta

  1. Crie uma variável de shell para resourceGroupName.

    # Variable for resource group name
resourceGroupName="msdocs-cosmos-dotnet-howto-rg"

  2. Use o comando para recuperar o az cosmosdb list nome da primeira conta do Azure Cosmos DB em seu grupo de recursos e armazená-lo na variável de shell accountName .

    # Retrieve most recently created account name
accountName=$(
    az cosmosdb list \
        --resource-group $resourceGroupName \
        --query "[0].name" \
        --output tsv
)

  3. Obtenha o URI de ponto de extremidade da API para NoSQL para a conta usando o az cosmosdb show comando.

    az cosmosdb show \
    --resource-group $resourceGroupName \
    --name $accountName \
    --query "documentEndpoint"

  4. Encontre a CHAVE PRIMÁRIA na lista de chaves da conta com o az-cosmosdb-keys-list comando.

    az cosmosdb keys list \
    --resource-group $resourceGroupName \
    --name $accountName \
    --type "keys" \
    --query "primaryMasterKey"

  5. Registre os valores de URI e CHAVE PRIMÁRIA . Você usará essas credenciais mais tarde.

Para usar os valores de URI e CHAVE PRIMÁRIA em seu código .NET, persista-os para novas variáveis de ambiente na máquina local que executa o aplicativo.

$env:COSMOS_ENDPOINT = "<cosmos-account-URI>"
$env:COSMOS_KEY = "<cosmos-account-PRIMARY-KEY>"

Crie o CosmosClient com o ponto final e a chave da conta

Crie uma nova instância da classe CosmosClient com as COSMOS_ENDPOINT variáveis e COSMOS_KEY de ambiente como parâmetros.

// New instance of CosmosClient class using an endpoint and key string
using CosmosClient client = new(
    accountEndpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
    authKeyOrResourceToken: Environment.GetEnvironmentVariable("COSMOS_KEY")!
);

Conectar-se com uma cadeia de conexão

Outro construtor para CosmosClient contém apenas um único parâmetro:

Parâmetro Valor de exemplo Descrição
accountEndpoint COSMOS_ENDPOINT variável de ambiente API para ponto de extremidade NoSQL a ser usado para todas as solicitações
connectionString COSMOS_CONNECTION_STRING variável de ambiente Cadeia de conexão com a API para conta NoSQL

Recuperar a cadeia de conexão da sua conta

  1. Use o comando para recuperar o az cosmosdb list nome da primeira conta do Azure Cosmos DB em seu grupo de recursos e armazená-lo na variável de shell accountName .

    # Retrieve most recently created account name
accountName=$(
    az cosmosdb list \
        --resource-group $resourceGroupName \
        --query "[0].name" \
        --output tsv
)

  2. Encontre a CADEIA DE CONEXÃO PRIMÁRIA na lista de cadeias de conexão da conta com o az-cosmosdb-keys-list comando.

    az cosmosdb keys list \
    --resource-group $resourceGroupName \
    --name $accountName \
    --type "connection-strings" \
    --query "connectionStrings[?description == \`Primary SQL Connection String\`] | [0].connectionString"

Para usar o valor PRIMARY CONNECTION STRING dentro do seu código .NET, persista-o para uma nova variável de ambiente na máquina local que executa o aplicativo.

$env:COSMOS_CONNECTION_STRING = "<cosmos-account-PRIMARY-CONNECTION-STRING>"

Criar CosmosClient com cadeia de conexão

Crie uma nova instância da classe CosmosClient com a COSMOS_CONNECTION_STRING variável de ambiente como o único parâmetro.

// New instance of CosmosClient class using a connection string
using CosmosClient client = new(
    connectionString: Environment.GetEnvironmentVariable("COSMOS_CONNECTION_STRING")!
);

Conectar-se usando a plataforma de identidade da Microsoft

Para se conectar à sua API para conta NoSQL usando a plataforma de identidade da Microsoft e o Microsoft Entra ID, use uma entidade de segurança. O tipo exato de entidade dependerá de onde você hospeda o código do aplicativo. A tabela abaixo serve como um guia de referência rápida.

Onde o aplicativo é executado Principal de segurança
Máquina local (desenvolvimento e testes) Identidade do usuário ou entidade de serviço
Azure Identidade gerida
Servidores ou clientes fora do Azure Service principal (Principal de serviço)

Importar Azure.Identity

O pacote NuGet Azure.Identity contém a funcionalidade de autenticação principal que é compartilhada entre todas as bibliotecas do SDK do Azure.

Importe o pacote NuGet do Azure.Identity usando o dotnet add packagecomando.

dotnet add package Azure.Identity

Reconstrua o projeto com o dotnet build comando.

dotnet build

No editor de códigos, adicione usando diretivas para Azure.Core e Azure.Identity namespaces.

using Azure.Core;
using Azure.Identity;

Criar CosmosClient com implementação de credenciais padrão

Se você estiver testando em uma máquina local ou se seu aplicativo for executado nos serviços do Azure com suporte direto para identidades gerenciadas, obtenha um token OAuth criando uma DefaultAzureCredential instância.

Neste exemplo, salvamos a instância em uma variável de tipo, pois é um tipo TokenCredential mais genérico que pode ser reutilizado em SDKs.

// Credential class for testing on a local machine or Azure services
TokenCredential credential = new DefaultAzureCredential();

Crie uma nova instância da classe CosmosClient com a COSMOS_ENDPOINT variável de ambiente e o objeto TokenCredential como parâmetros.

// New instance of CosmosClient class using a connection string
using CosmosClient client = new(
    accountEndpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
    tokenCredential: credential
);

Criar CosmosClient com uma implementação de credencial personalizada

Se você planeja implantar o aplicativo fora do Azure, pode obter um token OAuth usando outras classes na biblioteca de cliente Azure.Identity para .NET. Estas outras classes também derivam da TokenCredential classe.

Neste exemplo, criamos uma ClientSecretCredential instância usando identificadores de cliente e locatário, juntamente com um segredo de cliente.

// Custom credential class for servers and clients outside of Azure
TokenCredential credential = new ClientSecretCredential(
    tenantId: Environment.GetEnvironmentVariable("AAD_TENANT_ID")!,
    clientId: Environment.GetEnvironmentVariable("AAD_CLIENT_ID")!,
    clientSecret: Environment.GetEnvironmentVariable("AAD_CLIENT_SECRET")!,
    options: new TokenCredentialOptions()
);

Você pode obter a ID do cliente, a ID do locatário e o segredo do cliente ao registrar um aplicativo no Microsoft Entra ID. Para obter mais informações sobre como registrar aplicativos do Microsoft Entra, consulte Registrar um aplicativo com a plataforma de identidade da Microsoft.

Crie uma nova instância da classe CosmosClient com a COSMOS_ENDPOINT variável de ambiente e o objeto TokenCredential como parâmetros.

// New instance of CosmosClient class using a connection string
using CosmosClient client = new(
    accountEndpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
    tokenCredential: credential
);

Compilar a aplicação

À medida que você cria seu aplicativo, seu código interage principalmente com quatro tipos de recursos:

  • A API para conta NoSQL, que é o namespace de nível superior exclusivo para seus dados do Azure Cosmos DB.

  • Bases de dados, que organizam os contentores na sua conta.

  • Contêineres, que contêm um conjunto de itens individuais em seu banco de dados.

  • Itens, que representam um documento JSON em seu contêiner.

O diagrama seguinte mostra a relação entre estes recursos.

Diagram of the Azure Cosmos DB hierarchy including accounts, databases, containers, and items.

Cada tipo de recurso é representado por uma ou mais classes .NET associadas. Aqui está uma lista das classes mais comuns:

Classe Descrição
CosmosClient Essa classe fornece uma representação lógica do lado do cliente para o serviço Azure Cosmos DB. O objeto cliente é usado para configurar e executar solicitações no serviço.
Database Essa classe é uma referência a um banco de dados que pode, ou não, existir no serviço ainda. O banco de dados é validado no lado do servidor quando você tenta acessá-lo ou executar uma operação em relação a ele.
Container Essa classe é uma referência a um contêiner que também pode não existir no serviço ainda. O contêiner é validado no lado do servidor quando você tenta trabalhar com ele.

Os guias a seguir mostram como usar cada uma dessas classes para criar seu aplicativo.

Guia Descrição
Criar uma base de dados Criar bases de dados
Criar um contêiner Criar contêineres
Ler um item Ponto de leitura de um item específico
Itens de consulta Consultar vários itens

Consulte também

Próximos passos

Agora que você se conectou a uma conta API para NoSQL, use o próximo guia para criar e gerenciar bancos de dados.

Criar um banco de dados no Azure Cosmos DB para NoSQL usando .NET