v9

latestSwagger 2.02026-07-1340120211.1 KB

TestRun

Create and start a new test run with the given test run Id.

patch/test-runs/{testRunId}

Path parameters

testRunIdstring required

Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

Query parameters

api-versionstring required

The API version to use for this operation.

oldTestRunIdstring

Existing test run identifier that should be rerun, if this is provided, the test will run with the JMX file, configuration and app components from the existing test run. You can override the configuration values for new test run in the request body.

Response

The request has succeeded.

testRunIdstring required

Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

secretsobject

Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE.

environmentVariablesobject

Environment variables which are defined as a set of <name,value> pairs.

testRunStatisticsobject

Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run. The sampler name is the same as the name mentioned in the test script. Sampler name "Total" represents the aggregated statistics of all the samplers.

regionalStatisticsobject

Regional statistics. Key is the Azure region name and value is the test run statistics. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command.

testResult'PASSED' | 'NOT_APPLICABLE' | 'FAILED'

Test result based on pass/fail criteria.

virtualUsersinteger

Number of virtual users, for which test has been run.

displayNamestring

Display name of a testRun.

testIdstring

Associated test Id.

descriptionstring

The test run description.

Test run status.

startDateTimestring date-time

The test run start DateTime(RFC 3339 literal format).

endDateTimestring date-time

The test run end DateTime(RFC 3339 literal format).

executedDateTimestring date-time

Test run initiated time. This is legacy, new developments should use createdDateTime.

portalUrlstring

Portal url.

durationinteger

Test run duration in milliseconds.

virtualUserHoursnumber double

Virtual user hours consumed by the test run.

subnetIdstring

Subnet ID on which the load test instances should run.

kind'URL' | 'JMX' | 'Locust'

Test kind

requestDataLevel'NONE' | 'ERRORS'

Request data collection level for test run

debugLogsEnabledboolean

Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise

publicIPDisabledboolean

Inject load test engines without deploying public IP for outbound access

createdByType'User' | 'ScheduledTrigger' | 'AzurePipelines' | 'GitHubWorkflows'

The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc).

createdByUristring uri

The URI pointing to the entity that created the test run.

estimatedVirtualUserHoursnumber double

Estimated virtual user hours for the test run.

executionStartDateTimestring date-time

The test run execution start DateTime(RFC 3339 literal format).

executionEndDateTimestring date-time

The test run execution end DateTime(RFC 3339 literal format).

createdDateTimestring date-time

The creation datetime(RFC 3339 literal format).

createdBystring

The user that created.

lastModifiedDateTimestring date-time

The last Modified datetime(RFC 3339 literal format).

lastModifiedBystring

The user that last modified.