# mulesoft Azure Key Vault Properties Provider (azure-key-vault-properties-provider-connector) - Full Documentation # Azure Key Vault Properties Provider 1.0 Azure Key Vault Properties Provider は、Mule アプリケーションを実行する前に、セキュアな Azure クラウドサービスからシークレットを取得できるようにする設定です。 互換性と修正された問題については、「Azure Key Vault Properties Provider リリースノート」を参照してください。 ## [](#始める前に)始める前に このプロパティプロバイダーを使用するには、以下に精通している必要があります。 - Azure Key Vault API - Anypoint Connector - Mule Runtime Engine (Mule) - Mule フローの要素とグローバル要素 - Anypoint Studio を使用した Mule アプリケーションの作成方法 アプリケーションを作成する前に、以下が必要です。 - Mule Enterprise Edition - Azure Key Vault の対象リソースにアクセスするためのログイン情報 - Anypoint Platform - Anypoint Studio バージョン 7.3.5 以降 ## [](#properties-provider-の一般的なユースケース)Properties Provider の一般的なユースケース Azure Key Vault Properties Provide では、ランタイム前のフェーズでシークレットを取得できます。つまり、Mule アプリケーションがデプロイされる前にシークレットが取り込まれます。 ## [](#接続種別)接続種別 コネクタは、設定で Azure Key Vault Properties Provider を使用できます。MongoDB 接続種別設定で Azure Key Vault Properties Provider を使用している MongoDB Connector の例を次に示します。 ![設定ウィンドウで Azure Key Vault Properties Provider を使用している MongoDB Connector の例](/mulesoft/current/ja-jp/azure-key-vault-properties-provider-connector/1.0/_images/properties-provider-example.png) ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Azure Key Vault Properties Provider リファレンス](https://docs.mulesoft.com/jp/azure-key-vault-properties-provider-connector/1.0/azure-key-vault-properties-provider-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Azure Key Vault Properties Provider 1.0 リファレンス Azure Key Vault Properties Provider は、Mule アプリケーションを実行する前に、セキュアな Azure クラウドサービスからシークレットを取得できるようにする設定です。 ## [](#Config)設定 Azure Key Vault Properties Provider のデフォルト設定。
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Client Id (クライアント ID)

String (文字列)

アプリケーションのクライアント ID。

x

Tenant Id (テナント ID)

String (文字列)

アプリケーションのテナント ID。

x

Client Secret (クライアントシークレット)

String (文字列)

アプリケーションのクライアントシークレット。

x

Key Vault Name (Key Vault 名)

String (文字列)

接続する Vault の名前。

x

## [](#要件)要件 次のリポジトリとそれに関連付けられたログイン情報を Maven 設定に追加する必要があります。 ```xml MuleRepository2 MuleRepository2 https://repository.mulesoft.org/nexus/content/repositories/releases-ee/ default true true ``` ## [](#制限事項)制限事項 Azure Key Vault Properties Provider Connector では、プロパティプロバイダーの設定でのプロパティファイルの使用はサポートされていません。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Azure Key Vault Properties Provider 2.0 Azure Key Vault Properties Provider は、Mule アプリケーションを実行する前に、セキュアな Azure クラウドサービスからシークレットを取得できるようにする設定です。 互換性と修正された問題については、「Azure Key Vault Properties Provider リリースノート」を参照してください。 ## [](#始める前に)始める前に このプロパティプロバイダーを使用するには、以下に精通している必要があります。 - Azure Key Vault API - Anypoint Connector - Mule Runtime Engine (Mule) - Mule フローの要素とグローバル要素 - Anypoint Studio を使用した Mule アプリケーションの作成方法 アプリケーションを作成する前に、以下が必要です。 - Mule Enterprise Edition - Azure Key Vault の対象リソースにアクセスするためのログイン情報 - Anypoint Platform - Anypoint Studio バージョン 7.3.5 以降 ## [](#properties-provider-の一般的なユースケース)Properties Provider の一般的なユースケース Azure Key Vault Properties Provide では、ランタイム前のフェーズでシークレットを取得できます。つまり、Mule アプリケーションがデプロイされる前にシークレットが取り込まれます。 ## [](#接続種別)接続種別 コネクタは、設定で Azure Key Vault Properties Provider を使用できます。次に例を示します。 ![設定ウィンドウで Azure Key Vault Properties Provider を使用している MongoDB Connector の例](/mulesoft/current/ja-jp/azure-key-vault-properties-provider-connector/2.0/_images/properties-provider-example.png) ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Azure Key Vault Properties Provider リファレンス](https://docs.mulesoft.com/jp/azure-key-vault-properties-provider-connector/2.0/azure-key-vault-properties-provider-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Azure Key Vault Properties Provider 2.0 リファレンス Azure Key Vault Properties Provider は、Mule アプリケーションを実行する前に、セキュアな Azure クラウドサービスからシークレットを取得できるようにする設定です。 ## [](#Config)設定 Azure Key Vault Properties Provider のデフォルト設定。
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Client Id (クライアント ID)

