共用方式為

az load test

  • 預覽
  • 參考

注意

此參考是 Azure CLI 的 載入 延伸模組的一部分（2.41.0 版或更高版本）。 當您第一次執行 az load test 命令 時，擴充功能會自動安裝。 深入瞭解擴充功能。

此命令群組處於預覽狀態，且正在開發中。 參考和支持層級：https://aka.ms/CLI_refstatus

管理負載測試的命令群組。

使用建立、更新、刪除、清單等來管理負載測試的命令群組。

命令

名稱 Description 類型 狀態
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

必要參數

--load-test-resource --name -n

負載測試資源的名稱或 ARM 資源識別碼。

--test-id -t

負載測試的測試標識碼。

選擇性參數

--aggregation

指定回應時間的匯總方法。

接受的值: MAX, MEAN, MEDIAN, MIN, P75, P90, P95, P96, P98, P99, P999, P9999
預設值: MEAN
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數
--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 針對完整偵錯記錄使用 --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

必要參數

--load-test-resource --name -n

負載測試資源的名稱或 ARM 資源識別碼。

--test-id -t

負載測試的測試標識碼。

選擇性參數

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--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

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 針對完整偵錯記錄使用 --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

使用負載測試組態檔建立測試，並使用自變數覆寫引擎實例和 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

使用使用者指派的受控識別來存取 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 負載測試支援指定的區域。 多區域負載測試僅限於公用端點。

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

必要參數

--load-test-resource --name -n

負載測試資源的名稱或 ARM 資源識別碼。

--test-id -t

負載測試的測試標識碼。

選擇性參數

--autostop

是否應該啟用或停用自動停止。 允許的值是啟用/停用。

--autostop-error-rate

測試回合應自動停止之錯誤的臨界值百分比。 允許的值為 [0.0,100.0]。

--autostop-time-window

錯誤百分比應以秒為單位評估的時間範圍。

--certificate

'key[=value]' 格式的單一憑證。 憑證應該以 PFX 格式儲存在 Azure Key Vault 中，而且應該提供憑證標識碼做為值。

--description

負載測試的描述。

--disable-public-ip

測試私人端點時，停用公用IP位址、負載平衡器和網路安全組的部署。

--display-name

負載測試的顯示名稱。

--engine-instances

測試應執行所在的引擎實例數目。

--env

以空格分隔的環境變數：key[=value] [key[=value] ...]。

--keyvault-reference-id

將用來存取金鑰保存庫的身分識別。

--load-test-config-file

負載測試組態檔的路徑。 請參閱 https://learn.microsoft.com/azure/load-testing/reference-test-config-yaml。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False
--regionwise-engines

以下列格式指定每個區域的引擎計數：region1=engineCount1 region2=engineCount2 。...使用 Azure Resource Manager 所接受格式的區域名稱（ARM）。 請確定 Azure 負載測試支持區域。 多區域負載測試只能以公用端點為目標。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--secret

以空格分隔的秘密：key[=value] [key[=value] ...]。秘密應該儲存在 Azure Key Vault 中，而秘密標識碼應提供做為值。

--split-csv

將 CSV 檔案平均分割在引擎實例之間。

--subnet-id

要用於私人負載測試之子網的資源標識碼。

--test-plan

測試計劃檔案的參考。 如果 testType: JMX：JMeter 腳本的路徑。 如果 testType: URL：要求 JSON 檔案的路徑。

--test-type

負載測試的類型。

接受的值: JMX, URL
全域參數
--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 針對完整偵錯記錄使用 --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

必要參數

--load-test-resource --name -n

負載測試資源的名稱或 ARM 資源識別碼。

--test-id -t

負載測試的測試標識碼。

選擇性參數

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--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

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 針對完整偵錯記錄使用 --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

必要參數

--load-test-resource --name -n

負載測試資源的名稱或 ARM 資源識別碼。

--path

要下載檔之目錄的路徑。

