Compartir a través de

.NET Aspire Cosmos DB Entity Framework Core integración

  • Artículo

incluye: integración de hospedaje de e integración de Client

Azure Cosmos DB es un servicio de base de datos NoSQL totalmente administrado para el desarrollo de aplicaciones modernas. La integración de .NET AspireCosmos DBEntity Framework Core permite conectarse a instancias de Cosmos DB existentes o crear nuevas instancias desde .NET con el emulador de Azure Cosmos DB.

Integración de hospedaje

El modelo de integración de hospedaje de .NET.NET AspireAzure Cosmos DB modela los distintos recursos Cosmos DB como los siguientes tipos:

Para acceder a estos tipos y APIs para expresarlos, agregue el paquete NuGet 📦Aspire.Hosting.Azure.CosmosDB en el proyecto host de la aplicación .

dotnet add package Aspire.Hosting.Azure.CosmosDB

Para obtener más información, consulte dotnet add package o Manage package dependencies in .NET applications.

Agregar AzureAzure Cosmos DB recurso

En tu proyecto de alojamiento de la aplicación, llama a AddAzureCosmosDB para añadir y devolver un generador de recursos AzureAzure Cosmos DB.

var builder = DistributedApplication.CreateBuilder(args);

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

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

Al agregar un AzureCosmosDBResource al host de la aplicación, expone otras API útiles para agregar bases de datos y contenedores. Es decir, debe agregar un AzureCosmosDBResource antes de añadir cualquiera de los otros recursos Cosmos DB.

Importante

Al llamar a AddAzureCosmosDB, llama implícitamente a AddAzureProvisioning, lo que agrega compatibilidad para generar recursos de Azure dinámicamente durante el inicio de la aplicación. La aplicación debe configurar la suscripción y la ubicación adecuadas. Para obtener más información, consulte aprovisionamiento local: Configuración.

Bicep de aprovisionamiento generado

Si eres nuevo en Bicep, es un lenguaje específico del dominio para definir recursos Azure. Con .NET.NET Aspire, no es necesario escribir Bicep manualmente, sino que las API de aprovisionamiento generan Bicep automáticamente. Al publicar tu aplicación, el Bicep generado se proporciona junto al archivo de manifiesto. Al agregar un recurso AzureAzure Cosmos DB, se genera el siguiente Bicep:

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

param principalType string

param principalId string

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'
    disableLocalAuth: true
  }
  kind: 'GlobalDocumentDB'
  tags: {
    'aspire-resource-name': 'cosmos'
  }
}

resource cosmos_roleDefinition 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-08-15' existing = {
  name: '00000000-0000-0000-0000-000000000002'
  parent: cosmos
}

resource cosmos_roleAssignment 'Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2024-08-15' = {
  name: guid(principalId, cosmos_roleDefinition.id, cosmos.id)
  properties: {
    principalId: principalId
    roleDefinitionId: cosmos_roleDefinition.id
    scope: cosmos.id
  }
  parent: cosmos
}

output connectionString string = cosmos.properties.documentEndpoint

Bicep anterior es un módulo que aprovisiona una cuenta de AzureAzure Cosmos DB con los siguientes valores predeterminados:

  • kind: tipo de cuenta de Cosmos DB. El valor predeterminado es GlobalDocumentDB.
  • consistencyPolicy: La política de coherencia de la cuenta Cosmos DB. El valor predeterminado es Session.
  • locations: las ubicaciones de la cuenta Cosmos DB. El valor predeterminado es la ubicación del grupo de recursos.

Además de la cuenta Cosmos DB, también asigna la aplicación actual al rol Data Contributor para la cuenta Cosmos DB. El Bicep generado es un punto de partida y se puede personalizar para satisfacer sus requisitos específicos.

Personalización de la infraestructura de aprovisionamiento

Todos los recursos .NET AspireAzure son subclases del tipo AzureProvisioningResource. Este tipo permite la personalización del Bicep generado al proporcionar una API fluida para configurar los recursos de Azure utilizando la API de ConfigureInfrastructure<T>(IResourceBuilder<T>, Action<AzureResourceInfrastructure>). Por ejemplo, puede configurar el kind, consistencyPolicy, locations, etc. En el ejemplo siguiente se muestra cómo personalizar el recurso de 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");
    });

