Подключение базы данных Azure Cosmos DB к приложению в Azure Spring Apps

Примечание.

Планы "Базовый", "Стандартный" и "Корпоративный" будут устарели начиная с середины марта 2025 г. с 3-летнего периода выхода на пенсию. Рекомендуется перейти в приложения контейнеров Azure. Дополнительные сведения см. в объявлении о выходе на пенсию в Azure Spring Apps.

Стандартный план потребления и выделенного плана будет устарел с 30 сентября 2024 г. с полным завершением работы после шести месяцев. Рекомендуется перейти в приложения контейнеров Azure. Дополнительные сведения см. в статье "Миграция потребления Azure Spring Apps Standard" и выделенного плана в приложения контейнеров Azure.

Эта статья применима к: ✔️ Java ✔️ C#

Эта статья относится к: ✔️ Basic/Standard ✔️ Enterprise

Вместо ручной настройки приложений Spring Boot вы можете автоматически подключать выбранные службы Azure к приложениям с помощью Azure Spring Apps. В этой статье показано, как подключить приложение к базе данных Azure Cosmos DB.

Необходимые компоненты

• Развернутое в Azure Spring Apps приложение. Дополнительные сведения см. в статье Краткое руководство. Развертывание первого приложения Azure Spring Apps.
• Экземпляр базы данных Azure Cosmos DB.
• Azure CLI версии 2.45.0 или более поздней.

Подготовка проекта

Java

1. Добавьте одну из следующих зависимостей в файл pom.xml приложения. Выберите зависимость, соответствующую вашему типу API.

   • Тип API: NoSQL

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

   • Тип API: MongoDB

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

   • Тип API: Cassandra

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

2. Обновите текущее приложение, выполнив команду az spring app deploy, или создайте новое развертывание для этого изменения с помощью команды az spring app deployment create.

Многоязычный

Все строка подключения и учетные данные внедряются в виде переменных среды, на которые можно ссылаться в коде приложения.

Имена переменных среды по умолчанию см. в следующих статьях:

• Azure Cosmos DB for Table
• Azure Cosmos DB for NoSQL
• Azure Cosmos DB for MongoDB
• Azure Cosmos DB для Gremlin
• Azure Cosmos DB для Cassandra

Подключение приложения к Azure Cosmos DB

Соединитель служб

Примечание.

По умолчанию соединители служб создаются на уровне приложения. Чтобы переопределить подключения, можно снова создать другие подключения в развертываниях.

Использование командной строки Azure CLI

Используйте Azure CLI для настройки приложения Spring для подключения к Cosmos No База данных SQL с помощью az spring connection create команды, как показано в следующем примере. Обязательно замените переменные в примере фактическими значениями.

Примечание.

Обновление параметров базы данных Azure Cosmos DB может занять несколько минут.

Примечание.

Если вы используете Cosmos Cassandra, используйте --key_space вместо --databaseнего. Если вы используете таблицу Cosmos, используйте --table вместо --databaseнее. Дополнительные сведения см . в кратком руководстве по созданию подключения к службе в Azure Spring Apps с помощью 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

Примечание.

Если вы впервые используете соединитель служб, начните с выполнения команды az provider register --namespace Microsoft.ServiceLinker , чтобы зарегистрировать поставщика ресурсов соединителя службы.

Совет

Выполните команду az spring connection list-support-types --output table , чтобы получить список поддерживаемых целевых служб и методов проверки подлинности для Azure Spring Apps. az spring Если команда не распознается системой, убедитесь, что вы установили необходимое расширение, выполнив командуaz extension add --name spring.

Использование портала Azure

Кроме того, можно использовать портал Azure для настройки этого подключения, выполнив следующие действия. Портал Azure предоставляет те же возможности, что и Azure CLI, и предоставляет интерактивный интерфейс.

1. Выберите экземпляр Azure Spring Apps в портал Azure и выберите "Приложения" в меню навигации. Выберите приложение, которое требуется подключить, и выберите соединитель службы в меню навигации.

2. Нажмите кнопку создания.

3. На вкладке "Основные сведения" для типа службы выберите Cosmos DB, а затем выберите подписку. Для типа API выберите Core (SQL), выберите учетную запись Cosmos DB и базу данных. Для типа клиента выберите Java, а затем нажмите кнопку "Далее: проверка подлинности". Если вы еще не создали базу данных, см. краткое руководство. Создание учетной записи Azure Cosmos DB, базы данных, контейнера и элементов из портал Azure.

4. На вкладке "Проверка подлинности" выберите строку подключения. Соединитель служб автоматически получает ключ доступа из учетной записи Cosmos DB. Выберите Далее: сеть.

5. На вкладке "Сеть" выберите "Настроить правила брандмауэра", чтобы включить доступ к целевой службе, а затем нажмите кнопку "Далее: проверка и создание".

6. На вкладке "Рецензирование и создание " дождитесь прохождения проверки и нажмите кнопку "Создать". Создание может занять несколько минут.

7. После создания подключения между приложениями Spring и базой данных Cosmos DB вы увидите его на странице соединителя служб и нажмите кнопку развертывания, чтобы просмотреть настроенные переменные подключения.

Terraform

В следующем скрипте Terraform показано, как настроить приложение, развернутое в Azure Spring Apps, с учетной записью 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
}

Следующие шаги

Из этой статьи вы узнали, как подключить приложение в Azure Spring Apps к базе данных Azure Cosmos DB. Дополнительные сведения о подключении служб к приложению см. в статье "Подключение к кэшу Кэш Azure для Redis".