你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az load test

注意

此参考是 Azure CLI（版本 2.41.0 或更高版本）加载 扩展的一部分。 该扩展将在首次运行 az load test 命令时自动安装。 详细了解扩展。

此命令组处于预览状态，正在开发中。 参考和支持级别：https://aka.ms/CLI_refstatus

用于管理负载测试的命令组。

用于使用创建、更新、删除、列表等管理负载测试的命令组。

命令

名称	说明	类型	Status
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 资源 ID。

--test-id -t

负载测试的测试 ID。

可选参数

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

订阅的名称或 ID。 可以使用 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 资源 ID。

--test-id -t

负载测试的测试 ID。

可选参数

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

订阅的名称或 ID。 可以使用 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 资源管理器（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 资源 ID。

--test-id -t

负载测试的测试 ID。

可选参数

--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 资源管理器（ARM）接受的格式的区域名称。 确保 Azure 负载测试支持这些区域。 多区域负载测试只能面向公共终结点。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--secret

空格分隔的机密：key[=value] [key[=value] ...]。机密应存储在 Azure Key Vault 中，机密标识符应作为值提供。

--split-csv

在引擎实例之间均匀拆分 CSV 文件。

--subnet-id

要用于专用负载测试的子网的资源 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

订阅的名称或 ID。 可以使用 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 资源 ID。

--test-id -t

负载测试的测试 ID。

可选参数

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

订阅的名称或 ID。 可以使用 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 资源 ID。

--path

用于下载文件的目录的路径。

--test-id -t

负载测试的测试 ID。

可选参数

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

订阅的名称或 ID。 可以使用 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 资源 ID。

可选参数

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

订阅的名称或 ID。 可以使用 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 资源 ID。

--test-id -t

负载测试的测试 ID。

--test-run-id -r

负载测试运行的测试运行 ID。

可选参数

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

订阅的名称或 ID。 可以使用 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 资源 ID。

--test-id -t

负载测试的测试 ID。

可选参数

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

订阅的名称或 ID。 可以使用 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 资源 ID。

--test-id -t

负载测试的测试 ID。

可选参数

--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 资源管理器（ARM）接受的格式的区域名称。 确保 Azure 负载测试支持这些区域。 多区域负载测试只能面向公共终结点。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--secret

空格分隔的机密：key[=value] [key[=value] ...]。机密应存储在 Azure Key Vault 中，机密标识符应作为值提供。使用“”清除现有机密。

--split-csv

在引擎实例之间均匀拆分 CSV 文件。

--subnet-id

要用于专用负载测试的子网的资源 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

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID配置默认订阅。

--verbose

增加日志记录详细程度。 对完整调试日志使用 --debug。