Skip to content

Latest commit

 

History

History
233 lines (186 loc) · 7.52 KB

azure-load-test-v1.md

File metadata and controls

233 lines (186 loc) · 7.52 KB
Raw
title description ms.date monikerRange
AzureLoadTest@1 - Azure Load Testing v1 task
Automate performance regression testing with Azure Load Testing.
07/02/2024
=azure-pipelines

AzureLoadTest@1 - Azure Load Testing v1 task

:::moniker range="=azure-pipelines"

Automate performance regression testing with Azure Load Testing.

:::moniker-end

Syntax

:::moniker range="=azure-pipelines"

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

:::moniker-end

Inputs

:::moniker range="=azure-pipelines"

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

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


:::moniker-end

:::moniker range="=azure-pipelines"

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.


:::moniker-end

:::moniker range="=azure-pipelines"

resourceGroup - Load Test Resource Group
string. Required.

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


:::moniker-end

:::moniker range="=azure-pipelines"

loadTestResource - Load Test Resource Name
string. Required.

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


:::moniker-end

:::moniker range="=azure-pipelines"

loadTestRunName - Load Test Run Name
string.

Custom name for the load test run.


:::moniker-end

:::moniker range="=azure-pipelines"

loadTestRunDescription - Load Test Run Description
string.

Custom description for the load test run.


:::moniker-end

:::moniker range="=azure-pipelines"

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)
   }
]

:::moniker-end

:::moniker range="=azure-pipelines"

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"
   }
]

:::moniker-end

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

:::moniker range="=azure-pipelines"

None.

:::moniker-end

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

:::moniker range="=azure-pipelines"

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

:::moniker-end

See also

For more information about using this task, see the Azure Load Testing documentation article Continuous regression testing with Azure Pipelines.