Azure Load Testing でシークレットと環境変数を使用する

[アーティクル]
01/16/2024

この記事では、Azure Load Testing のロードテストにパラメーターとしてシークレットと環境を渡す方法について説明します。パラメーターを使うと、Apache JMeter スクリプトを編集しなくても、ロードテストの動作を変更できます。たとえば、Web アプリケーションをテストするには、エンドポイント URL をパラメーターとして指定して、複数の環境でテストスクリプトを再利用します。パラメーターを使用して、JMeter テストスクリプトに機密情報をハードコーディングする必要がないようにすることもできます。

Azure Load Testing サービスでは、次の 2 種類のパラメーターがサポートされています。

シークレット: 機密情報が含まれ、ロードテストエンジンに安全に渡されます。たとえば、シークレットをテストスクリプトにハードコーディングするのではなく、Web サービスの資格情報が提供されます。詳細については、「シークレットを使用してロードテストを構成する」を参照してください。
環境変数: 機密性の高くない情報が含まれており、ロードテストエンジンで環境変数として使用できます。たとえば、環境変数を使用すると、アプリケーションエンドポイントの URL が構成可能になります。詳細については、「環境変数を使用してロードテストを構成する」を参照してください。

新しいテストの作成時、または既存のテストの更新時に、ロードテスト構成でパラメーターを指定できます。 CI/CD ワークフローでロードテストを実行する場合は、ロードテスト構成ファイルまたは CI/CD ワークフロー定義でパラメーターを定義します。

前提条件

アクティブなサブスクリプションが含まれる Azure アカウント。 Azure サブスクリプションをお持ちでない場合は、始める前に無料アカウントを作成してください。
Azure ロードテストリソース。 Azure Load Testing リソースを作成する必要がある場合は、ロードテストの作成と実行に関するクイックスタートを参照してください。

シークレットを使用してロードテストを構成する

このセクションでは、Azure Load Testing でロードテストスクリプトにシークレットを渡す方法について説明します。たとえば、ロードテストを行う Web サービスエンドポイントに API キーを渡すためにシークレットを使う場合があります。 API キーを構成に格納したり、スクリプトにハードコーディングしたりする代わりに、シークレットストアに格納してシークレットへのアクセスを厳密に制御できます。

Azure Load Testing を使うと、Azure Key Vault にシークレットを格納できます。また、CI/CD パイプラインでロードテストを実行する場合、Azure Pipelines や GitHub Actions など、CI/CD テクノロジに関連付けられたシークレットストアを使うこともできます。

Azure Load Testing でシークレットを使うには、次の手順を実行します。

シークレット値をシークレットストア (Azure Key Vault または CI/CD シークレットストア) に格納します。
Apache JMeter テストスクリプトにシークレットへの参照を渡します。
カスタム関数 GetSecret を使って、Apache JMeter テストスクリプト内でシークレット値を使います。

重要

GetSecret カスタム関数は、Azure Load Testing で JMeter テストスクリプトを実行するときにのみ使用できます。テストスクリプトをローカル環境で実行する場合は、テストスクリプトを更新し、別の方法でシークレット値を読み取る必要があります。

Azure Key Vault を使ってロードテストのシークレットを格納する

Azure Key Vault を使って、Azure Load Testing のテストスクリプトにシークレット値を渡すことができます。 Azure Load Testing の構成にシークレットへの参照を追加します。次に、Azure Load Testing はこの参照を使って、Apache JMeter スクリプトのシークレット値を取得します。

また、シークレット値を取得するために、Azure Load Testing に Azure キーコンテナーへのアクセス権を付与する必要があります。

Note

ロードテストを CI/CD プロセスの一部として実行する場合は、関連するシークレットストアを使用することもできます。「CI/CD シークレットストアを使用する」に進んでください。

Azure Key Vault でシークレットを作成する

キーコンテナーにシークレット値を追加します (まだ行っていない場合)。

重要

