.NET Aspire Cosmos DB Entity Framework Core integração

Artigo
01/09/2025

Inclui:Integração de Hosting e Integração Client

Azure Cosmos DB é um serviço de banco de dados NoSQL totalmente gerenciado para desenvolvimento de aplicativos modernos. A integração de .NET AspireCosmos DBEntity Framework Core permite que você se conecte a instâncias de Cosmos DB existentes ou crie novas instâncias a partir de .NET com o emulador de Azure Cosmos DB.

Integração de hospedagem

A integração de hospedagem .NET.NET AspireAzure Cosmos DB modela os vários recursos Cosmos DB como os seguintes tipos:

AzureCosmosDBResource: Representa um recurso AzureAzure Cosmos DB.
AzureCosmosDBEmulatorResource: Representa um recurso de emulador de AzureAzure Cosmos DB.

Para aceder a estes tipos e APIs que os expressam, adicione o pacote NuGet 📦Aspire.Hosting.Azure.CosmosDB no projeto de host da aplicação .

.NET CLI
ReferênciaDoPacote

dotnet add package Aspire.Hosting.Azure.CosmosDB

<PackageReference Include="Aspire.Hosting.Azure.CosmosDB"
                  Version="*" />

Para obter mais informações, consulte dotnet add package ou Gerir dependências de pacotes em aplicações .NET.

Adicionar AzureAzure Cosmos DB recurso

No projeto de host de aplicativos, chame AddAzureCosmosDB para adicionar e retornar um construtor de recursos AzureAzure Cosmos DB.

var builder = DistributedApplication.CreateBuilder(args);

var cosmos = builder.AddAzureCosmosDB("cosmos-db");

// After adding all resources, run the app...

Quando você adiciona um AzureCosmosDBResource ao host do aplicativo, ele expõe outras APIs úteis para adicionar bancos de dados e contêineres. Em outras palavras, você deve adicionar um AzureCosmosDBResource antes de adicionar qualquer um dos outros recursos Cosmos DB.

Importante

Quando você chama AddAzureCosmosDB, ele chama implicitamente AddAzureProvisioning—que adiciona suporte para gerar recursos de Azure dinamicamente durante a inicialização do aplicativo. O aplicativo deve configurar a assinatura e o local apropriados. Para obter mais informações, consulte Provisionamento local: Configuração.

Provisionamento gerado Bicep

Se és novo no Bicep, é uma linguagem específica de domínio para definir Azure recursos. Com .NET.NET Aspire, você não precisa escrever Bicep manualmente, em vez disso, as APIs de provisionamento geram Bicep para você. Quando publicas a tua aplicação, o Bicep gerado é produzido juntamente com o arquivo de manifesto. Ao adicionar um recurso AzureAzure Cosmos DB, o seguinte Bicep é gerado:

Alternar AzureAzure Cosmos DB bíceps.

@description('The location for the resource(s) to be deployed.')
param location string = resourceGroup().location

param keyVaultName string

resource keyVault 'Microsoft.KeyVault/vaults@2023-07-01' existing = {
  name: keyVaultName
}

resource cosmos 'Microsoft.DocumentDB/databaseAccounts@2024-08-15' = {
  name: take('cosmos-${uniqueString(resourceGroup().id)}', 44)
  location: location
  properties: {
    locations: [
      {
        locationName: location
        failoverPriority: 0
      }
    ]
    consistencyPolicy: {
      defaultConsistencyLevel: 'Session'
    }
    databaseAccountOfferType: 'Standard'
  }
  kind: 'GlobalDocumentDB'
  tags: {
    'aspire-resource-name': 'cosmos'
  }
}

resource connectionString 'Microsoft.KeyVault/vaults/secrets@2023-07-01' = {
  name: 'connectionString'
  properties: {
    value: 'AccountEndpoint=${cosmos.properties.documentEndpoint};AccountKey=${cosmos.listKeys().primaryMasterKey}'
  }
  parent: keyVault
}

O Bicep anterior é um módulo que provisiona uma conta AzureAzure Cosmos DB com os seguintes padrões:

kind: O tipo de conta Cosmos DB. O padrão é GlobalDocumentDB.
consistencyPolicy: A política de coerência da conta Cosmos DB. O padrão é Session.
locations: Os locais da conta Cosmos DB. O padrão é o local do grupo de recursos.

