Een Azure Cosmos DB-database verbinden met uw toepassing in Azure Spring Apps

Notitie

De Basic-, Standard- en Enterprise-abonnementen worden afgeschaft vanaf medio maart 2025, met een pensioenperiode van 3 jaar. We raden u aan om over te stappen naar Azure Container Apps. Zie de aankondiging over buitengebruikstelling van Azure Spring Apps voor meer informatie.

Het standaardverbruik en het speciale abonnement worden vanaf 30 september 2024 afgeschaft, met een volledige afsluiting na zes maanden. We raden u aan om over te stappen naar Azure Container Apps. Zie Azure Spring Apps Standard-verbruik en toegewezen abonnement migreren naar Azure Container Apps voor meer informatie.

Dit artikel is van toepassing op: ✔️ Java ✔️ C#

Dit artikel is van toepassing op: ✔️ Basic/Standard ✔️ Enterprise

In plaats van uw Spring Boot-toepassingen handmatig te configureren, kunt u automatisch geselecteerde Azure-services verbinden met uw toepassingen met behulp van Azure Spring Apps. Dit artikel laat zien hoe u uw toepassing verbindt met een Azure Cosmos DB-database.

Vereisten

• Een toepassing die is geïmplementeerd in Azure Spring Apps. Zie quickstart: Uw eerste toepassing implementeren in Azure Spring Apps voor meer informatie.
• Een Azure Cosmos DB-database-exemplaar.
• Azure CLI versie 2.45.0 of hoger.

Uw project voorbereiden

Java

1. Voeg een van de volgende afhankelijkheden toe aan het pom.xml-bestand van uw toepassing. Kies de afhankelijkheid die geschikt is voor uw type API.

   • API-type: NoSQL

     <dependency>
         <groupId>com.azure.spring</groupId>
         <artifactId>spring-cloud-azure-starter-data-cosmos</artifactId>
     </dependency>
     

   • API-type: MongoDB

     <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-data-mongodb</artifactId>
     </dependency>
     

   • API-type: Cassandra

     <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-data-cassandra</artifactId>
     </dependency>
     

2. Werk de huidige app bij door deze wijziging uit te voeren az spring app deployof maak een nieuwe implementatie voor deze wijziging door uit te voeren az spring app deployment create.

Polyglot

Alle verbindingsreeks s en referenties worden geïnjecteerd als omgevingsvariabelen, waarnaar u kunt verwijzen in uw toepassingscode.

Zie de volgende artikelen voor de standaardnamen van omgevingsvariabelen:

• Azure Cosmos DB voor tabel
• Azure Cosmos DB voor NoSQL
• Azure Cosmos DB voor MongoDB
• Azure Cosmos DB voor Gremlin
• Azure Cosmos DB voor Cassandra

Uw app verbinden met Azure Cosmos DB

Serviceconnector

Notitie

Standaard worden serviceconnectors gemaakt op toepassingsniveau. Als u de verbindingen wilt overschrijven, kunt u andere verbindingen opnieuw maken in de implementaties.

De Azure CLI gebruiken

Gebruik de Azure CLI om uw Spring-app te configureren om verbinding te maken met een Cosmos NoSQL-database met behulp van de az spring connection create opdracht, zoals wordt weergegeven in het volgende voorbeeld. Zorg ervoor dat u de variabelen in het voorbeeld vervangt door werkelijke waarden.

Notitie

Het bijwerken van azure Cosmos DB-database-instellingen kan enkele minuten duren.

Notitie

Als u Cosmos Cassandra gebruikt, gebruikt --key_space u in plaats van --database. Als u Cosmos Table gebruikt, gebruikt --table u in plaats van --database. Zie quickstart: Een serviceverbinding maken in Azure Spring Apps met de Azure CLI voor meer informatie.

az spring connection create cosmos-sql \
    --resource-group $AZURE_SPRING_APPS_RESOURCE_GROUP \
    --service $AZURE_SPRING_APPS_SERVICE_INSTANCE_NAME \
    --app $APP_NAME \
    --target-resource-group $COSMOSDB_RESOURCE_GROUP \
    --account $COSMOSDB_ACCOUNT_NAME \
    --database $DATABASE_NAME \
    --secret

Notitie

Als u serviceconnector voor het eerst gebruikt, start u met de opdracht az provider register --namespace Microsoft.ServiceLinker om de serviceconnectorresourceprovider te registreren.

Tip

Voer de opdracht az spring connection list-support-types --output table uit om een lijst met ondersteunde doelservices en verificatiemethoden voor Azure Spring Apps op te halen. Als de az spring opdracht niet wordt herkend door het systeem, controleert u of u de vereiste extensie hebt geïnstalleerd door uit te voeren az extension add --name spring.

