az load test file

  • Preview
  • Reference

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 file command. Learn more about extensions.

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

Command group for operations on test files.

Command group for operations on test files such as upload, delete, list and download.

Commands

Name Description Type Status
az load test file delete

Delete a file from test.

 Extension Preview
az load test file download

Download a file from a test.

 Extension Preview
az load test file list

List all files in a test.

 Extension Preview
az load test file upload

Upload a file to a test.

 Extension Preview

az load test file delete

Preview

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

Delete a file from test.

Delete a file from test by providing the file name and test id.

az load test file delete --file-name
                         --load-test-resource
                         --test-id
                         [--resource-group]
                         [--yes]

Examples

Delete a file from a test.

az load test file delete --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --file-name sample-jmx.jmx --yes

Required Parameters

--file-name

Name of the file.

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

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

Preview

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

Download a file from a test.

Download a file from, a test by providing the file name, test id and path to download the files.

az load test file download --file-name
                           --load-test-resource
                           --path
                           --test-id
                           [--force]
                           [--resource-group]

Examples

Download a file from a test. The directory should already exist.

az load test file download --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --file-name sample-jmx.jmx --path ~/Downloads/
examples:

Download a file from a test by creating the directory if it does not exist.

az load test file download --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --file-name sample-jmx.jmx --path ~/Downloads/ --force

Required Parameters

--file-name

Name of the file.

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

Name or ARM resource ID of the Load Testing resource.

--path

Path of the directory to download files.

--test-id -t

Test ID of the load test.

Optional Parameters

--force

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

default value: False
--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 file list

Preview

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

List all files in a test.

List details of all the files related to a test by providing the corresponding test id.

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

Examples

List all files in a test.

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

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

Preview

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

Upload a file to a test.

Upload a file to a test by providing path to file and test id.

az load test file upload --load-test-resource
                         --path
                         --test-id
                         [--file-type]
                         [--no-wait]
                         [--resource-group]

Examples

Upload a JMeter script (JMX file) to a test.

az load test file upload --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --path sample-jmx.jmx

Upload a CSV file to a test and without waiting for the long-running operation to finish.

az load test file upload --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --path ~/Resources/split-csv.csv --file-type ADDITIONAL_ARTIFACTS --no-wait

Upload a user property file to a test.

az load test file upload --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --path ~/Resources/user-prop.properties --file-type USER_PROPERTIES

Required Parameters

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

Name or ARM resource ID of the Load Testing resource.

--path

Path to the file to upload.

--test-id -t

Test ID of the load test.

Optional Parameters

--file-type

Type of file to be uploaded. Allowed values: ADDITIONAL_ARTIFACTS, JMX_FILE, USER_PROPERTIES.

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

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.