チュートリアル:Java Spring アプリで Key Vault 参照を使用する

[アーティクル]
12/04/2024

このチュートリアルでは、Azure App Configuration サービスを Azure Key Vault と共に使用する方法について説明します。 App Configuration と Key Vault は補完的なサービスであり、ほとんどのアプリケーションのデプロイで併用されます。

これらをまとめて使用できるように、App Configuration では、Key Vault に格納されている値を参照するキーを作成できます。 App Configuration でこのようなキーを作成すると、App Configuration には、その値そのものではなく、Key Vault の値の URI が格納されます。

App Configuration に格納されているその他のキーの場合と同様、お使いのアプリケーションは App Configuration クライアントプロバイダーを使用して Key Vault 参照を取得します。この場合、App Configuration に格納された値は、Key Vault の値を参照する URI です。これらは、Key Vault の値または資格情報ではありません。クライアントプロバイダーはキーを Key Vault 参照として認識し、Key Vault を使用して値を取得します。

アプリケーションの役割は、App Configuration と Key Vault の両方に正しく認証されることです。この 2 つのサービスが直接通信することはありません。

このチュートリアルでは、自分のコードに Key Vault 参照を実装する方法について説明します。これは、クイックスタートで紹介されている Web アプリに基づいています。先に進む前に、App Configuration を使用した Java Spring アプリの作成を済ませておいてください。

このチュートリアルの手順は、任意のコードエディターを使用して実行できます。たとえば、Visual Studio Code は、Windows、macOS、および Linux の各オペレーティングシステムで使用できるクロスプラットフォームコードエディターです。

このチュートリアルでは、以下の内容を学習します。

Key Vault に格納されている値を参照する App Configuration キーを作成する。
Java Spring アプリケーションからこのキーの値にアクセスする。

前提条件

Azure サブスクリプション - 無料アカウントを作成する
バージョン 11 を含む、サポートされている Java Development Kit (JDK)。
Apache Maven バージョン 3.0 以降。

コンテナーの作成

Azure Portal の左上隅にある [リソースの作成] オプションを選択します。
検索ボックスに「Key Vault」と入力します。
結果の一覧から [キーコンテナー] を選択します。
[キーコンテナー] で、 [追加] を選択します。
[キーコンテナーの作成] の右側に、次の情報を入力します。
- [サブスクリプション] を選択してサブスクリプションを選択します。
- [リソースグループ] で、 [新規作成] を選択し、リソースグループの名前を入力します。
- [キーコンテナー名] では、一意の名前が必要です。このチュートリアルでは、「Contoso-vault2」と入力します。
- [リージョン] ドロップダウンリストで、場所を選択します。
[キーコンテナーの作成] オプションは既定値のままにしておきます。
［作成］ を選択します

この時点で、お使いの Azure アカウントが、この新しいコンテナーへのアクセスが承認されている唯一のアカウントになります。

キーコンテナーを示すスクリーンショット。

Key Vault にシークレットを追加する

シークレットをコンテナーに追加するには、さらにいくつかの手順を行う必要があります。この場合、Key Vault の取得をテストするために使用できるメッセージを追加します。このメッセージは Message という名前で、それには "Hello from Key Vault" という値が格納されます。

Key Vault のプロパティページで、 [シークレット] を選択します。
[Generate/Import](生成/インポート) を選択します。
[シークレットの作成] ウィンドウで、次の値を入力します。
- [アップロードオプション] :「Manual」と入力します。
- Name:「Message」と入力します。
- 値: 「Hello from Key Vault」と入力します。
[シークレットの作成] の他のプロパティは既定値のままにしておきます。
［作成］ を選択します

App Configuration に Key Vault 参照を追加する

Azure portal にサインインします。 [すべてのリソース] を選択し、クイックスタートで作成した App Configuration ストアインスタンスを選択します。
[構成エクスプローラー] を選択します。
[+ 作成] 、 [キーコンテナー参照] の順に選択し、次の値を指定します。
- [キー] : [/application/config.keyvaultmessage] を選択します。
- ラベル:この値は空白のままにしておきます。
- [サブスクリプション] 、 [リソースグループ] 、 [キーコンテナー] : 前のセクションで作成したキーコンテナーの値に対応する値を入力します。
- [シークレット] : 前のセクションで作成した、Message という名前のシークレットを選択します。

Key Vault に接続する

このチュートリアルでは、Key Vault の認証にサービスプリンシパルを使用します。このサービスプリンシパルを作成するには、Azure CLI の az ad sp create-for-rbac コマンドを使用します。

az ad sp create-for-rbac -n "http://mySP" --role Contributor --scopes /subscriptions/{subscription-id} --sdk-auth

この操作では、一連のキーと値のペアが返されます。

{
"clientId": "00001111-aaaa-2222-bbbb-3333cccc4444",
"clientSecret": "aaaaaaaa-0b0b-1c1c-2d2d-333333333333",
"subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
"tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"activeDirectoryEndpointUrl": "https://login.microsoftonline.com",
"resourceManagerEndpointUrl": "https://management.azure.com/",
"sqlManagementEndpointUrl": "https://management.core.windows.net:8443/",
"galleryEndpointUrl": "https://gallery.azure.com/",
"managementEndpointUrl": "https://management.core.windows.net/"
}

