Freigeben über


.NET Aspire Azure Cosmos DB-Integration

umfasst:Hosting-Integration und Client-Integration

Azure Cosmos DB ist ein vollständig verwalteter NoSQL-Datenbankdienst für die moderne App-Entwicklung. Mit der .NET AspireAzure Cosmos DB-Integration können Sie eine Verbindung mit vorhandenen Cosmos DB Instanzen herstellen oder neue Instanzen aus .NET mit dem Azure Cosmos DB Emulator erstellen.

Hostingintegration

Die .NET.NET AspireAzure Cosmos DB Hosting-Integrationsmodelle modellieren die verschiedenen Cosmos DB Ressourcen als die folgenden Typen:

Um auf diese Typen und die APIs, um sie auszudrücken, zuzugreifen, fügen Sie das NuGet-Paket 📦Aspire.Hosting.Azure.CosmosDB im App-Host-Projekt hinzu.

dotnet add package Aspire.Hosting.Azure.CosmosDB

Weitere Informationen finden Sie unter dotnet add package oder Verwaltung von Paketabhängigkeiten in .NET-Anwendungen.

Eine Ressource AzureAzure Cosmos DB hinzufügen

Rufen Sie in Ihrem App-Hostprojekt AddAzureCosmosDB auf, um einen AzureAzure Cosmos DB Ressourcen-Generator hinzuzufügen und zurückzugeben.

var builder = DistributedApplication.CreateBuilder(args);

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

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

Wenn Sie dem App-Host ein AzureCosmosDBResource hinzufügen, werden dadurch weitere nützliche APIs zum Hinzufügen von Datenbanken und Containern verfügbar. Mit anderen Worten, Sie müssen eine AzureCosmosDBResource hinzufügen, bevor Sie eine der anderen Cosmos DB-Ressourcen hinzufügen.

Wichtig

Wenn Sie AddAzureCosmosDBaufrufen, wird implizit AddAzureProvisioningaufgerufen, wodurch beim Start der App Azure Ressourcen dynamisch generiert werden. Die App muss das entsprechende Abonnement und den entsprechenden Standort konfigurieren. Weitere Informationen finden Sie unter lokale Bereitstellung: Konfiguration.

Generierte Bereitstellung Bicep

Wenn Sie neu bei Bicepsind, handelt es sich um eine domänenspezifische Sprache zum Definieren von Azure Ressourcen. Mit .NET.NET Aspiremüssen Sie Bicep nicht selbst schreiben, sondern die Bereitstellungs-APIs generieren Bicep für Sie. Wenn Sie Ihre App veröffentlichen, wird das generierte Bicep zusammen mit der Manifestdatei ausgegeben. Wenn Sie eine AzureAzure Cosmos DB Ressource hinzufügen, wird die folgende Bicep generiert:


Umschalten AzureAzure Cosmos DB Bicep.

@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
}

Das vorliegende Bicep ist ein Modul, das ein AzureAzure Cosmos DB Konto mit den folgenden Standardwerten bereitstellt.

  • kind: Die Art des Cosmos DB Kontos. Der Standardwert ist GlobalDocumentDB.
  • consistencyPolicy: Die Konsistenzrichtlinie des Cosmos DB Kontos. Der Standardwert ist Session.
  • locations: Die Speicherorte für das Cosmos DB Konto. Die Standardeinstellung ist der Ort der Ressourcengruppe.

Zusätzlich zum Cosmos DB Konto stellt es auch eine Azure Key Vault Ressource bereit. Dies wird verwendet, um die Verbindungszeichenfolge des Cosmos DB Kontos sicher zu speichern. Der generierte Bicep ist ein Ausgangspunkt und kann individuell an Ihre spezifischen Anforderungen angepasst werden.

Anpassen der Bereitstellungsinfrastruktur

Alle .NET AspireAzure Ressourcen sind Unterklassen des AzureProvisioningResource Typs. Dieser Typ ermöglicht die Anpassung der generierten Bicep, indem er eine Fluent-API bereitstellt, mit der die Azure-Ressourcen mithilfe der ConfigureInfrastructure<T>(IResourceBuilder<T>, Action<AzureResourceInfrastructure>)-API konfiguriert werden können. Sie können z. B. die kind, consistencyPolicy, locationsund mehr konfigurieren. Im folgenden Beispiel wird veranschaulicht, wie die AzureAzure Cosmos DB Ressource angepasst wird:

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