Além da conta Cosmos DB, ela também provisiona um recurso Azure Key Vault. Isso é usado para armazenar a cadeia de conexão da conta Cosmos DB de forma segura. O Bíceps gerado é um ponto de partida e pode ser personalizado para atender às suas necessidades específicas.

Personalizar a infraestrutura de provisionamento

Todos os recursos .NET AspireAzure são subclasses do tipo AzureProvisioningResource. Esse tipo permite a personalização do Bicep gerado fornecendo uma API fluente para configurar os recursos Azure — usando a API ConfigureInfrastructure<T>(IResourceBuilder<T>, Action<AzureResourceInfrastructure>). Por exemplo, você pode configurar o kind, consistencyPolicy, locationse muito mais. O exemplo a seguir demonstra como personalizar o recurso AzureAzure Cosmos DB:

builder.AddAzureCosmosDB("cosmos-db")
    .ConfigureInfrastructure(infra =>
    {
        var cosmosDbAccount = infra.GetProvisionableResources()
                                   .OfType<CosmosDBAccount>()
                                   .Single();

        cosmosDbAccount.Kind = CosmosDBAccountKind.MongoDB;
        cosmosDbAccount.ConsistencyPolicy = new()
        {
            DefaultConsistencyLevel = DefaultConsistencyLevel.Strong,
        };
        cosmosDbAccount.Tags.Add("ExampleKey", "Example value");
    });

O código anterior:

Encadeia uma chamada para a API ConfigureInfrastructure:
- O parâmetro infra é uma instância do tipo AzureResourceInfrastructure.
- Os recursos provisionáveis são recuperados chamando o método GetProvisionableResources().
- O único CosmosDBAccount é recuperado.
- O CosmosDBAccount.ConsistencyPolicy é atribuído a um DefaultConsistencyLevel.Strong.
- Uma tag é adicionada à conta Cosmos DB com uma chave de ExampleKey e um valor de Example value.

Há muito mais opções de configuração disponíveis para personalizar o recurso AzureAzure Cosmos DB. Para obter mais informações, consulte Azure.Provisioning.CosmosDB. Para obter mais informações, consulte Azure. Personalização de provisionamento.

Conectar-se a uma conta AzureAzure Cosmos DB existente

Você pode ter uma conta de AzureAzure Cosmos DB existente à qual deseja se conectar. Em vez de representar um novo recurso AzureAzure Cosmos DB, você pode adicionar uma cadeia de conexão ao host do aplicativo. Para adicionar uma conexão a uma conta de AzureAzure Cosmos DB existente, chame o método AddConnectionString:

var builder = DistributedApplication.CreateBuilder(args);

var cosmos = builder.AddConnectionString("cosmos-db");

builder.AddProject<Projects.WebApplication>("web")
       .WithReference(cosmos);

// After adding all resources, run the app...

Observação

As cadeias de conexão são usadas para representar uma ampla gama de informações de conexão, incluindo conexões de banco de dados, agentes de mensagens, URIs de ponto de extremidade e outros serviços. Na nomenclatura .NET.NET Aspire, o termo "cadeia de conexão" é usado para representar qualquer tipo de informação de conexão.

A cadeia de conexão é configurada na configuração do host da aplicação, normalmente sob a seção Segredos do Utilizador, na secção ConnectionStrings. O host do aplicativo injeta essa cadeia de conexão como uma variável de ambiente em todos os recursos dependentes, por exemplo:

{
    "ConnectionStrings": {
        "cosmos-db": "AccountEndpoint=https://{account_name}.documents.azure.com:443/;AccountKey={account_key};"
    }
}

O recurso dependente pode acessar a cadeia de conexão injetada chamando o método GetConnectionString e passando o nome da conexão como parâmetro, neste caso "cosmos-db". A API GetConnectionString é uma abreviação de IConfiguration.GetSection("ConnectionStrings")[name].

Adicionar AzureAzure Cosmos DB recurso de banco de dados

Para adicionar um recurso de banco de dados AzureAzure Cosmos DB, encadeie uma chamada em um IResourceBuilder<AzureCosmosDBResource> à API AddDatabase:

