AzureLoadTest@1 - Azure Load Testing v1 task

Article
07/02/2024

Automate performance regression testing with Azure Load Testing.

Syntax

# Azure Load Testing v1
# Automate performance regression testing with Azure Load Testing.
- task: AzureLoadTest@1
  inputs:
    azureSubscription: # string. Alias: connectedServiceNameARM. Required. Azure subscription. 
    loadTestConfigFile: # string. Required. Load Test File. 
    resourceGroup: # string. Required. Load Test Resource Group. 
    loadTestResource: # string. Required. Load Test Resource Name. 
    #loadTestRunName: # string. Load Test Run Name. 
    #loadTestRunDescription: # string. Load Test Run Description. 
    #secrets: # string. Secrets. 
    #env: # string. env.

Inputs

azureSubscription - Azure subscription
Input alias: connectedServiceNameARM. string. Required.

Selects an Azure Resource Manager subscription to run the load test.

loadTestConfigFile - Load Test File
string. Required.

The path to the load test YAML configuration file relative from the repo root. See Test configuration YAML reference. The path must be fully qualified or relative to the default working directory.

resourceGroup - Load Test Resource Group
string. Required.

Enters or selects the Azure Resource Group that contains the Load test resource.

loadTestResource - Load Test Resource Name
string. Required.

Enters or selects the name of an existing Azure Load Testing resource.

loadTestRunName - Load Test Run Name
string.

Custom name for the load test run.

loadTestRunDescription - Load Test Run Description
string.

Custom description for the load test run.

secrets - Secrets
string.

An array of JSON objects that consist of the name and value for each secret. The name should match the secret name used in the Apache JMeter test script. Add or update the secret parameters using the json syntax as shown in the following example.

[
   {
    "name": "key1",
    "value": $(secret1)
   },
   {
    "name": "key2",
    "value": $(secret2)
   }
]

env - env
string.

An array of JSON objects that consist of the name and value for each environment variable. The name should match the variable name used in the Apache JMeter test script. Add or update the environment variables using the JSON syntax as shown in the following example.

[
   {
    "name": "env1",
    "value": "value1"
   },
   {
    "name": "env2",
    "value": "value2"
   }
]

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Remarks

Use this task to run an Apache JMeter script by using Azure Load Testing. Azure Load Testing is a fully managed load testing service that enables you to generate high-scale load.

The task succeeds if the load test finishes successfully and all test criteria pass.

Although Azure PowerShell isn't listed in the demands for AzureLoadTest@1, the agent must have Azure PowerShell installed. Azure PowerShell is installed on Windows and Linux hosted agent images.

Note

AzureLoadTest@1 is part of the Azure Load Testing marketplace extension. For more information on installing and using this task, see Identify performance regressions with Azure Load Testing and Azure Pipelines.

Examples

For an example using this task, see the Azure Load Testing documentation article Continuous regression testing with Azure Pipelines.

Requirements

Requirement	Description
Pipeline types	YAML, Classic build, Classic release
Runs on	Agent
Demands	None
Capabilities	This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions	Any
Settable variables	Any
Agent version	All supported agent versions.
Task category	Azure Pipelines

Share via