String (文字列)

アプリケーションのクライアント ID。

x

Tenant Id (テナント ID)

String (文字列)

アプリケーションのテナント ID。

x

Client Secret (クライアントシークレット)

String (文字列)

アプリケーションのクライアントシークレット。

x

Key Vault Name (Key Vault 名)

String (文字列)

接続する Vault の名前。

x

Uri Override (URI 上書き)

String (文字列)

Key Vault の URI 上書き。

## [](#要件)要件 次のリポジトリとそれに関連付けられたログイン情報を Maven 設定に追加する必要があります。 ```xml MuleRepository2 MuleRepository2 https://repository.mulesoft.org/nexus/content/repositories/releases-ee/ default true true ``` ## [](#制限事項)制限事項 Azure Key Vault Properties Provider では、プロパティプロバイダーの設定でのプロパティファイルの使用はサポートされていません。 ## [](#環境変数)環境変数 環境変数を使用して Azure Key Vault を認証する場合、​`AZURE_CLIENT_ID`​、​`AZURE_CLIENT_SECRET`​、​`AZURE_TENANT_ID`​ の環境変数を設定します。詳細は、[Setting Environment Variables](https://docs.mulesoft.com/mule-runtime/latest/setting-environment-variables)を参照してください。 環境変数を設定したら、XML コネクタ設定で、​`tenantId=""`​、​`clientId=""`​、​`clientSecret=""`​ の属性を空の文字列で設定します。 XML 設定では、これらの属性は次のようになります。 ```xml ``` ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Azure Key Vault Properties Provider 2.1 Azure Key Vault Properties Provider は、Mule アプリケーションを実行する前に、セキュアな Azure クラウドサービスからシークレットを取得できるようにする設定です。 互換性と修正された問題については、「Azure Key Vault Properties Provider リリースノート」を参照してください。 ## [](#始める前に)始める前に このプロパティプロバイダーを使用するには、以下に精通している必要があります。 - Azure Key Vault API - Anypoint Connector - Mule Runtime Engine (Mule) - Mule フローの要素とグローバル要素 - Anypoint Studio を使用した Mule アプリケーションの作成方法 アプリケーションを作成する前に、以下が必要です。 - Mule Enterprise Edition - Azure Key Vault の対象リソースにアクセスするためのログイン情報 - Anypoint Platform - Anypoint Studio バージョン 7.3.5 以降 ## [](#properties-provider-の一般的なユースケース)Properties Provider の一般的なユースケース Azure Key Vault Properties Provide では、ランタイム前のフェーズでシークレットを取得できます。つまり、Mule アプリケーションがデプロイされる前にシークレットが取り込まれます。 ## [](#接続種別)接続種別 コネクタは、設定で Azure Key Vault Properties Provider を使用できます。設定で、​`${azure-key-vault-properties-provider::secret::yourSecret}`​ 構造を使用して、Azure Key Vault からシークレットを取得します。例を挙げます。 ![設定ウィンドウで Azure Key Vault Properties Provider を使用しているコネクタの例](/mulesoft/current/ja-jp/azure-key-vault-properties-provider-connector/2.1/_images/properties-provider-example.png) ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Azure Key Vault Properties Provider リファレンス](https://docs.mulesoft.com/jp/azure-key-vault-properties-provider-connector/2.1/azure-key-vault-properties-provider-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Azure Key Vault Properties Provider 2.1 リファレンス Azure Key Vault Properties Provider は、Mule アプリケーションを実行する前に、セキュアな Azure クラウドサービスからシークレットを取得できるようにする設定です。 ## [](#Config)設定 Azure Key Vault Properties Provider のデフォルト設定。
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Client Id (クライアント ID)

