az load test
手記
このリファレンスは、Azure CLI (バージョン 2.66.0 以降) の 読み込み 拡張機能の一部です。 az load test コマンドを初めて実行すると、拡張機能が自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
このコマンド グループはプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
ロード テストを管理するコマンド グループ。
作成、更新、削除、一覧表示などを使用してロード テストを管理するコマンド グループ。
コマンド
名前 | 説明 | 型 | 状態 |
---|---|---|---|
az load test app-component |
アプリ コンポーネントを管理するコマンド グループ。 |
延長 | プレビュー |
az load test app-component add |
アプリ コンポーネントをテストに追加します。 |
延長 | プレビュー |
az load test app-component list |
テスト用のすべてのアプリ コンポーネントを一覧表示します。 |
延長 | プレビュー |
az load test app-component remove |
特定のアプリ コンポーネントをテストから削除します。 |
延長 | プレビュー |
az load test compare-to-baseline |
最近のテスト実行のサンプラー統計とベースライン テスト実行の統計を比較します。 |
延長 | プレビュー |
az load test convert-to-jmx |
URL 型テストを JMX テストに変換します。 |
延長 | プレビュー |
az load test create |
新しいロード テストを作成します。 |
延長 | プレビュー |
az load test delete |
既存のロード テストを削除します。 |
延長 | プレビュー |
az load test download-files |
既存のロード テストのファイルをダウンロードします。 |
延長 | プレビュー |
az load test file |
テスト ファイルに対する操作のコマンド グループ。 |
延長 | プレビュー |
az load test file delete |
テストからファイルを削除します。 |
延長 | プレビュー |
az load test file download |
テストからファイルをダウンロードします。 |
延長 | プレビュー |
az load test file list |
テスト内のすべてのファイルを一覧表示します。 |
延長 | プレビュー |
az load test file upload |
ファイルをテストにアップロードします。 |
延長 | プレビュー |
az load test list |
特定のロード テスト リソース内のすべてのテストを一覧表示します。 |
延長 | プレビュー |
az load test server-metric |
サーバー メトリックを管理するコマンド グループ。 |
延長 | プレビュー |
az load test server-metric add |
テストにサーバー メトリックを追加します。 |
延長 | プレビュー |
az load test server-metric list |
テストのすべてのサーバー メトリックを一覧表示します。 |
延長 | プレビュー |
az load test server-metric remove |
指定されたサーバー メトリックをテストから削除します。 |
延長 | プレビュー |
az load test set-baseline |
テストの実行を、テスト内の他の実行と比較するためのベースラインとして設定します。 |
延長 | プレビュー |
az load test show |
テストの詳細を表示します。 |
延長 | プレビュー |
az load test update |
既存のロード テストを更新します。 |
延長 | プレビュー |
az load test compare-to-baseline
コマンド グループ 'ロード テスト' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
最近のテスト実行のサンプラー統計とベースライン テスト実行の統計を比較します。
az load test compare-to-baseline --load-test-resource
--test-id
[--aggregation {MAX, MEAN, MEDIAN, MIN, P75, P90, P95, P96, P98, P99, P999, P9999}]
[--resource-group]
例
最近のテスト実行をベースラインと比較します。
az load test compare-to-baseline --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id -o table
最近のテスト実行を、特定の集計を使用してベースラインと比較します。
az load test compare-to-baseline --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id --aggregation P95 -o table
必須のパラメーター
ロード テスト リソースの名前または ARM リソース ID。
ロード テストのテスト ID。
省略可能のパラメーター
応答時間の集計方法を指定します。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az load test convert-to-jmx
コマンド グループ 'ロード テスト' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
URL 型テストを JMX テストに変換します。
az load test convert-to-jmx --load-test-resource
--test-id
[--resource-group]
[--yes]
例
JMX テストに変換します。
az load test convert-to-jmx --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id
必須のパラメーター
ロード テスト リソースの名前または ARM リソース ID。
ロード テストのテスト ID。
省略可能のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
確認を求めないでください。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az load test create
コマンド グループ 'ロード テスト' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
新しいロード テストを作成します。
az load test create --load-test-resource
--test-id
[--autostop]
[--autostop-error-rate]
[--autostop-time-window]
[--certificate]
[--description]
[--disable-public-ip]
[--display-name]
[--engine-instances]
[--env]
[--keyvault-reference-id]
[--load-test-config-file]
[--no-wait]
[--regionwise-engines]
[--resource-group]
[--secret]
[--split-csv]
[--subnet-id]
[--test-plan]
[--test-type {JMX, URL}]
例
ロード テスト構成ファイルを使用してテストを作成します。
az load test create --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-test-id --load-test-config-file ~/resources/sample-config.yaml
引数を使用してテストを作成します。
az load test create --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --display-name "Sample Name" --description "Test description" --test-plan sample-jmx.jmx --engine-instances 1 --env rps=2 count=1
ロード テスト構成ファイルを使用してテストを作成し、引数を使用して engine-instance と env をオーバーライドし、ファイルのアップロードを待機しないでください。
az load test create --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-test-id --load-test-config-file ~/resources/sample-config.yaml --engine-instances 1 --env rps=2 count=1 --no-wait
シークレットと環境変数を使用してテストを作成します。
az load test create --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --display-name "Sample Name" --description "Test description" --test-plan sample-jmx.jmx --secret secret_name1=secret_uri1 secret_name2=secret_uri2 --env rps=2 count=1
ユーザー割り当てマネージド ID を使用してシークレットを使用してテストを作成し、Key Vault にアクセスします。
az load test create --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --display-name "Sample Name" --secret secret_name1=secret_uri1 secret_name2=secret_uri2 --keyvault-reference-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/microsoft.managedidentity/userassignedidentities/sample-mi"
分割 CSV オプションを有効にして、仮想ネットワーク内のプライベート エンドポイントのテストを作成します。
az load test create --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --display-name "Sample Name" --subnet-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.Network/virtualNetworks/SampleVMVNET/subnets/SampleVMSubnet" --split-csv true
カスタム定義の自動ストップ条件を使用してテストを作成するか、テストの自動ストップを有効または無効にします。
az load test create --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --display-name "Sample Name" --autostop-error-rate 80.5 --autostop-time-window 120
az load test create --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --display-name "Sample Name" --autostop disable
az load test create --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --display-name "Sample Name" --autostop enable
Azure Resource Manager (ARM) で受け入れられる形式のリージョン名を使用して、複数リージョンのロード構成でテストを作成します。 指定したリージョンが Azure Load Testing でサポートされていることを確認します。 複数リージョンのロード テストは、パブリック エンドポイントのみに制限されます。
az load test create --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --engine-instances 3 --regionwise-engines eastus=1 westus2=1 germanywestcentral=1 --test-plan sample-jmx.jmx
JSON ファイルを使用して、複数の HTTP 要求を含む高度な URL テストを作成します。
az load test create --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --test-plan ~/resources/sample-url-requests.json --test-type URL
必須のパラメーター
ロード テスト リソースの名前または ARM リソース ID。
ロード テストのテスト ID。
省略可能のパラメーター
自動停止を有効にするか無効にするか。 使用可能な値は有効/無効です。
テストの実行を自動的に停止する必要があるエラーのしきい値の割合。 使用できる値の範囲は [0.0,100.0] です。
エラー率を秒単位で評価する期間。
'key[=value]' 形式の 1 つの証明書。 証明書は PFX 形式で Azure Key Vault に格納し、証明書識別子を値として指定する必要があります。
ロード テストの説明。
プライベート エンドポイントのテスト中に、パブリック IP アドレス、ロード バランサー、およびネットワーク セキュリティ グループのデプロイを無効にします。
ロード テストの表示名。
テストを実行するエンジン インスタンスの数。
スペース区切りの環境変数: key[=value] [key[=value] ...]
キー コンテナーへのアクセスに使用される ID。
ロード テスト構成ファイルへのパス。 https://learn.microsoft.com/azure/load-testing/reference-test-config-yamlを参照してください。
実行時間の長い操作が完了するまで待つ必要はありません。
各リージョンのエンジン数を、region1=engineCount1 region2=engineCount2 ...の形式で指定します。リージョン名は、Azure Resource Manager (ARM) で受け入れられる形式で使用します。 リージョンが Azure Load Testing でサポートされていることを確認します。 複数リージョンのロード テストでは、パブリック エンドポイントのみを対象にすることができます。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
スペース区切りのシークレット: key[=value] [key[=value] ...]シークレットは Azure Key Vault に格納し、シークレット識別子を値として指定する必要があります。
エンジン インスタンス間で CSV ファイルを均等に分割します。
プライベート ロード テストに使用するサブネットのリソース ID。
テスト 計画ファイルへの参照。
testType: JMX
場合: JMeter スクリプトへのパス。
testType: URL
場合: 要求 JSON ファイルへのパス。
ロード テストの種類。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az load test delete
コマンド グループ 'ロード テスト' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
既存のロード テストを削除します。
az load test delete --load-test-resource
--test-id
[--resource-group]
[--yes]
例
ロード テストを削除します。
az load test delete --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id
必須のパラメーター
ロード テスト リソースの名前または ARM リソース ID。
ロード テストのテスト ID。
省略可能のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
確認を求めないでください。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az load test download-files
コマンド グループ 'ロード テスト' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
既存のロード テストのファイルをダウンロードします。
az load test download-files --load-test-resource
--path
--test-id
[--force]
[--resource-group]
例
テストのすべてのファイルをダウンロードします。 ディレクトリは既に存在している必要があります。
az load test download-files --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --path ~/downloads
ディレクトリが存在しない場合は、ディレクトリを作成して、テストのすべてのファイルをダウンロードします。
az load test download-files --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --path "~/downloads/new folder" --force
必須のパラメーター
ロード テスト リソースの名前または ARM リソース ID。
ファイルをダウンロードするディレクトリのパス。
ロード テストのテスト ID。
省略可能のパラメーター
コマンドを強制的に実行します。 これにより、ファイルが存在しない場合にダウンロードするディレクトリが作成されます。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az load test list
コマンド グループ 'ロード テスト' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
特定のロード テスト リソース内のすべてのテストを一覧表示します。
az load test list --load-test-resource
[--resource-group]
例
リソース内のすべてのロード テストを一覧表示します。
az load test list --load-test-resource sample-alt-resource --resource-group sample-rg
必須のパラメーター
ロード テスト リソースの名前または ARM リソース ID。
省略可能のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az load test set-baseline
コマンド グループ 'ロード テスト' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
テストの実行を、テスト内の他の実行と比較するためのベースラインとして設定します。
az load test set-baseline --load-test-resource
--test-id
--test-run-id
[--resource-group]
例
ベースライン テストの実行を設定します。
az load test set-baseline --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id --test-run-id sample-associated-test-run-id
必須のパラメーター
ロード テスト リソースの名前または ARM リソース ID。
ロード テストのテスト ID。
ロード テストの実行のテスト実行 ID。
省略可能のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az load test show
コマンド グループ 'ロード テスト' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
テストの詳細を表示します。
az load test show --load-test-resource
--test-id
[--resource-group]
例
ロード テストの詳細を取得します。
az load test show --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg
必須のパラメーター
ロード テスト リソースの名前または ARM リソース ID。
ロード テストのテスト ID。
省略可能のパラメーター
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
az load test update
コマンド グループ 'ロード テスト' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus
既存のロード テストを更新します。
az load test update --load-test-resource
--test-id
[--autostop]
[--autostop-error-rate]
[--autostop-time-window]
[--certificate]
[--description]
[--disable-public-ip]
[--display-name]
[--engine-instances]
[--env]
[--keyvault-reference-id]
[--load-test-config-file]
[--no-wait]
[--regionwise-engines]
[--resource-group]
[--secret]
[--split-csv]
[--subnet-id]
[--test-plan]
例
ロード テスト構成ファイルを使用してテストを更新し、ファイルのアップロードを待機しないでください。
az load test update --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id --load-test-config-file ~/resources/sample-config.yaml --no-wait
テストの表示名と説明を更新します。
az load test update --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id --description "Test description" --display-name "Sample Name"
ロード テスト構成ファイルを使用してテストを更新し、引数を使用してパラメーターをオーバーライドします。
az load test update --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id --load-test-config-file ~/resources/sample-config.yaml --engine-instances 1 --env name=value name=value
テストからシークレットを削除します。
az load test update --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id --secret secret_name1=""
Key Vault 参照 ID をシステム割り当てマネージド ID に更新します。
az load test update --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id --keyvault-reference-id null
自動ストップ条件を更新します。
az load test update --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id --autostop-error-rate 90 --autostop-time-window 180
複数リージョンの読み込み構成を更新します。
az load test update --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-existing-test-id --engine-instances 5 --regionwise-engines eastus=2 westus2=1 eastasia=2
必須のパラメーター
ロード テスト リソースの名前または ARM リソース ID。
ロード テストのテスト ID。
省略可能のパラメーター
自動停止を有効にするか無効にするか。 使用可能な値は有効/無効です。
テストの実行を自動的に停止する必要があるエラーのしきい値の割合。 使用できる値の範囲は [0.0,100.0] です。
エラー率を秒単位で評価する期間。
'key[=value]' 形式の 1 つの証明書。 証明書は PFX 形式で Azure Key Vault に格納し、証明書識別子を値として指定する必要があります。既存の証明書をクリアするには、"" を使用します。
ロード テストの説明。
プライベート エンドポイントのテスト中に、パブリック IP アドレス、ロード バランサー、およびネットワーク セキュリティ グループのデプロイを無効にします。
ロード テストの表示名。
テストを実行するエンジン インスタンスの数。
スペース区切りの環境変数: key[=value] [key[=value] ...]既存の環境変数をクリアするには、"" を使用します。
キー コンテナーへのアクセスに使用される ID。 ロード テスト リソースのシステム割り当て ID を使用するための null
または None
を指定します。
ロード テスト構成ファイルへのパス。 https://learn.microsoft.com/azure/load-testing/reference-test-config-yamlを参照してください。
実行時間の長い操作が完了するまで待つ必要はありません。
各リージョンのエンジン数を、region1=engineCount1 region2=engineCount2 ...の形式で指定します。リージョン名は、Azure Resource Manager (ARM) で受け入れられる形式で使用します。 リージョンが Azure Load Testing でサポートされていることを確認します。 複数リージョンのロード テストでは、パブリック エンドポイントのみを対象にすることができます。
リソース グループの名前。
az configure --defaults group=<name>
を使用して既定のグループを構成できます。
スペース区切りのシークレット: key[=value] [key[=value] ...]シークレットは Azure Key Vault に格納し、シークレット識別子を値として指定する必要があります。既存のシークレットをクリアするには、"" を使用します。
エンジン インスタンス間で CSV ファイルを均等に分割します。
プライベート ロード テストに使用するサブネットのリソース ID。
テスト 計画ファイルへの参照。
testType: JMX
場合: JMeter スクリプトへのパス。
testType: URL
場合: 要求 JSON ファイルへのパス。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_ID
を使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
Azure CLI