Microsoft.LoadTestService (preview:2024-05-01)

2025/03/12 • 7 updated methods

LoadTestRun_ListTestRuns (updated)
Description :  Get all test runs for the given filters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestRun_ListTestRuns",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "testArtifacts": [
              {
                "inputArtifacts": [
                  {
                    "#name": "configFileInfo",
                    "Description": {
                      "new": "The load test YAML file that contains the the test configuration",
                      "old": "File info"
                    }
                  },
                  {
                    "#name": "testScriptFileInfo",
                    "Description": {
                      "new": "The test script file for the test run",
                      "old": "File info"
                    }
                  },
                  {
                    "#name": "userPropFileInfo",
                    "Description": {
                      "new": "The user properties file",
                      "old": "File info"
                    }
                  },
                  {
                    "#name": "inputArtifactsZipFileInfo",
                    "Description": {
                      "new": "The zip file for all input artifacts",
                      "old": "File info"
                    }
                  }
                ]
              },
              {
                "outputArtifacts": [
                  {
                    "#name": "resultFileInfo",
                    "Description": {
                      "new": "The test run results file",
                      "old": "File info"
                    }
                  },
                  {
                    "#name": "logsFileInfo",
                    "Description": {
                      "new": "The test run report with metrics",
                      "old": "File info"
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /test-runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
orderby:
{
Description: Sort on the supported fields in (field asc/desc) format. eg: executedDateTime asc. Supported fields - executedDateTime ,
Required: False ,
}
string ,
search:
{
Description: Prefix based, case sensitive search on searchable fields - description, executedUser. For example, to search for a test run, with description 500 VUs, the search parameter can be 500. ,
Required: False ,
}
string ,
testId:
{
Description: Unique name of an existing load test. ,
Required: False ,
}
string ,
executionFrom:
{
Description: Start DateTime(RFC 3339 literal format) of test-run execution time filter range. ,
Format: date-time ,
Required: False ,
}
string ,
executionTo:
{
Description: End DateTime(RFC 3339 literal format) of test-run execution time filter range. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Comma separated list of test run status. ,
Required: False ,
}
string ,
maxpagesize:
{
Description: Number of results in response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The TestRun items on this page ,
Required: True ,
}
[
{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: The load test YAML file that contains the the test configuration ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: The test script file for the test run ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: The user properties file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: The zip file for all input artifacts ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: The test run results file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: The test run report with metrics ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestRun_GetTestRun (updated)
Description :  Get test run details by test run Id.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestRun_GetTestRun",
  "$responses": {
    "200": {
      "$properties": {
        "testArtifacts": [
          {
            "inputArtifacts": [
              {
                "#name": "configFileInfo",
                "Description": {
                  "new": "The load test YAML file that contains the the test configuration",
                  "old": "File info"
                }
              },
              {
                "#name": "testScriptFileInfo",
                "Description": {
                  "new": "The test script file for the test run",
                  "old": "File info"
                }
              },
              {
                "#name": "userPropFileInfo",
                "Description": {
                  "new": "The user properties file",
                  "old": "File info"
                }
              },
              {
                "#name": "inputArtifactsZipFileInfo",
                "Description": {
                  "new": "The zip file for all input artifacts",
                  "old": "File info"
                }
              }
            ]
          },
          {
            "outputArtifacts": [
              {
                "#name": "resultFileInfo",
                "Description": {
                  "new": "The test run results file",
                  "old": "File info"
                }
              },
              {
                "#name": "logsFileInfo",
                "Description": {
                  "new": "The test run report with metrics",
                  "old": "File info"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /test-runs/{testRunId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: The load test YAML file that contains the the test configuration ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: The test script file for the test run ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: The user properties file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: The zip file for all input artifacts ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: The test run results file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: The test run report with metrics ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestRun_CreateOrUpdateTestRun (updated)
Description :  Create and start a new test run with the given test run Id.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestRun_CreateOrUpdateTestRun",
  "$responses": {
    "200": {
      "$properties": {
        "testArtifacts": [
          {
            "inputArtifacts": [
              {
                "#name": "configFileInfo",
                "Description": {
                  "new": "The load test YAML file that contains the the test configuration",
                  "old": "File info"
                }
              },
              {
                "#name": "testScriptFileInfo",
                "Description": {
                  "new": "The test script file for the test run",
                  "old": "File info"
                }
              },
              {
                "#name": "userPropFileInfo",
                "Description": {
                  "new": "The user properties file",
                  "old": "File info"
                }
              },
              {
                "#name": "inputArtifactsZipFileInfo",
                "Description": {
                  "new": "The zip file for all input artifacts",
                  "old": "File info"
                }
              }
            ]
          },
          {
            "outputArtifacts": [
              {
                "#name": "resultFileInfo",
                "Description": {
                  "new": "The test run results file",
                  "old": "File info"
                }
              },
              {
                "#name": "logsFileInfo",
                "Description": {
                  "new": "The test run report with metrics",
                  "old": "File info"
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "testArtifacts": [
          {
            "inputArtifacts": [
              {
                "#name": "configFileInfo",
                "Description": {
                  "new": "The load test YAML file that contains the the test configuration",
                  "old": "File info"
                }
              },
              {
                "#name": "testScriptFileInfo",
                "Description": {
                  "new": "The test script file for the test run",
                  "old": "File info"
                }
              },
              {
                "#name": "userPropFileInfo",
                "Description": {
                  "new": "The user properties file",
                  "old": "File info"
                }
              },
              {
                "#name": "inputArtifactsZipFileInfo",
                "Description": {
                  "new": "The zip file for all input artifacts",
                  "old": "File info"
                }
              }
            ]
          },
          {
            "outputArtifacts": [
              {
                "#name": "resultFileInfo",
                "Description": {
                  "new": "The test run results file",
                  "old": "File info"
                }
              },
              {
                "#name": "logsFileInfo",
                "Description": {
                  "new": "The test run report with metrics",
                  "old": "File info"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /test-runs/{testRunId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
oldTestRunId:
{
Description: 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. ,
Required: False ,
}
string ,
body:
{
Description: The resource instance. ,
Required: True ,
}
{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: The load test YAML file that contains the the test configuration ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: The test script file for the test run ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: The user properties file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: The zip file for all input artifacts ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: The test run results file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: The test run report with metrics ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: The load test YAML file that contains the the test configuration ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: The test script file for the test run ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: The user properties file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: The zip file for all input artifacts ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: The test run results file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: The test run report with metrics ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestRun_StopTestRun (updated)
Description :  Stop test run by test run Id.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestRun_StopTestRun",
  "$responses": {
    "200": {
      "$properties": {
        "testArtifacts": [
          {
            "inputArtifacts": [
              {
                "#name": "configFileInfo",
                "Description": {
                  "new": "The load test YAML file that contains the the test configuration",
                  "old": "File info"
                }
              },
              {
                "#name": "testScriptFileInfo",
                "Description": {
                  "new": "The test script file for the test run",
                  "old": "File info"
                }
              },
              {
                "#name": "userPropFileInfo",
                "Description": {
                  "new": "The user properties file",
                  "old": "File info"
                }
              },
              {
                "#name": "inputArtifactsZipFileInfo",
                "Description": {
                  "new": "The zip file for all input artifacts",
                  "old": "File info"
                }
              }
            ]
          },
          {
            "outputArtifacts": [
              {
                "#name": "resultFileInfo",
                "Description": {
                  "new": "The test run results file",
                  "old": "File info"
                }
              },
              {
                "#name": "logsFileInfo",
                "Description": {
                  "new": "The test run report with metrics",
                  "old": "File info"
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /test-runs/{testRunId}:stop
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: 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. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: The load test YAML file that contains the the test configuration ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: The test script file for the test run ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: The user properties file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: The zip file for all input artifacts ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: The test run results file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: The test run report with metrics ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestAdministration_ListTests (updated)
Description :  Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestAdministration_ListTests",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "inputArtifacts": [
              {
                "#name": "configFileInfo",
                "Description": {
                  "new": "The load test YAML file that contains the the test configuration",
                  "old": "File info"
                }
              },
              {
                "#name": "testScriptFileInfo",
                "Description": {
                  "new": "The test script file for the test run",
                  "old": "File info"
                }
              },
              {
                "#name": "userPropFileInfo",
                "Description": {
                  "new": "The user properties file",
                  "old": "File info"
                }
              },
              {
                "#name": "inputArtifactsZipFileInfo",
                "Description": {
                  "new": "The zip file with all input artifacts",
                  "old": "File info"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /tests
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
orderby:
{
Description: Sort on the supported fields in (field asc/desc) format. eg: lastModifiedDateTime asc. Supported fields - lastModifiedDateTime ,
Required: False ,
}
string ,
search:
{
Description: Prefix based, case sensitive search on searchable fields - displayName, createdBy. For example, to search for a test, with display name is Login Test, the search parameter can be Login. ,
Required: False ,
}
string ,
lastModifiedStartTime:
{
Description: Start DateTime(RFC 3339 literal format) of the last updated time range to filter tests. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedEndTime:
{
Description: End DateTime(RFC 3339 literal format) of the last updated time range to filter tests. ,
Format: date-time ,
Required: False ,
}
string ,
maxpagesize:
{
Description: Number of results in response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Test items on this page ,
Required: True ,
}
[
{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: The input artifacts for the test. ,
Required: False ,
}
{
configFileInfo:
{
Description: The load test YAML file that contains the the test configuration ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: The test script file for the test run ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: The user properties file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: The zip file with all input artifacts ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestAdministration_GetTest (updated)
Description :  Get load test details by test Id
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestAdministration_GetTest",
  "$responses": {
    "200": {
      "$properties": {
        "inputArtifacts": [
          {
            "#name": "configFileInfo",
            "Description": {
              "new": "The load test YAML file that contains the the test configuration",
              "old": "File info"
            }
          },
          {
            "#name": "testScriptFileInfo",
            "Description": {
              "new": "The test script file for the test run",
              "old": "File info"
            }
          },
          {
            "#name": "userPropFileInfo",
            "Description": {
              "new": "The user properties file",
              "old": "File info"
            }
          },
          {
            "#name": "inputArtifactsZipFileInfo",
            "Description": {
              "new": "The zip file with all input artifacts",
              "old": "File info"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /tests/{testId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: The input artifacts for the test. ,
Required: False ,
}
{
configFileInfo:
{
Description: The load test YAML file that contains the the test configuration ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: The test script file for the test run ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: The user properties file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: The zip file with all input artifacts ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestAdministration_CreateOrUpdateTest (updated)
Description :  Create a new test or update an existing test by providing the test Id.
Reference :  Link ¶

⚶ Changes

{
  "#id": "LoadTestAdministration_CreateOrUpdateTest",
  "$responses": {
    "200": {
      "$properties": {
        "inputArtifacts": [
          {
            "#name": "configFileInfo",
            "Description": {
              "new": "The load test YAML file that contains the the test configuration",
              "old": "File info"
            }
          },
          {
            "#name": "testScriptFileInfo",
            "Description": {
              "new": "The test script file for the test run",
              "old": "File info"
            }
          },
          {
            "#name": "userPropFileInfo",
            "Description": {
              "new": "The user properties file",
              "old": "File info"
            }
          },
          {
            "#name": "inputArtifactsZipFileInfo",
            "Description": {
              "new": "The zip file with all input artifacts",
              "old": "File info"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "inputArtifacts": [
          {
            "#name": "configFileInfo",
            "Description": {
              "new": "The load test YAML file that contains the the test configuration",
              "old": "File info"
            }
          },
          {
            "#name": "testScriptFileInfo",
            "Description": {
              "new": "The test script file for the test run",
              "old": "File info"
            }
          },
          {
            "#name": "userPropFileInfo",
            "Description": {
              "new": "The user properties file",
              "old": "File info"
            }
          },
          {
            "#name": "inputArtifactsZipFileInfo",
            "Description": {
              "new": "The zip file with all input artifacts",
              "old": "File info"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /tests/{testId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: The resource instance. ,
Required: True ,
}
{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: The input artifacts for the test. ,
Required: False ,
}
{
configFileInfo:
{
Description: The load test YAML file that contains the the test configuration ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: The test script file for the test run ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: The user properties file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: The zip file with all input artifacts ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: 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. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: 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. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. 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. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: The input artifacts for the test. ,
Required: False ,
}
{
configFileInfo:
{
Description: The load test YAML file that contains the the test configuration ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: The test script file for the test run ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: The user properties file ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: The zip file with all input artifacts ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
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. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}