Der vorangehende Code:

Es stehen viele weitere Konfigurationsoptionen zum Anpassen der AzureAzure Cosmos DB Ressource zur Verfügung. Weitere Informationen finden Sie unter Azure.Provisioning.CosmosDB. Weitere Informationen finden Sie unter Azure. Bereitstellungsanpassung.

Verbinden mit einem vorhandenen AzureAzure Cosmos DB-Konto

Möglicherweise verfügen Sie über ein vorhandenes AzureAzure Cosmos DB Konto, mit dem Sie eine Verbindung herstellen möchten. Anstatt eine neue AzureAzure Cosmos DB-Ressource darzustellen, können Sie dem App-Host eine Verbindungszeichenfolge hinzufügen. Rufen Sie zum Hinzufügen einer Verbindung zu einem vorhandenen AzureAzure Cosmos DB Konto die AddConnectionString-Methode auf:

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...

Anmerkung

Verbindungszeichenfolgen werden verwendet, um eine vielzahl von Verbindungsinformationen darzustellen, einschließlich Datenbankverbindungen, Nachrichtenbroker, Endpunkt-URIs und anderen Diensten. In .NET.NET Aspire Nomenklatur wird der Begriff "Connection-String" verwendet, um jede Art von Verbindungsinformationen darzustellen.

Die Verbindungszeichenfolge wird in der Konfiguration des App-Hosts konfiguriert, in der Regel unter Benutzergeheimnisse, unter dem Abschnitt ConnectionStrings. Der App-Host fügt diese Verbindungszeichenfolge als Umgebungsvariable in alle abhängigen Ressourcen ein, z. B.:

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

Die abhängige Ressource kann auf die eingefügte Verbindungszeichenfolge zugreifen, indem sie die GetConnectionString Methode aufruft und den Verbindungsnamen als Parameter übergibt, in diesem Fall "cosmos-db". Die GetConnectionString API ist eine Abkürzung für IConfiguration.GetSection("ConnectionStrings")[name].

Datenbankressource AzureAzure Cosmos DB hinzufügen

Um eine AzureAzure Cosmos DB-Datenbankressource hinzuzufügen, verketten Sie einen Aufruf eines IResourceBuilder<AzureCosmosDBResource> der AddDatabase-API:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Wenn Sie AddDatabaseaufrufen, werden Ihre Cosmos DB-Ressourcen so konfiguriert, dass eine Datenbank mit dem Namen dberstellt wird. Die Datenbank wird im Cosmos DB Konto erstellt, das durch die AzureCosmosDBResource, die Sie zuvor hinzugefügt haben, dargestellt wird. Die Datenbank ist ein logischer Container für Sammlungen und Benutzer. Weitere Informationen finden Sie unter Datenbanken, Container und Elemente in AzureAzure Cosmos DB.

Anmerkung

Wenn Sie die AddDatabase-API zum Hinzufügen einer Datenbank zu einer AzureAzure Cosmos DB-Ressource verwenden, wird die Datenbank nicht wirklich im Emulator erstellt, falls Sie den Emulator verwenden. Diese API soll eine Datenbank in die von der Bereitstellungsinfrastruktur generierte Bicep einschließen.

Hinzufügen AzureAzure Cosmos DB die Emulatorressource

Um eine AzureAzure Cosmos DB Emulatorressource hinzuzufügen, verketten Sie einen Aufruf eines IResourceBuilder<AzureCosmosDBResource> an die RunAsEmulator-API:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Wenn Sie RunAsEmulatoraufrufen, werden Ihre Cosmos DB Ressourcen so konfiguriert, dass sie lokal mit einem Emulator ausgeführt werden. Der Emulator in diesem Fall ist der AzureAzure Cosmos DB Emulator. Der Azure Cosmos DB Emulator bietet eine kostenlose lokale Umgebung zum Testen Ihrer Azure Cosmos DB-Apps und ist ein perfekter Begleiter für die .NET AspireAzure Hostingintegration. Der Emulator ist nicht installiert, sondern stattdessen als Container für .NET.NET Aspire zugänglich. Wenn Sie dem App-Host einen Container hinzufügen, wie im vorherigen Beispiel mit dem mcr.microsoft.com/cosmosdb/emulator Image gezeigt, wird der Container erstellt und gestartet, wenn der App-Host gestartet wird. Weitere Informationen finden Sie unter Lebenszyklus von Containerressourcen.