ファイアウォールまたは仮想ネットワークによって Azure キーコンテナーへのアクセスを制限した場合は、次の手順に従って、信頼できる Azure サービスにアクセス権を付与します。
シークレットのキーコンテナー シークレット識別子を取得します。このシークレット識別子を使用して、ロードテストを構成します。

シークレット識別子は Azure キーコンテナー内のシークレットの完全な URI です。必要に応じて、バージョン番号を含めることもできます。たとえば、https://myvault.vault.azure.net/secrets/mysecret/ または https://myvault.vault.azure.net/secrets/mysecret/abcdef01-2345-6789-0abc-def012345678 です。

ロードテストにシークレットを追加する

ロードテスト構成でシークレットを参照します。

Apache JMeter スクリプトで参照する各シークレットに対して、ロードテストのシークレットパラメーターを定義します。このパラメーター名は、Apache JMeter テストスクリプトで使用するシークレット名と一致する必要があります。パラメーター値はキーコンテナーのセキュリティ識別子です。

次のいずれかを実行して、シークレットパラメーターを指定できます。
- Azure portal で、ロードテストを選択し、[構成] を選択し、[パラメーター] タブを選択して、パラメーターの詳細を入力します。
- CI/CD ワークフローを構成し、Azure Key Vault を使う場合は、YAML 構成ファイルで secrets プロパティを使ってシークレットを指定できます。構文の詳細については、テスト構成 YAML リファレンスに関する記事を参照してください。
Azure Load Testing が Azure Key Vault 内のシークレットにアクセスするために使う ID を指定します。

ID は、ロードテストリソースのシステム割り当て ID、またはユーザー割り当て ID のいずれかを指定できます。必ず以前にアクセスを許可したものと同じ ID を使ってください。

キーコンテナーの参照 ID は、次のいずれかの方法で指定できます。
- Azure portal でロードテストを選び、[構成] を選び、[パラメーター] タブを選び、Key Vault の参照 ID を構成します。
- CI/CD ワークフローを構成し、Azure Key Vault を使う場合は、YAML 構成ファイルで keyVaultReferenceIdentity プロパティを使って参照 ID を指定できます。構文の詳細については、テスト構成 YAML リファレンスに関する記事を参照してください。

Azure Key Vault にアクセス権を付与する

ロードテストシークレットまたは証明書を Azure Key Vault に格納すると、ロードテストリソースでは、キーコンテナーにアクセスするためにマネージド IDが使用されます。マネージド ID を構成したら、ロードテストリソースのマネージド ID に、キーコンテナーからこれらの値を読み取るアクセス許可を付与する必要があります。

Azure Key Vault からシークレットまたは証明書を読み取るアクセス許可を Azure ロードテストリソースに付与するには:

Azure portal で Azure キーコンテナーリソースに移動します。

キーコンテナーがない場合は、「Azure Key Vault のクイックスタート」の手順に従って作成します。
左側のウィンドウで、[アクセスポリシー] を選択し、[+ 作成] を選択します。
[アクセス許可] タブの [シークレットのアクセス許可] で、[取得] を選択し、[次へ] を選択します。

Note

Azure Load Testing では、証明書の秘密キーが使用可能であることを確認するために、証明書がシークレットとして取得されます。
[プリンシパル] タブで、ロードテストリソースのマネージド ID を検索して選択し、[次へ] を選択します。

システム割り当てマネージド ID を使用している場合、マネージド ID 名は Azure ロードテストリソースの名前と一致します。
次へを再度選択します。

テストの実行時に、ロードテストリソースに関連付けられているマネージド ID で、キーコンテナーからロードテストのシークレットまたは証明書が読み取れるようになりました。

Azure Key Vault にシークレットを追加し、ロードテスト用のシークレットを構成したので、「Apache JMeter でシークレットを使用する」に進むことができます。

CI/CD シークレットストアを使ってロードテストのシークレットを保存する

CI/CD ワークフローで Azure Load Testing を使用している場合は、関連付けられているシークレットストアを使用することもできます。たとえば、GitHub リポジトリシークレットまたは Azure Pipelines のシークレット変数を使用できます。

Note

