Load Test Administration - Create Or Update Test

Service:: Azure Load Testing

API Version:: 2022-11-01

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

PATCH https://{endpoint}/tests/{testId}?api-version=2022-11-01

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string
testId	path	True	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Media Types: "application/merge-patch+json"

Name	Type	Description
certificate	CertificateMetadata	Certificates metadata.
description	string maxLength: 100	The test description.
displayName	string minLength: 2 maxLength: 50	Display name of a test.
environmentVariables	object	Environment variables which are defined as a set of <name,value> pairs.
keyvaultReferenceIdentityId	string	Resource Id of the managed identity referencing the Key vault.
keyvaultReferenceIdentityType	string	Type of the managed identity referencing the Key vault.
loadTestConfiguration	LoadTestConfiguration	The load test configuration.
passFailCriteria	PassFailCriteria	Pass fail criteria for a test.
secrets	<string, Secret>	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.
subnetId	string	Subnet ID on which the load test instances should run.

Responses

Name	Type	Description
200 OK	Test	The request has succeeded.
201 Created	Test	The request has succeeded and a new resource has been created as a result.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

Test

The request has succeeded.

201 Created

Test

The request has succeeded and a new resource has been created as a result.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Oauth2

OAuth 2.0 Flow with Microsoft Entra ID.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://cnt-prod.loadtesting.azure.com/.default

Examples

Create or update a load test

Sample request

HTTP

PATCH https://{endpoint}/tests/12345678-1234-1234-1234-123456789012?api-version=2022-11-01

{
  "description": "sample description",
  "displayName": "Performance_LoadTest",
  "loadTestConfiguration": {
    "engineInstances": 6,
    "splitAllCSVs": true
  },
  "passFailCriteria": {
    "passFailMetrics": {
      "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": {
        "clientMetric": "response_time_ms",
        "aggregate": "percentage",
        "condition": ">",
        "value": 20,
        "action": "continue"
      }
    }
  },
  "secrets": {
    "secret1": {
      "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827",
      "type": "AKV_SECRET_URI"
    }
  },
  "environmentVariables": {
    "envvar1": "sampletext"
  },
  "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0",
  "keyvaultReferenceIdentityType": "UserAssigned",
  "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/sampleprovider/sampleresourcetype/sampleresourcename"
}

Sample response

Status code:: 200

{
  "testId": "12345678-1234-1234-1234-123456789012",
  "description": "sample description",
  "displayName": "Performance_LoadTest",
  "loadTestConfiguration": {
    "engineInstances": 6,
    "splitAllCSVs": true
  },
  "passFailCriteria": {
    "passFailMetrics": {
      "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": {
        "clientMetric": "response_time_ms",
        "aggregate": "percentage",
        "condition": ">",
        "value": 20,
        "action": "continue",
        "actualValue": 10,
        "result": "passed"
      }
    }
  },
  "createdDateTime": "2021-12-05T16:43:46.072Z",
  "createdBy": "user@contoso.com",
  "lastModifiedDateTime": "2021-12-05T16:43:46.072Z",
  "lastModifiedBy": "user@contoso.com",
  "inputArtifacts": {
    "configFileInfo": {
      "url": "https://dummyurl.com/configresource",
      "fileName": "config.yaml",
      "fileType": "ADDITIONAL_ARTIFACTS",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": ""
    },
    "testScriptFileInfo": {
      "url": "https://dummyurl.com/testscriptresource",
      "fileName": "sample.jmx",
      "fileType": "JMX_FILE",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": "VALIDATION_SUCCESS"
    },
    "userPropFileInfo": {
      "url": "https://dummyurl.com/userpropresource",
      "fileName": "user.properties",
      "fileType": "USER_PROPERTIES",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": ""
    },
    "inputArtifactsZipFileInfo": {
      "url": "https://dummyurl.com/inputartifactzipresource",
      "fileName": "inputartifacts.zip",
      "fileType": "ADDITIONAL_ARTIFACTS",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": ""
    },
    "additionalFileInfo": []
  },
  "secrets": {
    "secret1": {
      "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827",
      "type": "AKV_SECRET_URI"
    }
  },
  "environmentVariables": {
    "envvar1": "sampletext"
  },
  "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0",
  "keyvaultReferenceIdentityType": "UserAssigned",
  "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"
}

Status code:: 201

