Connettere un database Azure Cosmos DB all'applicazione in Azure Spring Apps

Nota

I piani Basic, Standard ed Enterprise saranno deprecati a partire dalla metà di marzo 2025, con un periodo di ritiro di 3 anni. È consigliabile eseguire la transizione ad App Azure Container. Per altre informazioni, vedere l'annuncio di ritiro di Azure Spring Apps.

Il piano Standard a consumo e dedicato sarà deprecato a partire dal 30 settembre 2024, con un arresto completo dopo sei mesi. È consigliabile eseguire la transizione ad App Azure Container. Per altre informazioni, vedere Eseguire la migrazione del consumo di Azure Spring Apps Standard e del piano dedicato alle app Azure Container.

Questo articolo si applica a: ✔️ Java ✔️ C#

Questo articolo si applica a: ✔️ Basic/Standard ✔️ Enterprise

Invece di configurare manualmente le applicazioni Spring Boot, è possibile connettere automaticamente i servizi di Azure selezionati alle applicazioni usando Azure Spring Apps. Questo articolo illustra come connettere l'applicazione a un database di Azure Cosmos DB.

Prerequisiti

• Un'applicazione distribuita in Azure Spring Apps. Per altre informazioni, vedere Avvio rapido: Distribuire la prima applicazione in Azure Spring Apps.
• Istanza del database Azure Cosmos DB.
• Interfaccia della riga di comando di Azure versione 2.45.0 o successiva.

Preparare il progetto

Java

1. Aggiungere una delle dipendenze seguenti al file di pom.xml dell'applicazione. Scegliere la dipendenza appropriata per il tipo di API.

   • Tipo di API: NoSQL

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

   • Tipo di API: MongoDB

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

   • Tipo di API: Cassandra

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

2. Aggiornare l'app corrente eseguendo az spring app deployo creare una nuova distribuzione per questa modifica eseguendo az spring app deployment create.

Poliglotta

Tutte le stringa di connessione e le credenziali vengono inserite come variabili di ambiente, a cui è possibile fare riferimento nel codice dell'applicazione.

Per i nomi delle variabili di ambiente predefiniti, vedere gli articoli seguenti:

• Azure Cosmos DB for Table
• Azure Cosmos DB for NoSQL
• Azure Cosmos DB for MongoDB
• Azure Cosmos DB per Gremlin
• Azure Cosmos DB per Cassandra

Connettere l'app ad Azure Cosmos DB

Connettore servizio

Nota

Per impostazione predefinita, i connettori di servizio vengono creati a livello di applicazione. Per eseguire l'override delle connessioni, è possibile creare di nuovo altre connessioni nelle distribuzioni.

Usare l'interfaccia della riga di comando di Azure

Usare l'interfaccia della riga di comando di Azure per configurare l'app Spring per connettersi a un'istanza di Cosmos No database SQL usando il az spring connection create comando , come illustrato nell'esempio seguente. Assicurarsi di sostituire le variabili nell'esempio con i valori effettivi.

Nota

Il completamento dell'aggiornamento delle impostazioni del database di Azure Cosmos DB può richiedere alcuni minuti.

Nota

Se si usa Cosmos Cassandra, usare --key_space anziché --database. Se si usa Cosmos Table, usare --table anziché --database. Per altre informazioni, vedere Avvio rapido: Creare una connessione al servizio in Azure Spring Apps con l'interfaccia della riga di comando di Azure.

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

Nota

Se si usa Service Connector per la prima volta, iniziare eseguendo il comando az provider register --namespace Microsoft.ServiceLinker per registrare il provider di risorse di Service Connector.

Suggerimento

Eseguire il comando az spring connection list-support-types --output table per ottenere un elenco dei servizi di destinazione e dei metodi di autenticazione supportati per Azure Spring Apps. Se il comando az spring non è riconosciuto dal sistema, verificare di aver installato l'estensione richiesta eseguendo az extension add --name spring.

Usare il portale di Azure

In alternativa, è possibile usare il portale di Azure per configurare questa connessione completando i passaggi seguenti. Il portale di Azure offre le stesse funzionalità dell'interfaccia della riga di comando di Azure e offre un'esperienza interattiva.

1. Selezionare l'istanza di Azure Spring Apps nel portale di Azure e selezionare App dal menu di spostamento. Scegliere l'app che si vuole connettere e selezionare Service Connector nel menu di spostamento.

2. Seleziona Crea.

3. Nella scheda Informazioni di base selezionare Cosmos DB per tipo di servizio e quindi scegliere una sottoscrizione. Per Tipo di API selezionare Core (SQL), scegliere un account Cosmos DB e un database. Per tipo di client selezionare Java, quindi selezionare Avanti: Autenticazione. Se il database non è ancora stato creato, vedere Avvio rapido: Creare un account, un database, un contenitore e elementi di Azure Cosmos DB dall'portale di Azure.

4. Nella scheda Autenticazione scegliere Stringa di connessione. Service Connector recupera automaticamente la chiave di accesso dall'account Cosmos DB. Selezionare Avanti: Rete.

5. Nella scheda Rete selezionare Configura regole del firewall per abilitare l'accesso al servizio di destinazione, quindi selezionare Avanti: Rivedi e crea.

6. Nella scheda Rivedi e crea attendere il superamento della convalida e quindi selezionare Crea. Il completamento della creazione può richiedere alcuni minuti.

7. Dopo aver generato la connessione tra le app Spring e il database Cosmos DB, è possibile visualizzarla nella pagina Service Connector e selezionare il pulsante di distribuzione per visualizzare le variabili di connessione configurate.

Terraform

Lo script Terraform seguente illustra come configurare un'app distribuita in Azure Spring Apps con un account Azure Cosmos DB.

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
}

Passaggi successivi

In questo articolo si è appreso come connettere l'applicazione in Azure Spring Apps a un database di Azure Cosmos DB. Per altre informazioni sulla connessione dei servizi all'applicazione, vedere Connettersi a una cache cache di Azure per Redis.