El código anterior:

Hay muchas más opciones de configuración disponibles para personalizar el recurso AzureAzure Cosmos DB. Para obtener más información, consulte Azure.Provisioning.CosmosDB. Para obtener más información, vea Azure. Personalización del aprovisionamiento.

Conexión a una cuenta de AzureAzure Cosmos DB existente

Es posible que tenga una cuenta de AzureAzure Cosmos DB existente a la que desea conectarse. En lugar de representar un nuevo recurso de AzureAzure Cosmos DB, puede agregar una cadena de conexión al host de la aplicación. Para agregar una conexión a una cuenta de AzureAzure Cosmos DB existente, llame al 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...

Nota

Las cadenas de conexión se usan para representar una amplia gama de información de conexión, incluidas las conexiones de base de datos, los agentes de mensajes, los URI de punto de conexión y otros servicios. En .NET.NET Aspire nomenclatura, el término "cadena de conexión" se usa para representar cualquier tipo de información de conexión.

La cadena de conexión se configura en la configuración del host de la aplicación, normalmente en secretos de usuario, en la sección ConnectionStrings. El host de la aplicación inserta esta cadena de conexión como una variable de entorno en todos los recursos dependientes, por ejemplo:

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

El recurso dependiente puede acceder a la cadena de conexión insertada llamando al método GetConnectionString y pasando el nombre de conexión como parámetro, en este caso "cosmos-db". La API de GetConnectionString es una abreviatura de IConfiguration.GetSection("ConnectionStrings")[name].

Añadir recursos de AzureAzure Cosmos DB base de datos y contenedor

Para agregar un recurso de base de datos de AzureAzure Cosmos DB, llame al método AddCosmosDatabase en una instancia de IResourceBuilder<AzureCosmosDBResource>:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Al llamar a AddCosmosDatabase, agrega una base de datos denominada db a los recursos de Cosmos DB y devuelve el recurso de base de datos recién creado. La base de datos se crea en la cuenta de Cosmos DB representada por el AzureCosmosDBResource que has agregado anteriormente. La base de datos es un contenedor lógico para colecciones y usuarios.

Un contenedor de AzureAzure Cosmos DB es donde se almacenan los datos. Al crear un contenedor, debe proporcionar una clave de partición.

Para agregar un recurso de contenedor de AzureAzure Cosmos DB, llame al método AddContainer en una instancia de IResourceBuilder<AzureCosmosDBDatabaseResource>:

var builder = DistributedApplication.CreateBuilder(args);

var cosmos = builder.AddAzureCosmosDB("cosmos-db");
var db = cosmos.AddCosmosDatabase("db");
db.AddContainer("entries", "/id");

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

El contenedor se crea en la base de datos representada por el AzureCosmosDBDatabaseResource que agregó anteriormente.

Para más información, consulte Bases de datos, contenedores y elementos en AzureAzure Cosmos DB.

Adición de un recurso del emulador de AzureAzure Cosmos DB

Para añadir un recurso de emulador AzureAzure Cosmos DB, encadena una llamada de un IResourceBuilder<AzureCosmosDBResource> a la API de RunAsEmulator.

var builder = DistributedApplication.CreateBuilder(args);

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

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

Al llamar a RunAsEmulator, configura los recursos de Cosmos DB para que se ejecuten localmente mediante un emulador. En este caso, el emulador es el Emulador AzureAzure Cosmos DB. El emulador de Azure Cosmos DB proporciona un entorno local gratuito para probar las aplicaciones de Azure Cosmos DB y es un complemento perfecto para la integración de hospedaje .NET AspireAzure. El emulador no está instalado, sino que es accesible para .NET.NET Aspire como contenedor. Al agregar un contenedor al host de la aplicación, como se muestra en el ejemplo anterior con la imagen de mcr.microsoft.com/cosmosdb/emulator, crea e inicia el contenedor cuando se inicia el host de la aplicación. Para obtener más información, consulte ciclo de vida de los recursos de contenedor.

Configuración del contenedor del emulador de Cosmos DB

Hay varias configuraciones disponibles para los recursos de contenedor, por ejemplo, puede configurar los puertos del contenedor, las variables de entorno, su duración, entre otras cosas.