var builder = DistributedApplication.CreateBuilder(args);

var cosmos = builder.AddAzureCosmosDB("cosmos-db")
                    .AddDatabase("db");

// After adding all resources, run the app...

Quando você chama AddDatabase, ele configura seus recursos de Cosmos DB para ter um banco de dados chamado db. O banco de dados é criado na conta Cosmos DB representada pelo AzureCosmosDBResource que você adicionou anteriormente. O banco de dados é um contêiner lógico para coleções e usuários. Para obter mais informações, consulte bancos de dados, contêineres e itens no AzureAzure Cosmos DB.

Observação

Ao usar a API AddDatabase para adicionar um banco de dados a um recurso AzureAzure Cosmos DB, se você estiver executando o emulador, o banco de dados não será realmente criado no emulador. A finalidade desta API é incluir uma base de dados no Bicep gerado pela infraestrutura de provisionamento.

Adicionar AzureAzure Cosmos DB recurso do emulador

Para adicionar um recurso de emulador de AzureAzure Cosmos DB, encadeie uma chamada em um IResourceBuilder<AzureCosmosDBResource> à API RunAsEmulator:

var builder = DistributedApplication.CreateBuilder(args);

var cosmos = builder.AddAzureCosmosDB("cosmos-db")
                    .RunAsEmulator();

// After adding all resources, run the app...

Quando você chama RunAsEmulator, ele configura seus recursos de Cosmos DB para serem executados localmente usando um emulador. O emulador, neste caso, é o AzureAzure Cosmos DB Emulator. O Azure Cosmos DB Emulator fornece um ambiente local gratuito para testar seus aplicativos Azure Cosmos DB e é um companheiro perfeito para a integração de hospedagem .NET AspireAzure. O emulador não está instalado, em vez disso, é acessível para .NET.NET Aspire como um contêiner. Quando você adiciona um contêiner ao host do aplicativo, como mostrado no exemplo anterior com a imagem mcr.microsoft.com/cosmosdb/emulator, ele cria e inicia o contêiner quando o host do aplicativo é iniciado. Para obter mais informações, consulte Ciclo de vida do recurso de contêiner.

Configurar contentor do emulador Cosmos DB

Há várias configurações disponíveis para recursos de contêiner, por exemplo, você pode configurar as portas do contêiner, variáveis de ambiente, é tempo de vidae muito mais.

Configurar a porta do gateway do contêiner do emulador Cosmos DB

Por predefinição, o contentor do emulador Cosmos DB, quando configurado pelo .NET Aspire, expõe os seguintes pontos de extremidade:

Ponto final	Porto de contentores	Porta do host
`https`	8081	dinâmico

A porta em que ele está escutando é dinâmica por padrão. Quando o contêiner é iniciado, a porta é mapeada para uma porta aleatória na máquina host. Para configurar a porta do ponto de extremidade, encadeie chamadas no construtor de recursos de contêiner fornecido pelo método RunAsEmulator, conforme mostrado no exemplo a seguir:

var builder = DistributedApplication.CreateBuilder(args);

var cosmos = builder.AddAzureCosmosDB("cosmos-db").RunAsEmulator(
                     emulator =>
                     {
                         emulator.WithGatewayPort(7777);
                     });

// After adding all resources, run the app...

O código anterior configura o ponto de extremidade de https existente do contêiner do emulador de Cosmos DB para escutar na porta 8081. A porta do contêiner do emulador de Cosmos DB é mapeada para a porta do host, conforme mostrado na tabela a seguir:

Nome do ponto final	Cartografia de portos (`container:host`)
`https`	`8081:7777`

Configurar contentor do emulador Cosmos DB com vida útil persistente

Para configurar o contêiner do emulador de Cosmos DB com um tempo de vida persistente, chame o método WithLifetime no recurso de contêiner do emulador de Cosmos DB e passe ContainerLifetime.Persistent:

var builder = DistributedApplication.CreateBuilder(args);

var cosmos = builder.AddAzureCosmosDB("cosmos-db").RunAsEmulator(
                     emulator =>
                     {
                         emulator.WithLifetime(ContainerLifetime.Persistent);
                     });

// After adding all resources, run the app...

Para obter mais informações, consulte Tempo de vida do recurso de contêiner.

