az load

Note

このリファレンスは、Azure CLI (バージョン 2.41.0 以降) の読み込み拡張機能の一部です。 拡張機能は、az load コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

Azure Load Testing リソースを管理します。

コマンド

名前	説明	型	Status
az load create	Azure Load Testing リソースを作成します。	拡張	GA
az load delete	Azure Load Testing リソースを削除します。	拡張	GA
az load list	Azure Load Testing リソースを一覧表示します。	拡張	GA
az load show	1 つ以上の Azure Load Testing リソースの詳細を表示します。	拡張	GA
az load test	ロード テストを管理するコマンド グループ。	拡張	プレビュー
az load test-run	ロード テストの実行を管理するコマンド グループ。	拡張	プレビュー
az load test-run app-component	ロード テストの実行アプリ コンポーネントを管理するコマンド グループ。	拡張	プレビュー
az load test-run app-component add	アプリ コンポーネントをテスト実行に追加します。	拡張	プレビュー
az load test-run app-component list	テスト実行のすべてのアプリ コンポーネントを一覧表示します。	拡張	プレビュー
az load test-run app-component remove	テスト実行からアプリ コンポーネントを削除します。	拡張	プレビュー
az load test-run create	新しいロード テストの実行を作成します。	拡張	プレビュー
az load test-run delete	既存のロード テストの実行を削除します。	拡張	プレビュー
az load test-run download-files	既存のロード テスト実行用のファイルをダウンロードします。	拡張	プレビュー
az load test-run list	すべてのテスト実行を一覧表示します。	拡張	プレビュー
az load test-run metrics	ロード テストの実行メトリックを取得するコマンド グループ。	拡張	プレビュー
az load test-run metrics get-definitions	ロード テスト実行のすべてのメトリック定義を取得します。	拡張	プレビュー
az load test-run metrics get-dimensions	ロード テスト実行のすべてのメトリック ディメンション値を取得します。	拡張	プレビュー
az load test-run metrics get-namespaces	ロード テスト実行のすべてのメトリック名前空間を取得します。	拡張	プレビュー
az load test-run metrics list	ロード テストの実行のメトリックを一覧表示します。	拡張	プレビュー
az load test-run server-metric	ロード テストの実行サーバー メトリックを管理するコマンド グループ。	拡張	プレビュー
az load test-run server-metric add	テスト実行にサーバー メトリックを追加します。	拡張	プレビュー
az load test-run server-metric list	テスト実行のすべてのサーバー メトリックを一覧表示します。	拡張	プレビュー
az load test-run server-metric remove	テスト実行からサーバー メトリックを削除します。	拡張	プレビュー
az load test-run show	テスト実行の詳細を表示します。	拡張	プレビュー
az load test-run stop	ロード テストの実行を停止します。	拡張	プレビュー
az load test-run update	既存のロード テストの実行を更新します。	拡張	プレビュー
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 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 show	テストの詳細を表示します。	拡張	プレビュー
az load test update	既存のロード テストを更新します。	拡張	プレビュー
az load update	Azure Load Testing リソースを更新します。	拡張	GA
az load wait	条件が満たされるまで CLI を待機状態にします。	拡張	GA

az load create

Azure Load Testing リソースを作成します。

ロード テスト リソース名は、リソース グループに対して一意である必要があります。