既にキーコンテナーを使用している場合は、それを使用してロードテストのシークレットを格納することもできます。「Azure キーコンテナーを使用する」に進んでください。

CI/CD シークレットストア内のシークレットを使い、それを CI/CD でロードテストに渡すには:

まだ存在しない場合は、CI/CD シークレットストアにシークレット値を追加します。

Azure Pipelines では、パイプラインを編集して変数を追加できます。

GitHub では、GitHub リポジトリシークレットを使用できます。

Note

値としてキーコンテナーシークレット識別子ではなく、実際のシークレット値を使用してください。

CI/CD ワークフローの Load Testing タスクまたはアクションの入力パラメーターとしてシークレットを渡します。

次の YAML スニペットは、Load Testing GitHub アクションにシークレットを渡す方法を示しています。

- name: 'Azure Load Testing'
  uses: azure/load-testing@v1
  with:
    loadtestConfigFile: 'SampleApp.yaml'
    loadtestResource: 'MyTest'
    resourceGroup: 'loadtests-rg'
    secrets: |
    [
        {
        "name": "appToken",
        "value": "${{ secrets.MY_SECRET }}"
        }
    ]

次の YAML スニペットは、Azure Pipelines タスクにシークレットを渡す方法を示しています。

- task: AzureLoadTest@1
  inputs:
    azureSubscription: 'MyAzureLoadTestingRG'
    loadTestConfigFile: 'SampleApp.yaml'
    loadTestResource: 'MyTest'
    resourceGroup: 'loadtests-rg'
    secrets: |
      [
          {
          "name": "appToken",
          "value": "$(mySecret)"
          }
      ]

重要

シークレット入力パラメーターの名前は、Apache JMeter スクリプトで使用される名前と一致する必要があります。

これで、CI/CD シークレットストアにシークレットを指定し、Azure Load Testing に参照を渡す手順を完了しました。 Apache JMeter スクリプトでシークレットを使用できるようになりました。

Apache JMeter でシークレットを使用する

次に、先ほど指定したシークレットを使うように Apache JMeter スクリプトを更新します。

まず、シークレット値を取得するユーザー定義変数を作成します。次に、この変数をテスト内で使います (たとえば、HTTP 要求ヘッダーで API トークンを渡すため)。

JMX ファイルにユーザー定義変数を作成し、GetSecret カスタム関数を使用してシークレット値をこれに割り当てます。

GetSecret(<my-secret-name>) 関数は、引数としてシークレット名を受け取ります。この名前は、後の手順でロードテストを構成するときに使用します。

次の図に示すように、Apache JMeter IDE を使用してユーザー定義変数を作成できます。

または、次のコードスニペットの例に示すように、JMX ファイルを直接編集することもできます。
```
<Arguments guiclass="ArgumentsPanel" testclass="Arguments" testname="User Defined Variables" enabled="true">
  <collectionProp name="Arguments.arguments">
    <elementProp name="appToken" elementType="Argument">
      <stringProp name="Argument.name">udv_appToken</stringProp>
      <stringProp name="Argument.value">${__GetSecret(appToken)}</stringProp>
      <stringProp name="Argument.desc">Value for x-secret header </stringProp>
      <stringProp name="Argument.metadata">=</stringProp>
    </elementProp>
  </collectionProp>
</Arguments>
```

テストスクリプト内のユーザー定義変数を参照します。

${} 構文を使用して、スクリプト内の変数を参照できます。次の例では、udv_appToken 変数を使用して HTTP ヘッダーを設定します。

  <HeaderManager guiclass="HeaderPanel" testclass="HeaderManager" testname="HTTP Header Manager" enabled="true">
    <collectionProp name="HeaderManager.headers">
      <elementProp name="" elementType="Header">
        <stringProp name="Header.name">api-key</stringProp>
        <stringProp name="Header.value">${udv_appToken}</stringProp>
      </elementProp>
    </collectionProp>
  </HeaderManager>

環境変数を使用してロードテストを構成する

このセクションでは、環境変数を使用して、ロードテストにパラメーターを渡します。