De Azure-portal gebruiken

U kunt azure Portal ook gebruiken om deze verbinding te configureren door de volgende stappen uit te voeren. Azure Portal biedt dezelfde mogelijkheden als de Azure CLI en biedt een interactieve ervaring.

1. Selecteer uw Azure Spring Apps-exemplaar in Azure Portal en selecteer Apps in het navigatiemenu. Kies de app waarmee u verbinding wilt maken en selecteer Serviceconnector in het navigatiemenu.

2. Selecteer Maken.

3. Selecteer Cosmos DB op het tabblad Basis voor servicetype en kies vervolgens een abonnement. Voor API-type selecteert u Core (SQL), kiest u een Cosmos DB-account en een database. Voor clienttype selecteert u Java en selecteert u vervolgens Volgende: Verificatie. Als u uw database nog niet hebt gemaakt, raadpleegt u quickstart: Een Azure Cosmos DB-account, -database, -container en -items maken vanuit Azure Portal.

4. Kies op het tabblad Verificatie de verbindingsreeks. ServiceConnector haalt automatisch de toegangssleutel op uit uw Cosmos DB-account. Selecteer Volgende: Netwerken.

5. Selecteer op het tabblad Netwerken firewallregels configureren om toegang tot de doelservice in te schakelen en selecteer vervolgens Volgende: Beoordelen en maken.

6. Wacht op het tabblad Controleren en maken totdat de validatie is geslaagd en selecteer vervolgens Maken. Het maken kan enkele minuten duren.

7. Zodra de verbinding tussen uw Spring-apps en uw Cosmos DB-database is gegenereerd, kunt u deze zien op de pagina ServiceConnector en de knop Uitvouwen selecteren om de geconfigureerde verbindingsvariabelen weer te geven.

Terraform

Het volgende Terraform-script laat zien hoe u een app instelt die is geïmplementeerd in Azure Spring Apps met een Azure Cosmos DB-account.

provider "azurerm" {
  features {}
}

variable "application_name" {
  type        = string
  description = "The name of your application"
  default     = "demo-cosmosdb"
}

resource "azurerm_resource_group" "example" {
  name     = "example-resources"
  location = "West Europe"
}

resource "azurerm_cosmosdb_account" "cosmosdb" {
  name                = "cosmosacct-${var.application_name}-001"
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_resource_group.example.location
  offer_type          = "Standard"
  kind                = "GlobalDocumentDB"

  consistency_policy {
    consistency_level = "Session"
  }

  geo_location {
    failover_priority = 0
    location          = azurerm_resource_group.example.location
  }
}

resource "azurerm_cosmosdb_sql_database" "cosmosdb" {
  name                = "cosmos-${var.application_name}-001"
  resource_group_name = azurerm_cosmosdb_account.cosmosdb.resource_group_name
  account_name        = azurerm_cosmosdb_account.cosmosdb.name
}

resource "azurerm_spring_cloud_service" "example" {
  name                = "${var.application_name}"
  resource_group_name = azurerm_resource_group.example.name
  location            = azurerm_resource_group.example.location
}

resource "azurerm_spring_cloud_app" "example" {
  name                = "${var.application_name}-app"
  resource_group_name = azurerm_resource_group.example.name
  service_name        = azurerm_spring_cloud_service.example.name
  is_public           = true
  https_only          = true
}

resource "azurerm_spring_cloud_java_deployment" "example" {
  name                = "default"
  spring_cloud_app_id = azurerm_spring_cloud_app.example.id
  quota {
    cpu    = "2"
    memory = "4Gi"
  }
  instance_count      = 1
  jvm_options         = "-XX:+PrintGC"
  runtime_version     = "Java_11"

  environment_variables = {
    "spring.cloud.azure.cosmos.endpoint" : azurerm_cosmosdb_account.cosmosdb.endpoint
    "spring.cloud.azure.cosmos.key" : azurerm_cosmosdb_account.cosmosdb.primary_key
    "spring.cloud.azure.cosmos.database" : azurerm_cosmosdb_sql_database.cosmosdb.name
  }
}

resource "azurerm_spring_cloud_active_deployment" "example" {
  spring_cloud_app_id = azurerm_spring_cloud_app.example.id
  deployment_name     = azurerm_spring_cloud_java_deployment.example.name
}

Volgende stappen

In dit artikel hebt u geleerd hoe u uw toepassing in Azure Spring Apps verbindt met een Azure Cosmos DB-database. Zie Verbinding maken met een Azure Cache voor Redis-cache voor meer informatie over het verbinden van services met uw toepassing.