Konfigurieren Cosmos DB Emulator-Containers

Es stehen verschiedene Konfigurationen für Containerressourcen zur Verfügung. Beispielsweise können Sie die Ports und Umgebungsvariablen des Containers, seine Lebensdauerund vieles mehr konfigurieren.

Konfigurieren Sie den Gateway-Port des Cosmos DB-Emulator-Containers

Standardmäßig macht der Cosmos DB Emulatorcontainer, wenn er von .NET Aspirekonfiguriert wird, die folgenden Endpunkte verfügbar:

Endpunkt Containerhafen Hostport
https 8081 dynamisch

Der Port, auf dem es lauscht, ist standardmäßig dynamisch. Wenn der Container gestartet wird, wird der Port einem zufälligen Port auf dem Hostcomputer zugeordnet. Um den Endpunktport zu konfigurieren, führen Sie Kettenaufrufe für den Containerressourcen-Generator aus, der von der RunAsEmulator-Methode bereitgestellt wird, wie im folgenden Beispiel gezeigt:

var builder = DistributedApplication.CreateBuilder(args);

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

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

Der vorhergehende Code konfiguriert den vorhandenen Cosmos DB-Endpunkt des https Emulator-Containers, um auf Port 8081zu lauschen. Der Port des Cosmos DB Emulatorcontainers wird dem Hostport zugeordnet, wie in der folgenden Tabelle dargestellt:

Endpunktname Portzuordnung (container:host)
https 8081:7777
Konfigurieren des Cosmos DB-Emulatorcontainers mit dauerhaftem Lebenszyklus

Zum Konfigurieren des Cosmos DB Emulator-Containers mit einer persistenten Lebensdauer rufen Sie die Methode WithLifetime für die Cosmos DB-Emulator-Containerressource auf und übergeben Sie 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...

Unter Containerressourcenlebensdauerfinden Sie weitere Informationen.

Konfigurieren Sie den Cosmos DB-Emulatorcontainer mit Datenvolumen

Um der AzureAzure Cosmos DB Emulatorressource ein Datenvolume hinzuzufügen, rufen Sie die WithDataVolume-Methode für die AzureAzure Cosmos DB Emulatorressource auf.

var builder = DistributedApplication.CreateBuilder(args);

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

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

Das Datenvolume wird verwendet, um die Cosmos DB Emulatordaten außerhalb des Lebenszyklus des Containers zu speichern. Das Datenvolumen wird im /tmp/cosmos/appdata-Pfad im Container des Cosmos DB-Emulators bereitgestellt und wenn kein name-Parameter angegeben wird, wird ein Name generiert. Der Emulator hat seine AZURE_COSMOS_EMULATOR_ENABLE_DATA_PERSISTENCE Umgebungsvariable auf truefestgelegt. Weitere Informationen zu Datenvolumen und Details, warum diese gegenüber Bind-Mounts bevorzugt werden, finden Sie in der Docker Dokumentation: Volumes.

Konfigurieren der Partitionsanzahl des Emulator-Containers Cosmos DB

Rufen Sie zum Konfigurieren der Partitionsanzahl des Cosmos DB Emulatorcontainers die WithPartitionCount-Methode auf:

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...

Im vorherigen Code wird der Cosmos DB-Emulatorcontainer so konfiguriert, dass er eine Partitionsanzahl von 100hat. Dies ist eine Kurzform zum Festlegen der umgebungsvariablen AZURE_COSMOS_EMULATOR_PARTITION_COUNT.

Hosten von Integritätsprüfungen für Integration

Die Azure Cosmos DB Hostingintegration fügt automatisch eine Integritätsprüfung für die Cosmos DB Ressource hinzu. Die Gesundheitsprüfung überprüft, ob die Cosmos DB ausgeführt wird und ob eine Verbindung hergestellt werden kann.

Die Hostingintegration basiert auf dem 📦 AspNetCore.HealthChecks.CosmosDb NuGet-Paket.

Client Integration

Um mit der .NET AspireAzure Cosmos DB-Clientintegration zu beginnen, installieren Sie das 📦Aspire.Microsoft.Azure.Cosmos.-NuGet-Paket im Projekt, das den Cosmos DB-Client verwendet, also das Projekt für die Anwendung, die den Client nutzt. Die Cosmos DB Clientintegration registriert eine CosmosClient Instanz, die Sie für die Interaktion mit Cosmos DBverwenden können.

