Conexión de una base de datos de Azure Cosmos DB a la aplicación de Azure Spring Apps

Nota:

Los planes Básico, Estándar y Enterprise quedarán en desuso a partir de mediados de marzo de 2025, con un período de retirada de 3 años. Se recomienda realizar la transición a Azure Container Apps. Para más información, consulte el anuncio de retirada de Azure Spring Apps.

El plan Estándar por consumo y dedicado quedará obsoleto a partir del 30 de septiembre de 2024, con un cierre completo al cabo de seis meses. Se recomienda realizar la transición a Azure Container Apps. Para más información, consulte Migrar el plan Estándar por consumo y dedicado de Azure Spring Apps a Azure Container Apps.

Este artículo se aplica a: ✔️ Java ✔️ C#

La información de este artículo puede ponerse en práctica en: ✔️ Básico o Estándar ✔️ Enterprise

En lugar de configurar manualmente las aplicaciones de Spring Boot, puede conectar automáticamente servicios de Azure seleccionados a las aplicaciones mediante Azure Spring Apps. En este artículo se muestra cómo conectar la aplicación a una base de datos de Azure Cosmos DB.

Requisitos previos

• Una aplicación implementada en Azure Spring Apps. Para más información, consulte Inicio rápido: implementación de la primera aplicación en Azure Spring Apps.
• Una instancia de base de datos de Azure Cosmos DB.
• CLI de Azure: versión 2.45.0 o superior.

Preparación del proyecto

Java

1. Agregue una de las siguientes dependencias al archivo pom.xml de la aplicación. Elija la dependencia que sea adecuada para el tipo de API.

   • Tipo de API: NoSQL

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

   • Tipo de API: MongoDB

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

   • Tipo de API: Cassandra

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

2. Actualice la aplicación actual mediante la ejecución de az spring app deploy o cree una implementación para este cambio mediante la ejecución de az spring app deployment create.

Polyglot

Todas las cadenas de conexión y las credenciales se insertan como variables de entorno, a las que puede hacer referencia en el código de la aplicación.

Para conocer los nombres de las variables de entorno predeterminados, consulte los siguientes artículos:

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

Conexión de la aplicación a Azure Cosmos DB

Conector de servicio

Nota:

De forma predeterminada, los conectores de servicio se crean en el nivel de aplicación. Para invalidar las conexiones, puede volver a crear otras conexiones en las implementaciones.

Uso de la CLI de Azure

Use la CLI de Azure para configurar la aplicación Spring para conectarse a una base de datos NoSQL de Cosmos con una clave de acceso mediante el comando az spring connection create, como se muestra en el ejemplo siguiente. Asegúrese de reemplazar las variables del ejemplo por valores reales.

Nota:

La actualización de la configuración de la base de datos de Azure Cosmos DB puede tardar unos minutos en completarse.

Nota:

Si usa Cosmos Cassandra, use --key_space en lugar de --database. Si usa Cosmos Table, use --table en lugar de --database. Para obtener más información, consulte Inicio rápido: Creación de una conexión de servicio en Azure Spring Apps con la CLI de 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:

Si usa Service Connector por primera vez, empiece ejecutando el comando az provider register --namespace Microsoft.ServiceLinker para registrar el proveedor de recursos de Service Connector.

Sugerencia

Ejecute el comando az spring connection list-support-types --output table para obtener una lista de los servicios de destino compatibles con Azure Spring Apps y los métodos de autenticación. Si el sistema no reconoce el comando az spring, compruebe que ha instalado la extensión necesaria mediante la ejecución de az extension add --name spring.

Uso de Azure Portal

Como alternativa, puede usar Azure Portal para configurar esta conexión completando los pasos siguientes. Azure Portal proporciona las mismas funcionalidades que la CLI de Azure y una experiencia interactiva.

1. Seleccione la instancia de Azure Spring Apps en Azure Portal y seleccione Aplicaciones en el menú de navegación. Elija la aplicación que quiere conectar y seleccione Service Connector en el menú de navegación.

2. Seleccione Crear.

3. En la pestaña Aspectos básicos, para el tipo de servicio, seleccione Cosmos DB y, después, elija una suscripción. En Tipo de API, seleccione Core (SQL) y elija una cuenta de Cosmos DB y una base de datos. En Tipo de cliente, seleccione Java y, a continuación, seleccione Siguiente: Autenticación. Si aún no ha creado la base de datos, consulte Inicio rápido: Creación de una cuenta, una base de datos, un contenedor y elementos de Azure Cosmos DB desde Azure Portal.

4. En la pestaña Autenticación, elija Cadena de conexión. Service Connector recupera automáticamente la clave de acceso de la cuenta de Cosmos DB. Seleccione Siguiente: Redes.

5. En la pestaña Redes, seleccione Configurar reglas de firewall para habilitar el acceso al servicio de destino y, después, seleccione Siguiente: Revisar y crear.

6. En la pestaña Revisar y crear, espere a que se complete la validación y después seleccione Crear. Este proceso puede tardar unos minutos.

7. Una vez generada la conexión entre las aplicaciones de Spring y la base de datos de Cosmos DB, puede verla en la página Service Connector y seleccionar el botón de despliegue para ver las variables de conexión configuradas.

Terraform

El siguiente script de Terraform muestra cómo configurar una aplicación implementada en Azure Spring Apps con una cuenta de 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
}

Pasos siguientes

En este artículo ha aprendido a conectar una aplicación en Azure Spring Apps a una base de datos de Azure Cosmos DB. Para más información sobre la conexión de servicios a una aplicación, consulte Conexión a una caché de Azure Cache for Redis.