az load

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

Manage Azure Load Testing resources.

Commands

Name Description Type Status
az load create

Create an Azure Load Testing resource.

 Extension GA
az load delete

Delete an Azure Load Testing resource.

 Extension GA
az load list

Lists Azure Load Testing resources.

 Extension GA
az load show

Show the details of one or more Azure Load Testing resources.

 Extension GA
az load test

Command group to manage load tests.

 Extension Preview
az load test-run

Command group to manage load test runs.

 Extension Preview
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 app-component

Command group to manage app components.

 Extension Preview
az load test app-component add

Add an app component to a test.

 Extension Preview
az load test app-component list

List all app components for a test.

 Extension Preview
az load test app-component remove

Remove the given app component from a test.

 Extension Preview
az load test create

Create a new load test.

 Extension Preview
az load test delete

Delete an existing load test.

 Extension Preview
az load test download-files

Download files of an existing load test.

 Extension Preview
az load test file

Command group for operations on test files.

 Extension Preview
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 list

List all tests in the given load test resource.

 Extension Preview
az load test server-metric

Command group to manage server metrics.

 Extension Preview
az load test server-metric add

Add a server-metric to a test.

 Extension Preview
az load test server-metric list

List all server-metrics for a test.

 Extension Preview
az load test server-metric remove

Remove the given server-metric from the test.

 Extension Preview
az load test show

Show details of test.

 Extension Preview
az load test update

Update an existing load test.

 Extension Preview
az load update

Update an Azure Load Testing resource.

 Extension GA
az load wait

Place the CLI in a waiting state until a condition is met.

 Extension GA

az load create

Create an Azure Load Testing resource.

The load test resource name must be unique to a resource group.

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]

Examples

Create a new Azure load testing resource

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

Create a new Azure load testing resource with tags

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

Create a new Azure load testing resource with Managed identity

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':{}}"

Create a new Azure load testing resource with CMK Encryption

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

Required Parameters

--name -n

Name of the new Azure Load Testing resource.

--resource-group -g

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

Optional Parameters

--encryption-identity

The managed identity for Customer-managed key settings defining which identity should be used to authenticate to Key Vault.

--encryption-key

Encryption key URL, versioned. For example, https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78.

--identity-type

Type of managed service identity.

Accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
Default value: None
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=. When not specified, the location of the resource group will be used.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-assigned

The list of user-assigned identities associated with the resource. The user-assigned identity will be ARM resource id. For example, a list of user-assigned identities would look like "{'/subscriptions/ abcdef01-2345-6789-0abc-def012345678 /resourcegroups/sample-rg/providers/microsoft.managedidentity/userassignedidentities/identity1','/subscriptions/ abcdef01-2345-6789-0abc-def012345678 /resourcegroups/test-rg/providers/microsoft.managedidentity/userassignedidentities/identity2'}" Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 delete

Delete an Azure Load Testing resource.

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

Examples

Delete Azure load testing resource

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

Delete multiple Azure load testing resources

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Azure Load Testing resource.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

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

Lists Azure Load Testing resources.

az load list [--resource-group]

Examples

List Azure load testing resources

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

Optional Parameters

--resource-group -g

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

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 show

Show the details of one or more Azure Load Testing resources.

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

Examples

Show an Azure load testing resource

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

Show Azure load testing resources

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

Optional Parameters

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Azure Load Testing resource.

--resource-group -g

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

--subscription

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

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 update

Update an Azure Load Testing resource.

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]

Examples

Update Azure load testing resource

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

Optional Parameters

--encryption-identity

The managed identity for Customer-managed key settings defining which identity should be used to authenticate to Key Vault.

--encryption-key

Encryption key URL, versioned. For example, https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78.

--identity-type

Type of managed service identity.

Accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name -n

Name of the Azure Load Testing resource.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--user-assigned

The list of user-assigned identities associated with the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 wait

Place the CLI in a waiting state until a condition is met.

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

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--interval

Polling interval in seconds.

Default value: 30
--name -n

Name of the Azure Load Testing resource.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.