dotnet add package Aspire.Microsoft.Azure.Cosmos

Hinzufügen Cosmos DB-Client

Rufen Sie in der Program.cs Datei Ihres clientaufwendigen Projekts die AddAzureCosmosClient Erweiterungsmethode für alle IHostApplicationBuilder auf, um eine CosmosClient für die Verwendung über den Container zum Einfügen von Abhängigkeiten zu registrieren. Die Methode verwendet einen Verbindungsnamenparameter.

builder.AddAzureCosmosClient(connectionName: "cosmos-db");

Tipp

Der parameter connectionName muss mit dem Namen übereinstimmen, der beim Hinzufügen der Cosmos DB-Ressource im App-Hostprojekt verwendet wird. Anders ausgedrückt: Wenn Sie AddAzureCosmosDB aufrufen und den Namen cosmos-db angeben, sollte dieser Name beim Aufrufen von AddAzureCosmosClientverwendet werden. Weitere Informationen finden Sie unter Hinzufügen AzureAzure Cosmos DB Ressource.

Anschließend können Sie die CosmosClient-Instanz mithilfe der Dependency Injection abrufen. So rufen Sie beispielsweise die Verbindung aus einem Beispieldienst ab:

public class ExampleService(CosmosClient client)
{
    // Use client...
}

Weitere Informationen zur Abhängigkeitsinjektion finden Sie unter .NET Abhängigkeitsinjektion.

Hinzufügen des konfigurierten Cosmos DB-Clients

Es kann Situationen geben, in denen Sie mehrere CosmosClient Instanzen mit unterschiedlichen Verbindungsnamen registrieren möchten. Um Clients mit dem Schlüssel Cosmos DB zu registrieren, rufen Sie die Methode AddKeyedAzureCosmosClient auf:

builder.AddKeyedAzureCosmosClient(name: "mainDb");
builder.AddKeyedAzureCosmosClient(name: "loggingDb");

Wichtig

Bei der Verwendung von schlüsselbasierten Diensten wird erwartet, dass Ihre Cosmos DB Ressource zwei benannte Datenbanken konfiguriert hat, eine für die mainDb und eine für die loggingDb.

Anschließend können Sie die CosmosClient Instanzen mithilfe der Abhängigkeitseinfügung abrufen. So rufen Sie beispielsweise die Verbindung aus einem Beispieldienst ab:

public class ExampleService(
    [FromKeyedServices("mainDb")] CosmosClient mainDbClient,
    [FromKeyedServices("loggingDb")] CosmosClient loggingDbClient)
{
    // Use clients...
}

Weitere Informationen zu schlüsselbasierten Diensten finden Sie unter .NET Abhängigkeitsinjektion: schlüsselbasierte Dienste.

Konfiguration

Die .NET AspireAzure Cosmos DB-Integration bietet mehrere Optionen zum Konfigurieren der Verbindung basierend auf den Anforderungen und Konventionen Ihres Projekts.

Verwenden Sie eine Verbindungszeichenfolge

Wenn Sie eine Verbindungszeichenfolge aus dem Konfigurationsabschnitt ConnectionStrings verwenden, können Sie beim Aufrufen der AddAzureCosmosClient-Methode den Namen der Verbindungszeichenfolge angeben:

builder.AddAzureCosmosClient("cosmos-db");

Aus dem Konfigurationsabschnitt ConnectionStrings wird anschließend die Verbindungszeichenfolge abgerufen.

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

Weitere Informationen zum Formatieren dieser Verbindungszeichenfolge finden Sie in der ConnectionString-Dokumentation.

Konfigurationsanbieter verwenden

Die .NET AspireAzure Cosmos DB-Integration unterstützt Microsoft.Extensions.Configuration. Sie lädt die MicrosoftAzureCosmosSettings mithilfe des Aspire:Microsoft:Azure:Cosmos Schlüssels aus der Konfiguration. Der folgende Codeausschnitt ist ein Beispiel für eine appsettings.json Datei, die einige der Optionen konfiguriert:

{
  "Aspire": {
    "Microsoft": {
      "Azure": {
        "Cosmos": {
          "DisableTracing": false,
        }
      }
    }
  }
}

Das vollständige Cosmos DB Clientintegration JSON Schema finden Sie unter Aspire.Microsoft.Azure.Cosmos/ConfigurationSchema.json.