az load create --name
               --resource-group
               [--encryption-identity]
               [--encryption-key]
               [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
               [--location]
               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
               [--tags]
               [--user-assigned]

例

新しい Azure ロード テスト リソースを作成する

az load create --name sample-resource --resource-group sample-rg --location westus2
az load create -n sample-resource -g sample-rg -l westus2

タグを使用して新しい Azure ロード テスト リソースを作成する

az load create -n sample-resource -g sample-rg -l westus2 --tags type=testing target=infra

マネージド ID を使用して新しい Azure ロード テスト リソースを作成する

az load create -n sample-resource -g sample-rg -l westus2 --identity-type SystemAssigned,UserAssigned --user-assigned "{'/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sample-mi':{}}"

CMK 暗号化を使用して新しい Azure ロード テスト リソースを作成する

az load create -n sample-resource -g sample-rg -l westus2 --identity-type SystemAssigned,UserAssigned --user-assigned "{'/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sample-mi':{}}" --encryption-key https://sample-kv.vault.azure.net/keys/samplekey/2d1ccd5c50234ea2a0858fe148b69cde --encryption-identity /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sample-mi

必須のパラメーター

--name -n

新しい Azure Load Testing リソースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group= を使用して、既定のグループを構成できます。

省略可能のパラメーター

--encryption-identity

Key Vault に対する認証に使用する ID を定義するカスタマー マネージド キー設定のマネージド ID。

--encryption-key

暗号化キーの URL。バージョン管理されています。 たとえば、「 https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 」のように入力します。

--identity-type

マネージド サービス ID の種類。

承認された値: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned

既定値: None

--location -l

場所。 値の由来: az account list-locations。 az configure --defaults location= を使用して、既定の場所を構成できます。 指定しない場合は、リソース グループの場所が使用されます。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--user-assigned

リソースに関連付けられているユーザー割り当て ID の一覧。 ユーザー割り当て ID は ARM リソース ID になります。たとえば、ユーザー割り当て ID の一覧は"{'/subscriptions/ abcdef01-2345-6789-0abc-def012345678 /resourcegroups/sample-rg/providers/microsoft.managedidentity/userassignedidentities/identit のようになります。y1','/subscriptions/ abcdef01-2345-6789-0abc-def012345678 /resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/identity2'}" サポート shorthand-syntax, json-file と yaml-file。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az load delete

Azure Load Testing リソースを削除します。

az load delete [--ids]
               [--name]
               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
               [--resource-group]
               [--subscription]
               [--yes]

例

Azure ロード テスト リソースを削除する

az load delete --name sample-resource --resource-group sample-rg

複数の Azure ロード テスト リソースを削除する

az load delete --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.LoadTestService/loadtests/sample-resource1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg2/providers/Microsoft.LoadTestService/loadtests/sample-resource2

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

Azure Load Testing リソースの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソース グループの名前。 az configure --defaults group= を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az load list

Azure Load Testing リソースを一覧表示します。

az load list [--resource-group]

例

Azure ロード テスト リソースを一覧表示する

az load list --resource-group sample-rg
az load list

省略可能のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group= を使用して、既定のグループを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az load show

1 つ以上の Azure Load Testing リソースの詳細を表示します。

az load show [--ids]
             [--name]
             [--resource-group]
             [--subscription]

例

Azure ロード テスト リソースを表示する

az load show --name sample-resource --resource-group sample-rg

Azure ロード テスト リソースを表示する

az load show --ids /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.LoadTestService/loadtests/sample-resource1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg2/providers/Microsoft.LoadTestService/loadtests/sample-resource2

省略可能のパラメーター

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

Azure Load Testing リソースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group= を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az load update

Azure Load Testing リソースを更新します。

az load update [--encryption-identity]
               [--encryption-key]
               [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
               [--ids]
               [--name]
               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
               [--resource-group]
               [--subscription]
               [--tags]
               [--user-assigned]

例

Azure ロード テスト リソースを更新する

az load update --name sample-resource --resource-group sample-rg --identity-type SystemAssigned
az load update --name sample-resource --resource-group sample-rg --tags type=server
az load update --name sample-resource --resource-group sample-rg --encryption-key https://sample-kv.vault.azure.net/keys/samplekey2/2d1ccd5c50234ea2a0858fe148b69cde
az load update --name sample-resource --resource-group sample-rg --identity-type SystemAssigned,UserAssigned --user-assigned "{'/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sample-mi':{}}" --encryption-key https://sample-kv.vault.azure.net/keys/samplekey2/2d1ccd5c50234ea2a0858fe148b69cde --encryption-identity SystemAssigned

省略可能のパラメーター

--encryption-identity

Key Vault に対する認証に使用する ID を定義するカスタマー マネージド キー設定のマネージド ID。

--encryption-key

暗号化キーの URL。バージョン管理されています。 たとえば、「 https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 」のように入力します。

--identity-type

マネージド サービス ID の種類。

承認された値: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--name -n

Azure Load Testing リソースの名前。

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソース グループの名前。 az configure --defaults group= を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--tags

スペース区切りのタグ: key[=value] [key[=value] ...]既存のタグをクリアするには、"" を使用します。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

--user-assigned

リソースに関連付けられているユーザー割り当て ID の一覧。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az load wait

条件が満たされるまで CLI を待機状態にします。

az load wait [--created]
             [--custom]
             [--deleted]
             [--exists]
             [--ids]
             [--interval]
             [--name]
             [--resource-group]
             [--subscription]
             [--timeout]
             [--updated]

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False

--exists

リソースが存在するまで待ちます。

既定値: False

--ids

1 つまたは複数のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

--interval

ポーリング間隔 (秒単位)。

既定値: 30

--name -n

Azure Load Testing リソースの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group= を使用して、既定のグループを構成できます。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--timeout

最大待機時間 (秒単位)。

既定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False

グローバル パラメーター

--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。