--test-id -t

負載測試的測試標識碼。

選擇性參數

--force

強制執行命令。 如果目錄不存在，則會建立要下載檔案的目錄。

預設值: False
--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數
--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 針對完整偵錯記錄使用 --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

必要參數

--load-test-resource --name -n

負載測試資源的名稱或 ARM 資源識別碼。

選擇性參數

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數
--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 針對完整偵錯記錄使用 --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

必要參數

--load-test-resource --name -n

負載測試資源的名稱或 ARM 資源識別碼。

--test-id -t

負載測試的測試標識碼。

--test-run-id -r

負載測試回合的測試回合標識碼。

選擇性參數

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數
--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 針對完整偵錯記錄使用 --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

必要參數

--load-test-resource --name -n

負載測試資源的名稱或 ARM 資源識別碼。

--test-id -t

負載測試的測試標識碼。

選擇性參數

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

全域參數
--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 針對完整偵錯記錄使用 --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 參考身分識別更新為系統指派的受控識別。

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

必要參數

--load-test-resource --name -n

負載測試資源的名稱或 ARM 資源識別碼。

--test-id -t

負載測試的測試標識碼。

選擇性參數

--autostop

是否應該啟用或停用自動停止。 允許的值是啟用/停用。

--autostop-error-rate

測試回合應自動停止之錯誤的臨界值百分比。 允許的值為 [0.0,100.0]。

--autostop-time-window

錯誤百分比應以秒為單位評估的時間範圍。

--certificate

'key[=value]' 格式的單一憑證。 憑證應該以 PFX 格式儲存在 Azure Key Vault 中，而且應該提供憑證標識碼做為值。使用 「清除現有的憑證」。

--description

負載測試的描述。

--disable-public-ip

測試私人端點時，停用公用IP位址、負載平衡器和網路安全組的部署。

--display-name

負載測試的顯示名稱。

--engine-instances

測試應執行所在的引擎實例數目。

--env

以空格分隔的環境變數：key[=value] [key[=value] ...]。使用 「清除現有的環境變數」。

--keyvault-reference-id

將用來存取金鑰保存庫的身分識別。 提供 null 或 None，以使用負載測試資源的系統指派身分識別。

--load-test-config-file

負載測試組態檔的路徑。 請參閱 https://learn.microsoft.com/azure/load-testing/reference-test-config-yaml。

--no-wait

請勿等候長時間執行的作業完成。

預設值: False
--regionwise-engines

以下列格式指定每個區域的引擎計數：region1=engineCount1 region2=engineCount2 。...使用 Azure Resource Manager 所接受格式的區域名稱（ARM）。 請確定 Azure 負載測試支持區域。 多區域負載測試只能以公用端點為目標。

--resource-group -g

資源組名。 您可以使用 az configure --defaults group=<name>來設定預設群組。

--secret

以空格分隔的秘密：key[=value] [key[=value] ...]。秘密應該儲存在 Azure Key Vault 中，而秘密標識碼應提供做為值。使用 「清除現有的秘密」。

--split-csv

將 CSV 檔案平均分割在引擎實例之間。

--subnet-id

要用於私人負載測試之子網的資源標識碼。

--test-plan

測試計劃檔案的參考。 如果 testType: JMX：JMeter 腳本的路徑。 如果 testType: URL：要求 JSON 檔案的路徑。

全域參數
--debug

增加記錄詳細信息以顯示所有偵錯記錄。

--help -h

顯示此說明訊息並結束。

--only-show-errors

只顯示錯誤，隱藏警告。

--output -o

輸出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
預設值: json
--query

JMESPath 查詢字串。 如需詳細資訊和範例，請參閱 http://jmespath.org/。

--subscription

訂用帳戶的名稱或標識碼。 您可以使用 az account set -s NAME_OR_ID來設定預設訂用帳戶。

--verbose

增加記錄詳細資訊。 針對完整偵錯記錄使用 --debug。