Inline-Delegaten verwenden

Sie können auch den Action<MicrosoftAzureCosmosSettings> configureSettings Delegat übergeben, um einige oder alle Optionen inline einzurichten, z. B. zum Deaktivieren der Ablaufverfolgung aus Code:

builder.AddAzureCosmosClient(
    "cosmos-db",
    static settings => settings.DisableTracing = true);

Sie können die Microsoft.Azure.Cosmos.CosmosClientOptions auch mithilfe des optionalen Parameters Action<CosmosClientOptions> configureClientOptions der AddAzureCosmosClient-Methode einrichten. Wenn Sie beispielsweise das Benutzer-Agent-Headersuffix CosmosClientOptions.ApplicationName für alle Anforderungen, die von diesem Client ausgegeben werden, festlegen möchten:

builder.AddAzureCosmosClient(
    "cosmosConnectionName",
    configureClientOptions:
        clientOptions => clientOptions.ApplicationName = "myapp");

Client Gesundheitsprüfungen der Integration

Standardmäßig aktivieren .NET.NET Aspire Integrationen Integritätsprüfungen für alle Dienste. Weitere Informationen finden Sie unter .NET.NET Aspire Integrationsübersicht.

Die .NET AspireAzure Cosmos DB Integration:

  • Fügt den Gesundheitscheck hinzu, wenn MicrosoftAzureCosmosSettings.DisableTracing gleich falseist, wodurch versucht wird, eine Verbindung mit der Cosmos DBherzustellen.
  • Wird mit dem /health HTTP-Endpunkt integriert, der angibt, dass alle registrierten Gesundheitsprüfungen bestehen müssen, damit die App bereit ist, Datenverkehr anzunehmen.

Observability und Telemetrie

.NET .NET Aspire-Integrationen richten automatisch Protokollierungs-, Ablaufverfolgungs- und Metrikkonfigurationen ein, die manchmal als die Säulen der Beobachtbarkeitbezeichnet werden. Weitere Informationen zur Integrations-Observability und Telemetrie finden Sie unter .NET.NET Aspire Integrationsübersicht. Abhängig vom unterstützenden Dienst unterstützen einige Integrationen möglicherweise nur einige dieser Funktionen. Beispielsweise unterstützen einige Integrationen Protokollierung und Ablaufverfolgung, aber keine Metriken. Telemetrie-Features können auch mithilfe der Techniken deaktiviert werden, die im Abschnitt Configuration dargestellt sind.

Protokollierung

Die .NET AspireAzure Cosmos DB-Integration verwendet die folgenden Protokollkategorien:

  • Azure-Cosmos-Operation-Request-Diagnostics

Zusätzlich zum Abrufen von Azure Cosmos DB Anforderungsdiagnosen für fehlerhafte Anforderungen können Sie Latenzschwellenwerte konfigurieren, um zu bestimmen, welche der erfolgreichen Azure Cosmos DB Anforderungsdiagnosen protokolliert werden. Die Standardwerte sind 100 ms für Punktvorgänge und 500 ms für Vorgänge ohne Punkt.

builder.AddAzureCosmosClient(
    "cosmosConnectionName",
    configureClientOptions:
        clientOptions => {
            clientOptions.CosmosClientTelemetryOptions = new()
            {
                CosmosThresholdOptions = new()
                {
                    PointOperationLatencyThreshold = TimeSpan.FromMilliseconds(50),
                    NonPointOperationLatencyThreshold = TimeSpan.FromMilliseconds(300)
                }
            };
        });

Nachverfolgung

Die .NET AspireAzure Cosmos DB Integration gibt die folgenden Protokollierungsaktivitäten mithilfe von OpenTelemetryaus.

  • Azure.Cosmos.Operation

Azure Azure Cosmos DB Ablaufverfolgung befindet sich derzeit in der Vorschau, daher müssen Sie den experimentellen Schalter festlegen, um sicherzustellen, dass Ablaufverfolgungen ausgegeben werden.

AppContext.SetSwitch("Azure.Experimental.EnableActivitySource", true);

Weitere Informationen finden Sie unter AzureAzure Cosmos DB SDK-Observability: Trace-Attribute.

Metriken

Die .NET AspireAzure Cosmos DB-Integration unterstützt derzeit Metriken aufgrund von Einschränkungen mit dem Azure SDK nicht standardmäßig.

Siehe auch