次のコマンドを実行して、サービスプリンシパルがキーコンテナーにアクセスできるようにします。
```
az keyvault set-policy -n <your-unique-keyvault-name> --spn <clientId-of-your-service-principal> --secret-permissions delete get
```

次のコマンドを実行して object-id を取得し、それを App Configuration に追加します。

az ad sp show --id <clientId-of-your-service-principal>
az role assignment create --role "App Configuration Data Reader" --scope /subscriptions/<subscriptionId>/resourceGroups/<group-name> --assignee-principal-type --assignee-object-id <objectId-of-your-service-principal> --resource-group <your-resource-group>

AZURE_CLIENT_ID、AZURE_CLIENT_SECRET、および AZURE_TENANT_ID 環境変数を作成します。前の手順で表示されたサービスプリンシパルの値を使用します。コマンドラインで次のコマンドを実行してコマンドプロンプトを再起動し、変更が反映されるようにします。
```
setx AZURE_CLIENT_ID "clientId"
setx AZURE_CLIENT_SECRET "clientSecret"
setx AZURE_TENANT_ID "tenantId"
```
Windows PowerShell を使用する場合は、次のコマンドを実行します。
```
$Env:AZURE_CLIENT_ID = "clientId"
$Env:AZURE_CLIENT_SECRET = "clientSecret"
$Env:AZURE_TENANT_ID = "tenantId"
```
macOS または Linux を使用する場合は、次のコマンドを実行します。
```
export AZURE_CLIENT_ID ='clientId'
export AZURE_CLIENT_SECRET ='clientSecret'
export AZURE_TENANT_ID ='tenantId'
```

Note

これらの Key Vault 資格情報は、お使いのアプリケーション内でのみ使用されます。アプリケーションの認証は、App Configuration サービスを必要とせず、これらの資格情報を使用して Key Vault に対して直接行われます。 Key Vault は、キーを共有したり公開したりすることなく、アプリケーションと App Configuration サービスの両方の認証を提供します。

Key Vault 参照を使用するようコードを更新する

APP_CONFIGURATION_ENDPOINT という環境変数を作成します。その値を App Configuration ストアのエンドポイントに設定します。エンドポイントは、Azure portal の [アクセスキー] ブレードで確認できます。変更を有効にするために、コマンドプロンプトを再起動します。
resources フォルダーの構成ファイルを開きます。 APP_CONFIGURATION_ENDPOINT 値を使用するようにこのファイルを更新します。このファイル内の接続文字列への参照をすべて削除します。

yaml
properties

spring:
    cloud:
        azure:
            appconfiguration:
                stores:
                    - endpoint: ${APP_CONFIGURATION_ENDPOINT}

spring.cloud.azure.appconfiguration.stores[0].endpoint= ${APP_CONFIGURATION_ENDPOINT}

注意

Spring Cloud Azure のグローバル構成を使用して、Key Vault に接続することもできます。

MessageProperties.java を開きます。 keyVaultMessage という新しい変数を追加します。

private String keyVaultMessage;

public String getKeyVaultMessage() {
    return keyVaultMessage;
}

public void setKeyVaultMessage(String keyVaultMessage) {
    this.keyVaultMessage = keyVaultMessage;
}

HelloController.java を開きます。 Key Vault から取得したメッセージが含まれるように getMessage メソッドを更新します。

@GetMapping
public String getMessage() {
    return "Message: " + properties.getMessage() + "\nKey Vault message: " + properties.getKeyVaultMessage();
}

Spring Boot アプリケーションを Maven でビルドし、実行します。次に例を示します。
```
mvn clean package
mvn spring-boot:run
```
アプリケーションが実行されたら、curl を使用してアプリケーションをテストできます。次に例を示します。
```
curl -X GET http://localhost:8080/
```
App Configuration ストアに入力したメッセージが表示されます。 Key Vault に入力したメッセージも表示されます。

リソースをクリーンアップする

この記事で作成したリソースを継続して使用しない場合は、ここで作成したリソースグループを削除して課金されないようにしてください。

重要

リソースグループを削除すると、元に戻すことができません。リソースグループとそのすべてのリソースは完全に削除されます。間違ったリソースグループやリソースをうっかり削除しないようにしてください。この記事のリソースを、保持したい他のリソースを含むリソースグループ内に作成した場合は、リソースグループを削除する代わりに、各リソースをそれぞれのペインから個別に削除します。

Azure portal にサインインし、 [リソースグループ] を選択します。
[名前でフィルター] ボックスにリソースグループの名前を入力します。
結果一覧でリソースグループ名を選択し、概要を表示します。
[リソースグループの削除] を選択します。
リソースグループの削除の確認を求めるメッセージが表示されます。確認のためにリソースグループの名前を入力し、 [削除] を選択します。

しばらくすると、リソースグループとそのすべてのリソースが削除されます。

次のステップ

このチュートリアルでは、Key Vault に格納されている値を参照する App Configuration キーを作成しました。その他の質問については、リファレンスドキュメントを参照してください。Spring Cloud Azure App Configuration ライブラリのしくみに関する詳細がすべて記載されています。 Java Spring アプリケーションで機能フラグを使用する方法については、次のチュートリアルに進んでください。

マネージド ID の統合

次の方法で共有