Configuración del puerto de puerta de enlace de contenedor del emulador de Cosmos DB

De forma predeterminada, el contenedor del emulador de Cosmos DB cuando lo configura .NET Aspire, expone los siguientes puntos de conexión:

Punto final Puerto de contenedor Puerto de servidor
https 8081 dinámico

El puerto en el que está escuchando es dinámico de forma predeterminada. Cuando se inicia el contenedor, el puerto se asigna a un puerto aleatorio en el equipo host. Para configurar el puerto de punto de conexión, encadene llamadas en el generador de recursos de contenedor proporcionado por el método RunAsEmulator tal como se muestra en el ejemplo siguiente:

var builder = DistributedApplication.CreateBuilder(args);

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

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

El código anterior configura el contenedor del emulador Cosmos DB para que el punto de conexión existente https escuche el puerto 8081. El puerto del contenedor del emulador de Cosmos DB se asigna al puerto host, como se muestra en la tabla siguiente:

Nombre del punto de conexión Asignación de puertos (container:host)
https 8081:7777
Configurar el contenedor del emulador de Cosmos DB con vida útil persistente

Para configurar el contenedor del emulador Cosmos DB con una duración persistente, invoca el método WithLifetime en el recurso del contenedor del emulador Cosmos DB y proporciona 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 obtener más información, consulte ciclo de vida de los recursos del contenedor.

Configura el contenedor del emulador de Cosmos DB con volumen de datos

Para agregar un volumen de datos al recurso del emulador de AzureAzure Cosmos DB, llame al método WithDataVolume en el recurso del emulador de 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...

El volumen de datos se usa para conservar los datos del emulador de Cosmos DB fuera del ciclo de vida de su contenedor. El volumen de datos se monta en la ruta /tmp/cosmos/appdata dentro del contenedor del emulador Cosmos DB y, si no se proporciona el parámetro name, se genera un nombre. El emulador tiene su variable de entorno AZURE_COSMOS_EMULATOR_ENABLE_DATA_PERSISTENCE establecida en true. Para obtener más información sobre los volúmenes de datos y los detalles de por qué se prefieren frente a los montajes de enlace, consulte la documentación: DockerVolúmenes.

Configurar la cantidad de particiones del contenedor de emulador Cosmos DB

Para configurar el recuento de particiones del contenedor del emulador de Cosmos DB, llame al 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...

El código anterior configura el contenedor del emulador de Cosmos DB para tener un recuento de particiones de 100. Se trata de una abreviatura para establecer la variable de entorno AZURE_COSMOS_EMULATOR_PARTITION_COUNT.

Uso del emulador basado en Linux(versión preliminar)

La nueva generación del emulador de AzureAzure Cosmos DB está completamente basada en Linuxy disponible como un contenedor de Docker. Admite la ejecución en una amplia variedad de procesadores y sistemas operativos.

Para usar la versión preliminar del emulador de Cosmos DB, llame al método RunAsPreviewEmulator. Dado que esta característica está en versión preliminar, debe activarla explícitamente optando por la función de vista previa mediante la supresión del diagnóstico experimental ASPIRECOSMOSDB001.

El emulador de vista previa también admite la exposición de un punto de conexión de "Data Explorer", que permite ver los datos almacenados en el emulador de Cosmos DB a través de una interfaz de usuario web. Para habilitar el Explorador de datos, llame al método WithDataExplorer.

#pragma warning disable ASPIRECOSMOSDB001

var builder = DistributedApplication.CreateBuilder(args);

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

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

El código anterior configura el contenedor del emulador de vista previa basado en Linux, con el punto de conexión de Explorador de datos, para utilizarse en tiempo de ejecución.

Alojamiento de comprobaciones de salud de integración

La integración de hospedaje Azure Cosmos DB agrega automáticamente una comprobación de estado para el recurso Cosmos DB. La verificación de salud comprueba que el Cosmos DB está en funcionamiento y que se puede establecer una conexión con él.

La integración de hospedaje se basa en el paquete NuGet 📦 AspNetCore.HealthChecks.CosmosDb.

integración Client

