Azure Key Vault Properties Provider のバージョン 2.1 へのアップグレードおよび移行 - Mule 4

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​) として正しく設定されていることを確認します。

設定の例

環境変数を使用する場合、設定は次のようになります。

<azure-key-vault-properties-provider:config name="Azure_Key_Vault_Properties_Provider_Config" />
xml

または、設定内で属性を直接使用します。

<azure-key-vault-properties-provider:config name="Azure_Key_Vault_Properties_Provider_Config"
    keyVaultName="connectors-vault"
    tenantId="your-tenant-id"
    clientId="your-client-id"
    clientSecret="your-client-secret"/>
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 はシステムプロパティ ​MULE_AZURE_KEY_VAULT_NAME​ をサポートしていないため、​keyVaultName​ 属性が設定ファイルで明示的に設定されていることを確認します。

バージョン 2.0.0 の設定の例

  <azure-key-vault-properties-provider:config name="Azure_Key_Vault_Properties_Provider_Config"
      keyVaultName="connectors-vault"
      tenantId=""
      clientId=""
      clientSecret=""/>
xml

以前のメジャーバージョン (例: 1.0.1) に戻します。

keyVaultName​、​tenantId​、​clientId​、​clientSecret​ 属性が設定ファイルで明示的に設定されていることを確認します。これらのバージョンでは、システムプロパティまたは環境変数を使用したこれらの値の設定がサポートされていません。

バージョン 1.0.1 の設定の例

  <azure-key-vault-properties-provider:config name="Azure_Key_Vault_Properties_Provider_Config"
     keyVaultName="connectors-vault"
     tenantId="your-tenant-id"
     clientId="your-client-id"
     clientSecret="your-client-secret"/>
xml