String (文字列)

アプリケーションのクライアント ID。設定しない場合、プロパティプロバイダーは Azure SDK のデフォルトの認証を使用し、環境変数 ​AZURE_CLIENT_ID​ でこの値を検索します。注意: 設定で指定されている場合、​tenantId​、​clientId​、​clientSecret​ を一緒に設定する必要があります。

Tenant Id (テナント ID)

String (文字列)

アプリケーションのテナント ID。設定しない場合、プロパティプロバイダーは Azure SDK のデフォルトの認証を使用し、環境変数 ​AZURE_TENANT_ID​ でこの値を検索します。注意: 設定で指定されている場合、​tenantId​、​clientId​、​clientSecret​ を一緒に設定する必要があります。

Client Secret (クライアントシークレット)

String (文字列)

アプリケーションのクライアントシークレット。設定しない場合、プロパティプロバイダーは Azure SDK のデフォルトの認証を使用し、環境変数 ​AZURE_CLIENT_SECRET​ でこの値を検索します。注意: 設定で指定されている場合、​tenantId​、​clientId​、​clientSecret​ を一緒に設定する必要があります。

Key Vault Name (Key Vault 名)

String (文字列)

接続先の Vault 名。設定しない場合、プロパティプロバイダーはシステムプロパティ ​MULE_AZURE_KEY_VAULT_NAME​ を使用します。

Uri Override (URI 上書き)

String (文字列)

Key Vault の URI 上書き。

## [](#要件)要件 次のリポジトリとそれに関連付けられたログイン情報を Maven 設定に追加します。 ```xml MuleRepository2 MuleRepository2 https://repository.mulesoft.org/nexus/content/repositories/releases-ee/ default true true ``` ## [](#制限事項)制限事項 Azure Key Vault Properties Provider では、プロパティプロバイダーの設定でのプロパティファイルの使用はサポートされていません。 ## [](#環境変数)環境変数 Mule アプリケーション設定でパラメーターを指定する代わりに、次の環境変数を使用して、環境から Azure Key Vault Properties Provider の動作を設定します。 - `AZURE_CLIENT_ID` - `AZURE_CLIENT_SECRET` - `AZURE_TENANT_ID` - `MULE_AZURE_KEY_VAULT_NAME` これらの変数は、値が暗号化された状態で安全な設定ファイルに保存されます。実行中に、ランタイムはこれらの値を復号化し、復号化された状態でメモリ内に残されます。詳細は、[Protecting App Property Values](https://docs.mulesoft.com/cloudhub-2/ch2-protect-app-props)を参照してください。 ### [](#環境変数を使用して認証する)環境変数を使用して認証する 環境変数を使用して Azure Key Vault を認証するには、次の環境変数を設定します。 - `AZURE_CLIENT_ID` - `AZURE_CLIENT_SECRET` - `AZURE_TENANT_ID` 詳細は、[Setting Environment Variables](https://docs.mulesoft.com/mule-runtime/latest/setting-environment-variables)を参照してください。 設定で ​`tenantId`​、​`clientId`​、または ​`clientSecret`​ 属性を設定しない場合、プロパティプロバイダーは環境変数の値を使用します。 XML 設定では、環境変数を使用する場合は属性を省略できます。 ```xml ``` ### [](#環境変数を使用して-key-vault-名を設定する)環境変数を使用して Key Vault 名を設定する `keyVaultName`​ 属性を設定しない場合、プロパティプロバイダーはシステムプロパティ ​`MULE_AZURE_KEY_VAULT_NAME`​ を使用します。 ```xml ``` どちらも設定しないと、プロパティプロバイダーは ​`RuntimeException`​ メッセージをスローします。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Azure Key Vault Properties Provider のバージョン 2.0 へのアップグレードおよび移行 Azure Key Vault Properties Provider をバージョン 2.0.0 にアップグレードします。 ## [](#サポートされているアップグレードパス)サポートされているアップグレードパス
開始バージョン 終了バージョン