Configurar o container do emulador Cosmos DB com volume de dados

Para adicionar um volume de dados ao recurso do emulador de AzureAzure Cosmos DB, chame o método WithDataVolume no recurso do emulador AzureAzure Cosmos DB:

var builder = DistributedApplication.CreateBuilder(args);

var cosmos = builder.AddAzureCosmosDB("cosmos-db").RunAsEmulator(
                     emulator =>
                     {
                         emulator.WithDataVolume();
                     });

// After adding all resources, run the app...

O volume de dados é usado para manter os dados do emulador de Cosmos DB fora do ciclo de vida de seu contêiner. O volume de dados é montado no caminho /tmp/cosmos/appdata no contêiner do emulador de Cosmos DB e, quando um parâmetro name não é fornecido, o nome é gerado. O emulador tem sua variável de ambiente AZURE_COSMOS_EMULATOR_ENABLE_DATA_PERSISTENCE definida como true. Para obter mais informações sobre volumes de dados e detalhes sobre por que eles são preferidos em relação às montagens bind, consulte a documentação Docker: Volumes.

Configurar Cosmos DB contagem de partições de contêiner do emulador

Para configurar a contagem de partições do contêiner do emulador de Cosmos DB, chame o método WithPartitionCount:

var builder = DistributedApplication.CreateBuilder(args);

var cosmos = builder.AddAzureCosmosDB("cosmos-db").RunAsEmulator(
                     emulator =>
                     {
                         emulator.WithPartitionCount(100); // Defaults to 25
                     });

// After adding all resources, run the app...

O código anterior configura o contêiner do emulador de Cosmos DB para ter uma contagem de partições de 100. Esta é uma abreviatura para definir a variável de ambiente AZURE_COSMOS_EMULATOR_PARTITION_COUNT.

Verificações de integridade da integração de hospedagem

A integração de hospedagem Azure Cosmos DB adiciona automaticamente uma verificação de integridade para o recurso Cosmos DB. A verificação de integridade verifica se o Cosmos DB está em execução e se uma conexão pode ser estabelecida com ele.

A integração de hospedagem depende do 📦 AspNetCore.HealthChecks.CosmosDb pacote NuGet.

Client integração

Para começar a usar o .NET Aspire integração do Microsoft Entity Framework CoreCosmos DB, instale o 📦Aspire. Microsoft.EntityFrameworkCore.Cosmos pacote NuGet no projeto que consome client, ou seja, o projeto para o aplicativo que usa o Microsoft Entity Framework CoreCosmos DBclient.

.NET CLI
ReferênciaDoPacote

dotnet add package Aspire.Microsoft.EntityFrameworkCore.Cosmos

<PackageReference Include="Aspire.Microsoft.EntityFrameworkCore.Cosmos"
                  Version="*" />

Adicionar contexto Cosmos DB

No arquivo de Program.cs do seu projeto que consome client, chame o método de extensão AddCosmosDbContext para registar um System.Data.Entity.DbContext para utilização através do recipiente de injeção de dependências. O método usa um parâmetro de nome de conexão.

builder.AddCosmosDbContext<MyDbContext>("cosmosdb");

Dica

O parâmetro connectionName deve corresponder ao nome usado ao adicionar o recurso Cosmos DB no projeto de host do aplicativo. Em outras palavras, quando você chama AddAzureCosmosDB e fornece um nome de cosmosdb esse mesmo nome deve ser usado ao chamar AddCosmosDbContext. Para obter mais informações, consulte Adicionar AzureAzure Cosmos DB recurso.

Em seguida, você pode recuperar a instância DbContext usando a injeção de dependência. Por exemplo, para recuperar o client de um serviço:

public class ExampleService(MyDbContext context)
{
    // Use context...
}

Para mais informações sobre a utilização do Entity Framework Core com o Azure Cosmos DB, consulte os exemplos de para Azure Cosmos DB no SDK NoSQL para .NET.

Configuração

A integração .NET Aspire Microsoft Entity Framework CoreCosmos DB fornece várias opções para configurar a conexão Azure Cosmos DB com base nos requisitos e convenções do seu projeto.

Usar uma cadeia de conexão

