Azure Cosmos DB データベースを Azure Spring Cloud アプリケーションにバインドするBind an Azure Cosmos DB database to your Azure Spring Cloud application

Spring Boot アプリケーションを手動で構成するのではなく、Azure Spring Cloud を使用して、選択した Azure サービスをアプリケーションに自動的にバインドすることができます。Instead of manually configuring your Spring Boot applications, you can automatically bind select Azure services to your applications by using Azure Spring Cloud. この記事では、アプリケーションを Azure Cosmos DB データベースにバインドする方法を示します。This article demonstrates how to bind your application to an Azure Cosmos DB database.

前提条件:Prerequisites:

Azure Cosmos DB をバインドするBind Azure Cosmos DB

Azure Cosmos DB では、5 種類の API でバインドがサポートされています。Azure Cosmos DB has five different API types that support binding. その使用方法を次の手順で説明します。The following procedure shows how to use them:

  1. Azure Cosmos DB のデータベースを作成します。Create an Azure Cosmos DB database. 詳細については、データベースの作成に関するクイックスタートを参照してください。Refer to the quickstart on creating a database for help.

  2. データベースの名前を記録します。Record the name of your database. この手順では、データベース名は testdb です。For this procedure, the database name is testdb.

  3. 次の依存関係のいずれかを Azure Spring Cloud アプリケーションの pom.xml ファイルに追加します。Add one of the following dependencies to your Azure Spring Cloud application's pom.xml file. API の種類に適した依存関係を選択します。Choose the dependency that is appropriate for your API type.

    • API の種類: コア (SQL)API type: Core (SQL)

      <dependency>
          <groupId>com.microsoft.azure</groupId>
          <artifactId>azure-cosmosdb-spring-boot-starter</artifactId>
          <version>2.1.6</version>
      </dependency>
      
    • API の種類: MongoDBAPI type: MongoDB

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-mongodb</artifactId>
      </dependency>
      
    • API の種類: CassandraAPI type: Cassandra

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-cassandra</artifactId>
      </dependency>
      
    • API の種類: Gremlin (グラフ)API type: Gremlin (graph)

      <dependency>
          <groupId>com.microsoft.spring.data.gremlin</groupId>
          <artifactId>spring-data-gremlin</artifactId>
          <version>2.1.7</version>
      </dependency>
      
    • API の種類: Azure テーブルAPI type: Azure Table

      <dependency>
          <groupId>com.microsoft.azure</groupId>
          <artifactId>azure-storage-spring-boot-starter</artifactId>
          <version>2.0.5</version>
      </dependency>
      
  4. az spring-cloud app update を使用して現在のデプロイを更新するか、az spring-cloud app deployment create を使用して新しいデプロイを作成します。Use az spring-cloud app update to update the current deployment, or use az spring-cloud app deployment create to create a new deployment. これらのコマンドでは、新しい依存関係でアプリケーションが更新または作成されます。These commands will either update or create the application with the new dependency.

  5. Azure portal で、自分のAzure Spring Cloud サービスのページに移動します。Go to your Azure Spring Cloud service page in the Azure portal. アプリケーション ダッシュボードに移動し、Azure Cosmos DB にバインドするアプリケーションを選択します。Go to Application Dashboard and select the application to bind to Azure Cosmos DB. このアプリケーションは、前の手順で更新またはデプロイしたものと同じです。This application is the same one you updated or deployed in the previous step.

  6. [サービス バインド] を選択し、 [サービス バインドの作成] を選択します。Select Service binding, and select Create service binding. フォームに入力するには、次のように選択します。To fill out the form, select:

    • [バインドの種類] 値に [Azure Cosmos DB]The Binding type value Azure Cosmos DB.
    • API の種類。The API type.
    • データベース名。Your database name.
    • Azure Cosmos DB アカウント。The Azure Cosmos DB account.

    注意

    Cassandra を使用している場合は、データベース名にキー スペースを使用します。If you are using Cassandra, use a key space for the database name.

  7. アプリケーション ページで [再起動] を選択して、アプリケーションを再起動します。Restart the application by selecting Restart on the application page.

  8. サービスを確実に正しくバインドするには、バインド名を選択し、その詳細を確認します。To ensure the service is bound correctly, select the binding name and verify its details. property フィールドは次の例のようになります。The property field should be similar to this example:

    azure.cosmosdb.uri=https://<some account>.documents.azure.com:443
    azure.cosmosdb.key=abc******
    azure.cosmosdb.database=testdb
    

次のステップNext steps

この記事では、Azure Spring Cloud アプリケーションを Azure Cosmos DB データベースにバインドする方法について学習しました。In this article, you learned how to bind your Azure Spring Cloud application to an Azure Cosmos DB database. サービスをアプリケーションにバインドする方法については、Azure Cache for Redis キャッシュへのバインドに関するページを参照してください。To learn more about binding services to your application, see Bind to an Azure Cache for Redis cache.