1.0.1

2.0.0

## [](#このリリースでの変更)このリリースでの変更 このリリースには、次の変更が含まれています。 - Azure Commercial Cloud の外部にある Key Vault の URI を指定する ​**\[Uri Override (URI 上書き)\]**​ 項目が追加されました。 - Azure Key Vault Properties Provider で Azure のデフォルトログイン情報がサポートされるようになりました。環境変数を使用して認証ログイン情報を指定できます。 - プロパティプロバイダーの内部パッケージ名が変更されました。 ## [](#アップグレード前提条件)アップグレード前提条件 アップグレードを実行する前に、次の作業を完了する必要があります。 - 以前のバージョンに復元する必要がある場合に備えて、ファイル、データ、設定のバックアップを作成します。 ## [](#アップグレード手順)アップグレード手順 以下の手順でアップグレードを実行します。 1. Anypoint Studio で、Mule プロジェクトを作成します。 2. **\[Mule Palette (Mule パレット)\]**​ で、​**\[Search in Exchange (Exchange 内を検索)\]**​ をクリックします。 3. **\[Add Dependencies to Project (連動関係をプロジェクトに追加)\]**​ で、検索項目に​`「azure key vault properties provider」`​と入力します。 4. **\[Available modules (使用可能なモジュール)\]**​ で ​**\[Azure Key Vault Properties Provider\]**​ を選択し、​**\[Add (追加)\]**​ をクリックします。 5. **\[Finish (完了)\]**​ をクリックします。 6. Mule プロジェクトの ​`pom.xml`​ ファイルで Azure Key Vault Properties Provider の ​`mule4-azure-key-vault-properties-provider`​ のバージョンが 2.0.0 であることを確認します。 ### [](#アップグレードを確認する)アップグレードを確認する プロパティプロバイダーの最新バージョンをインストールしたら、アップグレードを確認します。 1. Studio の ​**\[Problems (問題)\]**​ または ​**\[Console (コンソール)\]**​ ビューでエラーがないことを確認します。 2. プロジェクトの ​`pom.xml`​ ファイルに問題がないことを確認します。 3. 接続をテストして、操作が機能することを確認します。 ### [](#アップグレードの取り消し)アップグレードの取り消し 前のバージョンの Azure Key Vault Properties Provider に戻す必要がある場合、Anypoint Studio に移動し、プロジェクトの ​`pom.xml`​ ファイルで、​`mule4-azure-key-vault-properties-provider`​ 連動関係バージョンを 2.0.0 から前のバージョンに変更します。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Azure Key Vault Properties Provider のバージョン 2.1 へのアップグレードおよび移行 Azure Key Vault Properties Provider をバージョン 2.1.0 にアップグレードします。 ## [](#サポートされているアップグレードパス)サポートされているアップグレードパス
開始バージョン 終了バージョン

1.0.1

2.1.0