環境変数を使用するように Apache JMeter スクリプトを更新します (たとえば、アプリケーションエンドポイントのホスト名を構成します)。
ロードテストを構成し、環境変数をテストスクリプトに渡します。

Apache JMeter で環境変数を使用する

このセクションでは、環境変数を使用してスクリプトの動作を制御するように、Apache JMeter スクリプトを更新します。

まず、環境変数を読み取るユーザー定義変数を定義します。次に、この変数をテストの実行で使用できます (たとえば、HTTP ドメインを更新します)。

JMX ファイルにユーザー定義変数を作成し、System.getenv 関数を使用して環境変数の値をこれに割り当てます。

System.getenv("<my-variable-name>") 関数は、引数として環境変数名を受け取ります。ロードテストを構成するときに、この同じ名前を使います。

次の図に示すように、Apache JMeter IDE を使用してユーザー定義変数を作成できます。

または、次のコードスニペットの例に示すように、JMX ファイルを直接編集することもできます。
```
<Arguments guiclass="ArgumentsPanel" testclass="Arguments" testname="User Defined Variables" enabled="true">
  <collectionProp name="Arguments.arguments">
    <elementProp name="appToken" elementType="Argument">
      <stringProp name="Argument.name">udv_webapp</stringProp>
      <stringProp name="Argument.value">${__BeanShell( System.getenv("webapp") )}</stringProp>
      <stringProp name="Argument.desc">Web app URL</stringProp>
      <stringProp name="Argument.metadata">=</stringProp>
    </elementProp>
  </collectionProp>
</Arguments>
```
テストスクリプト内のユーザー定義変数を参照します。

${} 構文を使用して、スクリプト内の変数を参照できます。次の例では、udv_webapp 変数を使用して、アプリケーションエンドポイントの URL を構成します。
```
<stringProp name="HTTPSampler.domain">${udv_webapp}</stringProp>
```

Azure Load Testing で環境変数を構成する

環境変数を Apache JMeter スクリプトに渡すには、Azure portal、YAML テスト構成ファイル、または CI/CD ワークフローで直接、ロードテストを構成できます。

重要

ロードテストの環境変数を定義する場合、その名前は Apache JMeter スクリプトで使用した変数名と一致する必要があります。

Azure portal を使用してロードテストに環境変数を指定するには、次の手順を実行します。

テスト構成ページで、[パラメーター] タブを選択します。
[環境変数] セクションで、環境変数の [名前] と [値] を入力し、[適用] を選択します。

CI/CD ワークフローでロードテストを実行する場合は、YAML テスト構成ファイルで環境変数を定義できます。構文の詳細については、テスト構成 YAML リファレンスに関する記事を参照してください。

または、CI/CD ワークフロー定義で環境変数を直接指定することもできます。 Azure Load Testing アクションまたは Azure Pipelines タスクの入力パラメーターを使用して、環境変数を Apache JMeter スクリプトに渡します。

次の YAML スニペットは、GitHub Actions の例を示しています。

- name: 'Azure Load Testing'
  uses: azure/load-testing
  with:
    loadtestConfigFile: 'SampleApp.yaml'
    loadtestResource: 'MyTest'
    resourceGroup: 'loadtests-rg'
    env: |
    [
        {
        "name": "webapp",
        "value": "myapplication.contoso.com"
        }
    ]

次の YAML スニペットは、Azure Pipelines の例を示しています。

- task: AzureLoadTest@1
  inputs:
    azureSubscription: 'MyAzureLoadTestingRG'
    loadTestConfigFile: 'SampleApp.yaml'
    loadTestResource: 'MyTest'
    resourceGroup: 'loadtests-rg'
    env: |
      [
          {
          "name": "webapp",
          "value": "myapplication.contoso.com"
          }
      ]

よく寄せられる質問

Azure Load Testing サービスにシークレット値は格納されますか?

