Ansluta en Azure Cosmos DB-databas till ditt program i Azure Spring Apps

Kommentar

Basic-, Standard- och Enterprise-planerna kommer att vara inaktuella från och med mitten av mars 2025, med en 3-årig pensionsperiod. Vi rekommenderar att du övergår till Azure Container Apps. Mer information finns i meddelandet om azure Spring Apps-pensionering.

Standardförbrukningen och den dedikerade planen kommer att vara inaktuell från och med den 30 september 2024, med en fullständig avstängning efter sex månader. Vi rekommenderar att du övergår till Azure Container Apps. Mer information finns i Migrera Azure Spring Apps Standard-förbrukning och dedikerad plan till Azure Container Apps.

Den här artikeln gäller för: ✔️ Java ✔️ C#

Den här artikeln gäller för: ✔️ Basic/Standard ✔️ Enterprise

I stället för att konfigurera Dina Spring Boot-program manuellt kan du automatiskt ansluta valda Azure-tjänster till dina program med hjälp av Azure Spring Apps. Den här artikeln visar hur du ansluter ditt program till en Azure Cosmos DB-databas.

Förutsättningar

• Ett program som distribuerats till Azure Spring Apps. Mer information finns i Snabbstart: Distribuera ditt första program till Azure Spring Apps.
• En Azure Cosmos DB-databasinstans.
• Azure CLI version 2.45.0 eller senare.

Förbereda projektet

Java

1. Lägg till något av följande beroenden i programmets pom.xml-fil . Välj det beroende som är lämpligt för din API-typ.

   • API-typ: NoSQL

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

   • API-typ: MongoDB

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

   • API-typ: Cassandra

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

2. Uppdatera den aktuella appen genom att köra az spring app deployeller skapa en ny distribution för den här ändringen genom att köra az spring app deployment create.

Polyglott

Alla anslutningssträng och autentiseringsuppgifter matas in som miljövariabler, som du kan referera till i programkoden.

Standardnamnen för miljövariabler finns i följande artiklar:

• Azure Cosmos DB för tabell
• Azure Cosmos DB för NoSQL
• Azure Cosmos DB för MongoDB
• Azure Cosmos DB för Gremlin
• Azure Cosmos DB för Cassandra

Ansluta din app till Azure Cosmos DB

Tjänstanslutning

Kommentar

Som standard skapas tjänstanslutningsprogram på programnivå. Om du vill åsidosätta anslutningarna kan du skapa andra anslutningar igen i distributionerna.

Använda Azure CLI

Använd Azure CLI för att konfigurera springappen för att ansluta till en Cosmos NoSQL-databas med hjälp az spring connection create av kommandot, som du ser i följande exempel. Se till att ersätta variablerna i exemplet med faktiska värden.

Kommentar

Det kan ta några minuter att uppdatera Azure Cosmos DB-databasinställningarna.

Kommentar

Om du använder Cosmos Cassandra använder du --key_space i stället för --database. Om du använder Cosmos Table använder du --table i stället för --database. Mer information finns i Snabbstart: Skapa en tjänstanslutning i Azure Spring Apps med Azure CLI.

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

Kommentar

Om du använder Service Connector för första gången börjar du med att köra kommandot az provider register --namespace Microsoft.ServiceLinker för att registrera resursprovidern för Service Connector.

Dricks

Kör kommandot az spring connection list-support-types --output table för att hämta en lista över måltjänster och autentiseringsmetoder som stöds för Azure Spring Apps. az spring Om kommandot inte känns igen av systemet kontrollerar du att du har installerat det nödvändiga tillägget genom att köra az extension add --name spring.

Använda Azure Portal

Du kan också använda Azure Portal för att konfigurera den här anslutningen genom att utföra följande steg. Azure Portal har samma funktioner som Azure CLI och ger en interaktiv upplevelse.

1. Välj din Azure Spring Apps-instans i Azure Portal och välj Appar på navigeringsmenyn. Välj den app som du vill ansluta till och välj Tjänstanslutning på navigeringsmenyn.

2. Välj Skapa.

3. Välj Cosmos DB för tjänsttyp på fliken Grundläggande och välj sedan en prenumeration. För API-typ väljer du Core (SQL), väljer ett Cosmos DB-konto och en databas. För klienttyp väljer du Java och sedan Nästa: Autentisering. Om du inte har skapat databasen än kan du läsa Snabbstart: Skapa ett Azure Cosmos DB-konto, databas, container och objekt från Azure Portal.

4. På fliken Autentisering väljer du Anslutningssträng. Service Connector hämtar automatiskt åtkomstnyckeln från ditt Cosmos DB-konto. Välj Nästa: Nätverk.

5. På fliken Nätverk väljer du Konfigurera brandväggsregler för att aktivera åtkomst till måltjänsten och väljer sedan Nästa: Granska + Skapa.

6. På fliken Granska + skapa väntar du tills valideringen har godkänts och väljer sedan Skapa. Det kan ta några minuter att slutföra skapandet.

7. När anslutningen mellan dina Spring-appar och Cosmos DB-databasen har genererats kan du se den på sidan Service Connector och välja knappen för att visa de konfigurerade anslutningsvariablerna.

Terraform

Följande Terraform-skript visar hur du konfigurerar en app som distribuerats till Azure Spring Apps med ett Azure Cosmos DB-konto.

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
}

Nästa steg

I den här artikeln har du lärt dig hur du ansluter ditt program i Azure Spring Apps till en Azure Cosmos DB-databas. Mer information om hur du ansluter tjänster till ditt program finns i Ansluta till en Azure Cache for Redis-cache.