## [](#このリリースでの変更)このリリースでの変更 このリリースには、次の変更が含まれています。 - Azure Commercial Cloud の外部にある Key Vault の URI を指定する ​**\[Uri Override (URI 上書き)\]**​ 項目が追加されました。 - Azure Key Vault Properties Provider で Azure のデフォルトログイン情報がサポートされるようになりました。環境変数を使用して認証ログイン情報を指定できます。 - `tenantId`​、​`clientId`​、​`clientSecret`​ 属性は省略可能になりました。これらの属性は一緒に指定する必要があります。指定しない場合、プロパティプロバイダーは環境変数の値を使用します。 - プロパティプロバイダーの内部パッケージ名が変更されました。 - `[Key Vault Name (Key Vault 名)]`​ 属性は省略可能になり、システムプロパティ ​`MULE_AZURE_KEY_VAULT_NAME`​ を使用して設定できるようになりました。 ## [](#アップグレード前提条件)アップグレード前提条件 アップグレードを実行する手順は、次のとおりです。 - 以前のバージョンに復元する必要がある場合に備えて、ファイル、データ、設定のバックアップを作成します。 ## [](#アップグレード手順)アップグレード手順 以下の手順でアップグレードを実行します。 1. Anypoint Studio で、Mule プロジェクトを作成します。 2. **\[Mule Palette (Mule パレット)\]**​ で、​**\[Search in Exchange (Exchange 内を検索)\]**​ をクリックします。 3. **\[Add Dependencies to Project (連動関係をプロジェクトに追加)\]**​ で、検索項目に​`「azure key vault properties provider」`​と入力します。 4. **\[Available modules (使用可能なモジュール)\]**​ で ​**\[Azure Key Vault Properties Provider\]**​ を選択し、​**\[Add (追加)\]**​ をクリックします。 5. **\[Finish (完了)\]**​ をクリックします。 6. Mule プロジェクトの ​`pom.xml`​ ファイルで Azure Key Vault Properties Provider の ​`mule4-azure-key-vault-properties-provider`​ のバージョンが 2.1.0 であることを確認します。 ## [](#アップグレードを確認する)アップグレードを確認する プロパティプロバイダーの最新バージョンをインストールしたら、アップグレードを確認します。 1. Studio の ​**\[Problems (問題)\]**​ または ​**\[Console (コンソール)\]**​ ビューでエラーがないことを確認します。 2. プロジェクトの ​`pom.xml`​ ファイルに問題がないことを確認します。 3. 接続をテストして、操作が機能することを確認します。 4. `[Key Vault Name (Key Vault 名)]`​ が設定ファイルまたはシステムプロパティ ​`MULE_AZURE_KEY_VAULT_NAME`​ として正しく設定されていることを確認します。 5. `tenantId`​、​`clientId`​、​`clientSecret`​ の環境変数を使用する場合は、これらが正しく設定されていることを確認し、その使用法を確認します。 ## [](#設定ファイルを更新する)設定ファイルを更新する プロジェクト設定ファイル (XML) で ​`[Key Vault Name (Key Vault 名)]`​ を指定している場合は、次のように更新します。 - `keyVaultName`​ 属性が不要な場合は、それを削除し、代わりにシステムプロパティ ​`MULE_AZURE_KEY_VAULT_NAME`​ を使用できます。 - `tenantId`​、​`clientId`​、​`clientSecret`​ が設定ファイルの属性として、または環境変数 (​`AZURE_CLIENT_ID`​、​`AZURE_CLIENT_SECRET`​、​`AZURE_TENANT_ID`​) として正しく設定されていることを確認します。 ### [](#設定の例)設定の例 環境変数を使用する場合、設定は次のようになります。 ```xml ``` または、設定内で属性を直接使用します。 ```xml ``` ## [](#アップグレードを復元する)アップグレードを復元する 以前のバージョンの Azure Key Vault Properties Provider に戻す必要がある場合は、次の手順を実行します。 1. Anypoint Studio に移動します。 2. プロジェクトの ​`pom.xml`​ ファイルで、​`mule4-azure-key-vault-properties-provider`​ 連動関係バージョンを 2.1.0 から以前のバージョンに変更します。 復元したら、設定を確認して、以前のバージョンと互換性があるように調整する必要があります。 ### [](#バージョン-2-0-0-に戻す)バージョン 2.0.0 に戻す バージョン 2.0.0 はシステムプロパティ ​`MULE_AZURE_KEY_VAULT_NAME`​ をサポートしていないため、​`keyVaultName`​ 属性が設定ファイルで明示的に設定されていることを確認します。 バージョン 2.0.0 の設定の例 ```xml ``` ### [](#以前のメジャーバージョン-例-1-0-1-に戻します)以前のメジャーバージョン (例: 1.0.1) に戻します。 `keyVaultName`​、​`tenantId`​、​`clientId`​、​`clientSecret`​ 属性が設定ファイルで明示的に設定されていることを確認します。これらのバージョンでは、システムプロパティまたは環境変数を使用したこれらの値の設定がサポートされていません。 バージョン 1.0.1 の設定の例 ```xml ``` ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com)