いいえ。 Azure Load Testing サービスにはシークレットの値は格納されません。キーコンテナーのシークレット URI を使用する場合、サービスではシークレット URI のみが格納され、テスト実行ごとにシークレットの値が取り込まれます。シークレットの値を CI/CD ワークフローで指定する場合、シークレットの値はテストの実行後に使用できません。これらの値はテストの実行ごとに指定します。

YAML 構成ファイルと CI/CD ワークフローの両方にパラメーターがある場合は、どうなるでしょうか。

YAML 構成ファイルと Azure Load Testing アクションまたは Azure Pipelines タスクの両方にパラメーターが存在する場合は、CI/CD ワークフローの値がテストの実行に使用されます。

Azure Load Testing のタスクまたはアクションを使用してパラメーターを渡すことによって、CI/CD ワークフローからテストを作成して実行しました。同じパラメーターを使用して、Azure portal からこのテストを実行できますか?

パラメーターの値は、CI/CD ワークフローから渡された場合は格納されません。 Azure portal からテストを実行するときに、パラメーター値を再度指定する必要があります。不足している値を入力するように求めるメッセージが表示されます。シークレット値については、キーコンテナーのシークレット URI を入力します。テストの実行または再実行のページで入力した値は、そのテストの実行についてのみ有効です。テストレベルで変更を行う場合は、[Configure Test]$テストの構成 $ に移動し、パラメーター値を入力します。

シークレットを使用して、セキュリティで保護されたエンドポイントをロードテストします。
CSV ファイルの読み取りについて詳しくは、ロードテストでの CSV ファイルの読み取りに関する記事を参照してください。

次の方法で共有

Azure Load Testing でシークレットと環境変数を使用する

前提条件

シークレットを使用してロードテストを構成する

Azure Key Vault を使ってロードテストのシークレットを格納する

Azure Key Vault でシークレットを作成する

ロードテストにシークレットを追加する

Azure Key Vault にアクセス権を付与する

CI/CD シークレットストアを使ってロードテストのシークレットを保存する

Apache JMeter でシークレットを使用する

環境変数を使用してロードテストを構成する

Apache JMeter で環境変数を使用する

Azure Load Testing で環境変数を構成する

よく寄せられる質問

Azure Load Testing サービスにシークレット値は格納されますか?

YAML 構成ファイルと CI/CD ワークフローの両方にパラメーターがある場合は、どうなるでしょうか。

Azure Load Testing のタスクまたはアクションを使用してパラメーターを渡すことによって、CI/CD ワークフローからテストを作成して実行しました。同じパラメーターを使用して、Azure portal からこのテストを実行できますか?

フィードバック

その他のリソース

次の方法で共有

Azure Load Testing でシークレットと環境変数を使用する

前提条件

シークレットを使用してロード テストを構成する

Azure Key Vault を使ってロード テストのシークレットを格納する

Azure Key Vault でシークレットを作成する

ロード テストにシークレットを追加する

Azure Key Vault にアクセス権を付与する

CI/CD シークレット ストアを使ってロード テストのシークレットを保存する

Apache JMeter でシークレットを使用する

環境変数を使用してロード テストを構成する

Apache JMeter で環境変数を使用する

Azure Load Testing で環境変数を構成する

よく寄せられる質問

Azure Load Testing サービスにシークレット値は格納されますか?

YAML 構成ファイルと CI/CD ワークフローの両方にパラメーターがある場合は、どうなるでしょうか。

Azure Load Testing のタスクまたはアクションを使用してパラメーターを渡すことによって、CI/CD ワークフローからテストを作成して実行しました。 同じパラメーターを使用して、Azure portal からこのテストを実行できますか?

関連するコンテンツ

フィードバック

その他のリソース

シークレットを使用してロードテストを構成する

Azure Key Vault を使ってロードテストのシークレットを格納する

ロードテストにシークレットを追加する

CI/CD シークレットストアを使ってロードテストのシークレットを保存する

環境変数を使用してロードテストを構成する

Azure Load Testing のタスクまたはアクションを使用してパラメーターを渡すことによって、CI/CD ワークフローからテストを作成して実行しました。同じパラメーターを使用して、Azure portal からこのテストを実行できますか?