Připojení databázi Azure Cosmos DB do vaší aplikace v Azure Spring Apps

Poznámka:

Azure Spring Apps je nový název služby Azure Spring Cloud. Přestože má služba nový název, na některých místech uvidíte starý název, protože pracujeme na aktualizaci prostředků, jako jsou snímky obrazovky, videa a diagramy.

Tento článek se vztahuje na: ✔️ Java ✔️ C#

Tento článek se vztahuje na: ✔️ Basic/Standard ✔️ Enterprise

Místo ruční konfigurace aplikací Spring Boot můžete k aplikacím automaticky připojit vybrané služby Azure pomocí Azure Spring Apps. Tento článek ukazuje, jak připojit aplikaci k databázi Azure Cosmos DB.

Požadavky

• Aplikace nasazená do Azure Spring Apps Další informace najdete v tématu Rychlý start: Nasazení první aplikace do Azure Spring Apps.
• Instance databáze Azure Cosmos DB.
• Azure CLI verze 2.45.0 nebo vyšší

Příprava projektu

Java

1. Do souboru pom.xml vaší aplikace přidejte jednu z následujících závislostí. Zvolte závislost, která je vhodná pro váš typ rozhraní API.

   • Typ rozhraní API: NoSQL

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

   • Typ rozhraní API: MongoDB

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

   • Typ rozhraní API: Cassandra

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

2. Aktualizujte aktuální aplikaci spuštěním az spring app deploypříkazu , nebo vytvořte nové nasazení pro tuto změnu spuštěním az spring app deployment create.

Polyglot

Všechny připojovací řetězec a přihlašovací údaje se vloží jako proměnné prostředí, na které můžete odkazovat v kódu aplikace.

Výchozí názvy proměnných prostředí najdete v následujících článcích:

• Azure Cosmos DB pro tabulku
• Azure Cosmos DB for NoSQL
• Azure Cosmos DB pro MongoDB
• Azure Cosmos DB pro Gremlin
• Azure Cosmos DB pro Cassandra

Připojení aplikace do služby Azure Cosmos DB

Service Připojení or

Poznámka:

Ve výchozím nastavení se Připojení or služby vytvářejí na úrovni aplikace. Pokud chcete přepsat připojení, můžete v nasazeních znovu vytvořit další připojení.

Použití Azure CLI

Pomocí Azure CLI nakonfigurujte aplikaci Spring tak, aby se pomocí příkazu připojila k databázi az spring connection create Cosmos NoSQL, jak je znázorněno v následujícím příkladu. Nezapomeňte nahradit proměnné v příkladu skutečnými hodnotami.

Poznámka:

Aktualizace nastavení databáze Azure Cosmos DB může trvat několik minut.

Poznámka:

Pokud používáte Cosmos Cassandra, použijte --key_space místo --database. Pokud používáte tabulku Cosmos, použijte --table místo --database. Další informace najdete v tématu Rychlý start: Vytvoření připojení služby v Azure Spring Apps pomocí 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

Poznámka:

Pokud používáte service Připojení or poprvé, spusťte příkaz az provider register --namespace Microsoft.ServiceLinker pro registraci poskytovatele prostředků Připojení služby.

Tip

Spuštěním příkazu az spring connection list-support-types --output table získejte seznam podporovaných cílových služeb a metod ověřování pro Azure Spring Apps. az spring Pokud systém příkaz nerozpozná, zkontrolujte, jestli jste nainstalovali požadované rozšíření spuštěním az extension add --name springpříkazu .

Použití portálu Azure Portal

Alternativně můžete toto připojení nakonfigurovat pomocí webu Azure Portal provedením následujících kroků. Azure Portal poskytuje stejné funkce jako Azure CLI a poskytuje interaktivní prostředí.

1. Na webu Azure Portal vyberte instanci Azure Spring Apps a v navigační nabídce vyberte Aplikace . Zvolte aplikaci, kterou chcete připojit, a v navigační nabídce vyberte Service Připojení or.

2. Vyberte Vytvořit.

3. Na kartě Základy jako typ služby vyberte Cosmos DB a pak zvolte předplatné. Jako typ rozhraní API vyberte Core (SQL), zvolte účet služby Cosmos DB a databázi. Jako typ klienta vyberte Javu a pak vyberte Další: Ověřování. Pokud jste databázi ještě nevytvořili, přečtěte si článek Rychlý start: Vytvoření účtu, databáze, kontejneru a položek Azure Cosmos DB na webu Azure Portal.

4. Na kartě Ověřování zvolte Připojení ion řetězec. Služba Připojení or automaticky načte přístupový klíč z vašeho účtu Cosmos DB. Vyberte Další: Sítě.

5. Na kartě Sítě vyberte Konfigurovat pravidla brány firewall pro povolení přístupu k cílové službě a pak vyberte Další: Zkontrolovat a vytvořit.

6. Na kartě Zkontrolovat a vytvořit počkejte, až ověření projde, a pak vyberte Vytvořit. Vytvoření může trvat několik minut.

7. Jakmile se vygeneruje propojení mezi aplikacemi Spring a databází Cosmos DB, zobrazí se na stránce service Připojení or a výběrem tlačítka rozbalení zobrazíte nakonfigurované proměnné připojení.

Terraform

Následující skript Terraformu ukazuje, jak nastavit aplikaci nasazenou do Azure Spring Apps pomocí účtu služby 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
}

Další kroky

V tomto článku jste zjistili, jak připojit aplikaci v Azure Spring Apps k databázi Azure Cosmos DB. Další informace o připojení služeb k aplikaci najdete v tématu Připojení ke službě Azure Cache for Redis Cache.