Para empezar a trabajar con la integración de Microsoft .NET AspireEntity Framework CoreCosmos DB, instale el paquete NuGet 📦Aspire.Microsoft.EntityFrameworkCore.Cosmos en el proyecto que utiliza el cliente, es decir, el proyecto de la aplicación que emplea el cliente de Microsoft Entity Framework CoreCosmos DB.

dotnet add package Aspire.Microsoft.EntityFrameworkCore.Cosmos

Agregar contexto a Cosmos DB

En el archivo Program.cs del proyecto que consume el cliente, llame al método de extensión AddCosmosDbContext para registrar un System.Data.Entity.DbContext para su uso a través del contenedor de inserción de dependencias. El método toma un parámetro de nombre de conexión.

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

Propina

El parámetro connectionName debe coincidir con el nombre usado al agregar el recurso Cosmos DB en el proyecto host de la aplicación. Es decir, cuando se llama a AddAzureCosmosDB y se proporciona un nombre de cosmosdb ese mismo nombre se debe usar al llamar a AddCosmosDbContext. Para obtener más información, consulte Añadir AzureAzure Cosmos DB recurso.

A continuación, puede recuperar la instancia de DbContext mediante inyección de dependencia. Por ejemplo, para recuperar el cliente de un servicio:

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

Para obtener más información sobre el uso de Entity Framework Core con Azure Cosmos DB, consulte los ejemplos de para Azure Cosmos DB para el SDK de NoSQL para .NET.

Configuración

La integración de Microsoft .NET AspireEntity Framework CoreCosmos DB proporciona varias opciones para configurar la conexión Azure Cosmos DB en función de los requisitos y convenciones de su proyecto.

Uso de una cadena de conexión

Al usar una cadena de conexión de la sección de configuración de ConnectionStrings, puede proporcionar el nombre de la cadena de conexión al llamar a builder.AddCosmosDbContext:

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

Y, a continuación, la cadena de conexión se recuperará de la sección de configuración de ConnectionStrings:

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

Para obtener más información, consulte la documentación de ConnectionString.

Uso de proveedores de configuración

La integración de Microsoft .NET AspireEntity Framework CoreCosmos DB admite Microsoft.Extensions.Configuration. Carga el EntityFrameworkCoreCosmosSettings desde archivos de configuración como appsettings.json. Ejemplo _appsettings.json que configura algunas de las opciones:

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

Para obtener el esquema completo de Cosmos DB integración de cliente JSON, consulte Aspire.Microsoft.EntityFrameworkCore.Cosmos/ConfigurationSchema.json.

Utiliza delegados en línea

También puede pasar el delegado Action<EntityFrameworkCoreCosmosSettings> configureSettings para configurar algunas o todas las opciones de EntityFrameworkCoreCosmosSettings en línea, por ejemplo, para deshabilitar el seguimiento desde el código:

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

verificaciones de salud de integración de Client

La .NET Aspire integración de Microsoft Entity Framework CoreCosmos DB actualmente no implementa verificaciones de salud, aunque esto puede cambiar en futuras versiones.

Observabilidad y telemetría

.NET .NET Aspire integraciones configuran automáticamente las configuraciones de registro, seguimiento y métricas, que a veces se conocen como los pilares de la observabilidad. Para obtener más información sobre la observabilidad de integración y la telemetría, consulte información general sobre las integraciones de .NET.NET Aspire. En función del servicio de respaldo, algunas integraciones solo pueden admitir algunas de estas características. Por ejemplo, algunas integraciones admiten el registro y el seguimiento, pero no las métricas. Las características de telemetría también se pueden deshabilitar mediante las técnicas presentadas en la sección de Configuración.

Registro

La integración de .NET Aspire Microsoft Entity Framework CoreCosmos DB usa las siguientes categorías de registro:

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

Seguimiento

La integración de .NET Aspire Microsoft Entity Framework CoreCosmos DB emitirá las siguientes actividades de seguimiento utilizando OpenTelemetry:

  • Azure.Cosmos.Operation
  • OpenTelemetry.Instrumentation.EntityFrameworkCore

Métricas

Actualmente, la integración de Microsoft .NET AspireEntity Framework CoreCosmos DB soporta las siguientes 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

Consulte también