Share via

az load test app-component

  • 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 app-component 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 to manage app components.

Command group to manage load test app-components with add, list and remove.

Commands

Name Description Type Status
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 app-component add

Preview

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

Add an app component to a test.

az load test app-component add --app-component-id
                               --app-component-name
                               --app-component-type
                               --load-test-resource
                               --test-id
                               [--app-component-kind]
                               [--resource-group]

Examples

Add an app component to a test.

az load test app-component add --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --app-component-name appcomponentresource --app-component-type microsoft.insights/components --app-component-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/microsoft.insights/components/appcomponentresource" --app-component-kind web

Required Parameters

--app-component-id

Fully qualified resource ID of the App Component. For example, subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.

--app-component-name

Name of the app component. Refer https://learn.microsoft.com/cli/azure/resource#az-resource-show.

--app-component-type

Type of resource of the app component. Refer https://learn.microsoft.com/cli/azure/resource#az-resource-show.

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

--app-component-kind

Kind of the app component. Refer https://learn.microsoft.com/cli/azure/resource#az-resource-show.

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

Preview

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

List all app components for a test.

az load test app-component list --load-test-resource
                                --test-id
                                [--resource-group]

Examples

List all app components for a test.

az load test app-component 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 app-component remove

Preview

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

Remove the given app component from a test.

az load test app-component remove --app-component-id
                                  --load-test-resource
                                  --test-id
                                  [--resource-group]
                                  [--yes]

Examples

Remove an app component from a test.

az load test app-component remove --test-id sample-test-id --load-test-resource sample-alt-resource --resource-group sample-rg --app-component-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-rg/providers/Microsoft.Compute/virtualMachineScaleSets/app-comp-name --yes

Required Parameters

--app-component-id

Fully qualified resource ID of the App Component. For example, subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.

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