Ao usar uma cadeia de conexão da seção de configuração de ConnectionStrings, você pode fornecer o nome da cadeia de conexão ao chamar builder.AddCosmosDbContext:

builder.AddCosmosDbContext<MyDbContext>("CosmosConnection");

E, em seguida, a cadeia de conexão será recuperada da seção de configuração ConnectionStrings:

{
  "ConnectionStrings": {
    "CosmosConnection": "AccountEndpoint=https://{account_name}.documents.azure.com:443/;AccountKey={account_key};"
  }
}

Para obter mais informações, consulte a documentação do ConnectionString.

Usar provedores de configuração

A integração .NET Aspire Microsoft Entity Framework CoreCosmos DB suporta Microsoft.Extensions.Configuration. Ele carrega o EntityFrameworkCoreCosmosSettings de arquivos de configuração, como appsettings.json. Exemplo _appsettings.json que configura algumas das opções:

{
  "Aspire": {
    "Microsoft": {
      "EntityFrameworkCore": {
        "Cosmos": {
          "DisableTracing": true
        }
      }
    }
  }
}

Para obter a Cosmos DBclient completa integração JSON esquema, consulte Aspire. Microsoft.EntityFrameworkCore.Cosmos/ConfigurationSchema.json.

Usar delegados em linha

Você também pode passar o objeto delegado Action<EntityFrameworkCoreCosmosSettings> configureSettings para configurar algumas ou todas as opções de EntityFrameworkCoreCosmosSettings diretamente, por exemplo, para desativar o rastreamento a partir do código:

builder.AddCosmosDbContext<MyDbContext>(
    "cosmosdb",
    settings => settings.DisableTracing = true);

Client verificações de integridade da integração

Por padrão, as integrações .NET.NET Aspire habilitam verificações de integridade para todos os serviços. Para obter mais informações, consulte .NET.NET Aspire visão geral das integrações.

A .NET Aspire integração da Microsoft Entity Framework CoreCosmos DB atualmente não implementa verificações de integridade, embora isso possa mudar em lançamentos futuros.

Observabilidade e telemetria

.NET .NET Aspire integrações configuram automaticamente as configurações de logging, tracing e métricas, que às vezes são conhecidas como os pilares da observabilidade. Para obter mais informações sobre observabilidade e telemetria de integração, consulte Visão geral de integrações .NET.NET Aspire. Dependendo do serviço de suporte, algumas integrações podem suportar apenas alguns desses recursos. Por exemplo, algumas integrações suportam registro em log e rastreamento, mas não métricas. Os recursos de telemetria também podem ser desativados usando as técnicas apresentadas na configuração do na seção.

Registo

A integração .NET Aspire Microsoft Entity Framework CoreCosmos DB usa as seguintes categorias de log:

Azure-Cosmos-Operation-Request-Diagnostics
Microsoft.EntityFrameworkCore.ChangeTracking
Microsoft.EntityFrameworkCore.Database.Command
Microsoft.EntityFrameworkCore.Infrastructure
Microsoft.EntityFrameworkCore.Query

Rastreio

O .NET Aspire integração do Microsoft Entity Framework CoreCosmos DB emitirá as seguintes atividades de rastreamento usando OpenTelemetry:

Azure.Cosmos.Operation
OpenTelemetry.Instrumentation.EntityFrameworkCore

Métricas

A integração .NET Aspire Microsoft Entity Framework CoreCosmos DB atualmente suporta as seguintes métricas:

Microsoft.EntityFrameworkCore
- ec_Microsoft_EntityFrameworkCore_active_db_contexts
- ec_Microsoft_EntityFrameworkCore_total_queries
- ec_Microsoft_EntityFrameworkCore_queries_per_second
- ec_Microsoft_EntityFrameworkCore_total_save_changes
- ec_Microsoft_EntityFrameworkCore_save_changes_per_second
- ec_Microsoft_EntityFrameworkCore_compiled_query_cache_hit_rate
- ec_Microsoft_Entity_total_execution_strategy_operation_failures
- ec_Microsoft_E_execution_strategy_operation_failures_per_second
- ec_Microsoft_EntityFramew_total_optimistic_concurrency_failures
- ec_Microsoft_EntityF_optimistic_concurrency_failures_per_second

Partilhar via