v9

latestSwagger 2.02026-07-1340120211.1 KB

Test

Create a new test or update an existing test by providing the test Id.

patch/tests/{testId}

Path parameters

testIdstring required

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

Query parameters

api-versionstring required

The API version to use for this operation.

Response

The request has succeeded.

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.

baselineTestRunIdstring

Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs

testIdstring required

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

descriptionstring

The test description.

displayNamestring

Display name of a test.

subnetIdstring

Subnet ID on which the load test instances should run.

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

Test kind

publicIPDisabledboolean

Inject load test engines without deploying public IP for outbound access

keyvaultReferenceIdentityTypestring

Type of the managed identity referencing the Key vault.

keyvaultReferenceIdentityIdstring

Resource Id of the managed identity referencing the Key vault.

metricsReferenceIdentityType'SystemAssigned' | 'UserAssigned'

Type of the managed identity referencing the metrics.

metricsReferenceIdentityIdstring

Resource Id of the managed identity referencing the metrics.

engineBuiltInIdentityType'SystemAssigned' | 'UserAssigned'

Managed identity type.

engineBuiltInIdentityIdsstring[]

Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned.

estimatedVirtualUserHoursnumber double

Estimated virtual user hours for the test.

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.