az load test-run

Note

This reference is part of the load extension for the Azure CLI (version 2.41.0 or higher). The extension will automatically install the first time you run an az load test-run command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Command group to manage load test runs.

Command group to manage load test runs with create, update, delete, list, stop, etc.

Commands

Name	Description	Type	Status
az load test-run app-component	Command group to manage load test run app components.	Extension	Preview
az load test-run app-component add	Add an app component to a test run.	Extension	Preview
az load test-run app-component list	List all app components for a test run.	Extension	Preview
az load test-run app-component remove	Remove an app component from a test run.	Extension	Preview
az load test-run create	Create a new load test run.	Extension	Preview
az load test-run delete	Delete an existing load test run.	Extension	Preview
az load test-run download-files	Download files for an existing load test run.	Extension	Preview
az load test-run list	List all test runs.	Extension	Preview
az load test-run metrics	Command group to retrieve load test run metrics.	Extension	Preview
az load test-run metrics get-definitions	Get all metric definitions for a load test run.	Extension	Preview
az load test-run metrics get-dimensions	Get all metric dimension values for load test run.	Extension	Preview
az load test-run metrics get-namespaces	Get all metric namespaces for a load test run.	Extension	Preview
az load test-run metrics list	List metrics for a load test run.	Extension	Preview
az load test-run server-metric	Command group to manage load test run server-metrics.	Extension	Preview
az load test-run server-metric add	Add a server-metric to a test run.	Extension	Preview
az load test-run server-metric list	List all server-metrics for a test run.	Extension	Preview
az load test-run server-metric remove	Remove a server-metric from a test run.	Extension	Preview
az load test-run show	Show details of a test run.	Extension	Preview
az load test-run stop	Stop running a load test run.	Extension	Preview
az load test-run update	Update an existing load test run.	Extension	Preview

az load test-run create

Preview

Command group 'load test-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a new load test run.

Create a new load test run for a given test. If an existing test run is specified, then the test run will be rerun. By default this command will wait for the test run to complete. Use --no-wait to skip this wait.

az load test-run create --load-test-resource
                        --test-id
                        --test-run-id
                        [--certificate]
                        [--description]
                        [--display-name]
                        [--env]
                        [--existing-test-run-id]
                        [--no-wait]
                        [--resource-group]
                        [--secret]

Examples

Create a test run for a test without waiting for test run completion.

az load test-run create --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-test-id --test-run-id sample-test-run-id --no-wait

Rerun an existing test run.

az load test-run create --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-test-id --test-run-id sample-test-run-id --description "Test run description" --existing-test-run-id existing_test_run_id

Required Parameters

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

Name or ARM resource ID of the Load Testing resource.

--test-id -t

Test ID of the load test.

--test-run-id -r

Test run ID of the load test run.

Optional Parameters

--certificate

A single certificate in 'key[=value]' format. The certificate should be stored in Azure Key Vault in PFX format, and the certificate identifier should be provided as the value.Use "" to clear existing certificate.

--description

Description of the load test run.

--display-name

Display name of the load test run.

--env

Space-separated environment variables: key[=value] [key[=value] ...]. Use "" to clear existing environment variables.

--existing-test-run-id

Test run ID of an existing load test run which should be rerun.

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--secret

Space-separated secrets: key[=value] [key[=value] ...]. Secrets should be stored in Azure Key Vault, and the secret identifier should be provided as the value.Use "" to clear existing secrets.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az load test-run delete

Preview

Command group 'load test-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an existing load test run.

az load test-run delete --load-test-resource
                        --test-run-id
                        [--resource-group]
                        [--yes]

Examples

Delete a test run.

az load test-run delete --load-test-resource sample-alt-resource --resource-group sample-rg --test-run-id sample-test-run-id --yes

Required Parameters

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

Name or ARM resource ID of the Load Testing resource.

--test-run-id -r

Test run ID of the load test run.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az load test-run download-files

Preview

Command group 'load test-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Download files for an existing load test run.

az load test-run download-files --load-test-resource
                                --path
                                --test-run-id
                                [--force]
                                [--input]
                                [--log]
                                [--resource-group]
                                [--result]

Examples

Download input, log and result files for a test run. The directory should already exist.

az load test-run download-files --load-test-resource sample-alt-resource --resource-group sample-rg --test-run-id sample-test-run-id --path ~/Downloads/OutputArtifacts --input --log --result

Download input and log files for a test run by creating the directory if it does not exist.

az load test-run download-files --load-test-resource sample-alt-resource --resource-group sample-rg --test-run-id sample-test-run-id --path ~/Downloads/OutputArtifacts --input --log --force

Required Parameters

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

Name or ARM resource ID of the Load Testing resource.

--path

Path of the directory to download files.

--test-run-id -r

Test run ID of the load test run.

Optional Parameters

--force

Force run the command. This will create the directory to download files if it does not exist.

default value: False

--input

Download the input files zip.

default value: False

--log

Download the log files zip.

default value: False

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--result

Download the results files zip.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az load test-run list

Preview

Command group 'load test-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all test runs.

az load test-run list --load-test-resource
                      --test-id
                      [--resource-group]

Examples

List all tests runs in a test.

az load test-run list --load-test-resource sample-alt-resource --resource-group sample-rg --test-id sample-test-id

Required Parameters

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

Name or ARM resource ID of the Load Testing resource.

--test-id -t

Test ID of the load test.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az load test-run show

Preview

Command group 'load test-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Show details of a test run.

Show details of the test run identified by given test-run-id.

az load test-run show --load-test-resource
                      --test-run-id
                      [--resource-group]

Examples

Get the details of a test run.

az load test-run show --load-test-resource sample-alt-resource --resource-group sample-rg --test-run-id sample-test-run-id

Required Parameters

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

Name or ARM resource ID of the Load Testing resource.

--test-run-id -r

Test run ID of the load test run.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az load test-run stop

Preview

Command group 'load test-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Stop running a load test run.

az load test-run stop --load-test-resource
                      --test-run-id
                      [--resource-group]
                      [--yes]

Examples

Stop a test run.

az load test-run stop --load-test-resource sample-alt-resource --resource-group sample-rg --test-run-id sample-test-run-id --yes

Required Parameters

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

Name or ARM resource ID of the Load Testing resource.

--test-run-id -r

Test run ID of the load test run.

Optional Parameters

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az load test-run update

Preview

Command group 'load test-run' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an existing load test run.

az load test-run update --load-test-resource
                        --test-run-id
                        [--description]
                        [--display-name]
                        [--resource-group]

Examples

Update the description for a test run

az load test-run update --load-test-resource sample-alt-resource --resource-group sample-rg --test-run-id sample-test-run-id --description "Test run description"

Required Parameters

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

Name or ARM resource ID of the Load Testing resource.

--test-run-id -r

Test run ID of the load test run.

Optional Parameters

--description

Description of the load test run.

--display-name

Display name of the load test run.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.