{
  "testId": "12345678-1234-1234-1234-123456789012",
  "description": "sample description",
  "displayName": "Performance_LoadTest",
  "loadTestConfiguration": {
    "engineInstances": 6,
    "splitAllCSVs": true
  },
  "passFailCriteria": {
    "passFailMetrics": {
      "fefd759d-7fe8-4f83-8b6d-aeebe0f491fe": {
        "clientMetric": "response_time_ms",
        "aggregate": "percentage",
        "condition": ">",
        "value": 20,
        "action": "continue",
        "actualValue": 10,
        "result": "passed"
      }
    }
  },
  "createdDateTime": "2021-12-05T16:43:46.072Z",
  "createdBy": "user@contoso.com",
  "lastModifiedDateTime": "2021-12-05T16:43:46.072Z",
  "lastModifiedBy": "user@contoso.com",
  "inputArtifacts": {
    "configFileInfo": {
      "url": "https://dummyurl.com/configresource",
      "fileName": "config.yaml",
      "fileType": "ADDITIONAL_ARTIFACTS",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": ""
    },
    "testScriptFileInfo": {
      "url": "https://dummyurl.com/testscriptresource",
      "fileName": "sample.jmx",
      "fileType": "JMX_FILE",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": "VALIDATION_SUCCESS"
    },
    "userPropFileInfo": {
      "url": "https://dummyurl.com/userpropresource",
      "fileName": "user.properties",
      "fileType": "USER_PROPERTIES",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": ""
    },
    "inputArtifactsZipFileInfo": {
      "url": "https://dummyurl.com/inputartifactzipresource",
      "fileName": "inputartifacts.zip",
      "fileType": "ADDITIONAL_ARTIFACTS",
      "expireDateTime": "2021-12-05T16:43:46.072Z",
      "validationStatus": ""
    },
    "additionalFileInfo": []
  },
  "secrets": {
    "secret1": {
      "value": "https://samplevault.vault.azure.net/secrets/samplesecret/f113f91fd4c44a368049849c164db827",
      "type": "AKV_SECRET_URI"
    }
  },
  "environmentVariables": {
    "envvar1": "sampletext"
  },
  "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.Network/virtualNetworks/samplenetworkresource/subnets/AAAAA0A0A0",
  "keyvaultReferenceIdentityType": "UserAssigned",
  "keyvaultReferenceIdentityId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1"
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
CertificateMetadata	Certificates metadata
CertificateType	Types of certificates supported.
FileType	Types of file supported.
FileValidationStatus	File status.
LoadTestConfiguration	Configurations for the load test.
OptionalLoadTestConfiguration	Configuration for quick load test
PassFailAction	Action taken after the threshold is met. Default is ‘continue’.
PassFailAggregationFunction	Aggregation functions for pass/fail criteria.
PassFailCriteria	Pass fail criteria for a test.
PassFailMetric	Pass fail metric
PassFailResult	Pass/fail criteria result.
PFMetrics	Metrics for pass/fail criteria.
Secret	Secret
SecretType	Types of secrets supported.
Test	Load test model.
TestCreateOrUpdate	Load test model.
TestFileInfo	Test file info.
TestInputArtifacts	The input artifacts for the test.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

CertificateMetadata

Object

Certificates metadata

Name	Type	Description
name	string	Name of the certificate.
type	CertificateType	Type of certificate
value	string	The value of the certificate for respective type

CertificateType

Enumeration

Types of certificates supported.

Value	Description
AKV_CERT_URI	If the certificate is stored in an Azure Key Vault.

FileType

Enumeration

Types of file supported.

Value	Description
JMX_FILE	If the file is a JMX script.
USER_PROPERTIES	If the file is a user properties file.
ADDITIONAL_ARTIFACTS	If the file is not among any of the other supported file types.

FileValidationStatus

Enumeration

File status.

Value	Description
NOT_VALIDATED	File is not validated.
VALIDATION_SUCCESS	File is validated.
VALIDATION_FAILURE	File validation is failed.
VALIDATION_INITIATED	File validation is in progress.
VALIDATION_NOT_REQUIRED	Validation is not required.

LoadTestConfiguration

Object

Configurations for the load test.

Name	Type	Default value	Description
engineInstances	integer (int32)		The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test.
optionalLoadTestConfig	OptionalLoadTestConfiguration		Configuration for quick load test
quickStartTest	boolean	False	If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload.
splitAllCSVs	boolean	False	If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly.

OptionalLoadTestConfiguration

Object

Configuration for quick load test

Name	Type	Description
duration	integer (int32)	Test run duration in seconds.
endpointUrl	string	Test URL. Provide the complete HTTP URL. For example, `https://contoso-app.azurewebsites.net/login`
rampUpTime	integer (int32)	Ramp up time in seconds.
virtualUsers	integer (int32)	No of concurrent virtual users.

PassFailAction

Enumeration

Action taken after the threshold is met. Default is ‘continue’.

Value	Description
continue	Test will continue to run even if pass fail metric criteria metric gets failed.
stop	Test run will stop if pass fail criteria metric is not passed.

PassFailAggregationFunction

Enumeration

Aggregation functions for pass/fail criteria.

Value	Description
count	Criteria applies for count value.
percentage	Criteria applies for given percentage value.
avg	Criteria applies for avg value.
p50	Criteria applies for 50th percentile value.
p90	Criteria applies for 90th percentile value.
p95	Criteria applies for 95th percentile value.
p99	Criteria applies for 99th percentile value.
min	Criteria applies for minimum value.
max	Criteria applies for maximum value.

PassFailCriteria

Object

Pass fail criteria for a test.

Name	Type	Description
passFailMetrics	<string, PassFailMetric>	Map of id and pass fail metrics { id : pass fail metrics }.

PassFailMetric

Object

Pass fail metric

Name	Type	Default value	Description
action	PassFailAction	continue	Action taken after the threshold is met. Default is ‘continue’.
actualValue	number (double)		The actual value of the client metric for the test run.
aggregate	PassFailAggregationFunction		The aggregation function to be applied on the client metric. Allowed functions ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’, ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, ‘count’ - for requests
clientMetric	PFMetrics		The client metric on which the criteria should be applied.
condition	string		The comparison operator. Supported types ‘>’, ‘<’
requestName	string		Request name for which the Pass fail criteria has to be applied
result	PassFailResult		Outcome of the test run.
value	number (double)		The value to compare with the client metric. Allowed values - ‘error : [0.0 , 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.

PassFailResult

Enumeration

Pass/fail criteria result.

Value	Description
passed	Given pass fail criteria metric has passed.
undetermined	Given pass fail criteria metric couldn't determine.
failed	Given pass fail criteria metric has failed.

PFMetrics

Enumeration

Metrics for pass/fail criteria.

Value	Description
response_time_ms	Pass fail criteria for response time metric in milliseconds.
latency	Pass fail criteria for latency metric in milliseconds.
error	Pass fail criteria for error metric.
requests	Pass fail criteria for total requests.
requests_per_sec	Pass fail criteria for request per second.

Secret

Object

Secret

Name	Type	Description
type	SecretType	Type of secret
value	string	The value of the secret for the respective type

SecretType

Enumeration

Types of secrets supported.

Value	Description
AKV_SECRET_URI	If the secret is stored in an Azure Key Vault.
SECRET_VALUE	If the secret value provided as plain text.

Test

Object

Load test model.

Name	Type	Description
certificate	CertificateMetadata	Certificates metadata.
createdBy	string	The user that created.
createdDateTime	string (date-time)	The creation datetime(RFC 3339 literal format).
description	string maxLength: 100	The test description.
displayName	string minLength: 2 maxLength: 50	Display name of a test.
environmentVariables	object	Environment variables which are defined as a set of <name,value> pairs.
inputArtifacts	TestInputArtifacts	The input artifacts for the test.
keyvaultReferenceIdentityId	string	Resource Id of the managed identity referencing the Key vault.
keyvaultReferenceIdentityType	string	Type of the managed identity referencing the Key vault.
lastModifiedBy	string	The user that last modified.
lastModifiedDateTime	string (date-time)	The last Modified datetime(RFC 3339 literal format).
loadTestConfiguration	LoadTestConfiguration	The load test configuration.
passFailCriteria	PassFailCriteria	Pass fail criteria for a test.
secrets	<string, Secret>	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.
subnetId	string	Subnet ID on which the load test instances should run.
testId	string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$	Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.

TestCreateOrUpdate

Object

Load test model.

Name	Type	Description
certificate	CertificateMetadata	Certificates metadata.
description	string maxLength: 100	The test description.
displayName	string minLength: 2 maxLength: 50	Display name of a test.
environmentVariables	object	Environment variables which are defined as a set of <name,value> pairs.
keyvaultReferenceIdentityId	string	Resource Id of the managed identity referencing the Key vault.
keyvaultReferenceIdentityType	string	Type of the managed identity referencing the Key vault.
loadTestConfiguration	LoadTestConfiguration	The load test configuration.
passFailCriteria	PassFailCriteria	Pass fail criteria for a test.
secrets	<string, Secret>	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.
subnetId	string	Subnet ID on which the load test instances should run.

TestFileInfo

Object

Test file info.

Name	Type	Description
expireDateTime	string (date-time)	Expiry time of the file (RFC 3339 literal format)
fileName	string	Name of the file.
fileType	FileType	File type
url	string (uri)	File URL.
validationFailureDetails	string	Validation failure error details
validationStatus	FileValidationStatus	Validation status of the file

TestInputArtifacts

Object

The input artifacts for the test.

Name	Type	Description
additionalFileInfo	TestFileInfo[]	Additional supported files for the test run
configFileInfo	TestFileInfo	The load test YAML file that contains the the test configuration
inputArtifactsZipFileInfo	TestFileInfo	The zip file with all input artifacts
testScriptFileInfo	TestFileInfo	The test script file for the test run
userPropFileInfo	TestFileInfo	The user properties file

Share via

Load Test Administration - Create Or Update Test

URI Parameters

Request Body

Responses

Security

Oauth2

Scopes

Examples

Create or update a load test

Sample request

Sample response

Definitions

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

CertificateMetadata

CertificateType

FileType

FileValidationStatus

LoadTestConfiguration

OptionalLoadTestConfiguration

PassFailAction

PassFailAggregationFunction

PassFailCriteria

PassFailMetric

PassFailResult

PFMetrics

Secret

SecretType

Test

TestCreateOrUpdate

TestFileInfo

TestInputArtifacts