Microsoft.LoadTestService (preview:2021-07-01)

2025/06/26 • 27 deleted methods

AppComponent_CreateOrUpdateAppComponents (removed)
Description :  Associate app component (a azure resource model) to a test model or test run
Reference :  Link ¶

⚼ Request

PATCH:  /appcomponents/{name}
{
name:
{
Description: Unique identifier for app component name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
body:
{
Description: App component model ,
Required: True ,
}
{
resourceId:
{
Description: [ReadOnly] Load test resource id ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
name:
{
Description: [ReadOnly] AppComponent name ,
Required: False ,
}
string ,
value:
{
Description: AppComponents Map { resource id (Fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
}
,
}

⚐ Response (200)

{
resourceId:
{
Description: [ReadOnly] Load test resource id ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
name:
{
Description: [ReadOnly] AppComponent name ,
Required: False ,
}
string ,
value:
{
Description: AppComponents Map { resource id (Fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
}

⚐ Response (201)

{
resourceId:
{
Description: [ReadOnly] Load test resource id ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
name:
{
Description: [ReadOnly] AppComponent name ,
Required: False ,
}
string ,
value:
{
Description: AppComponents Map { resource id (Fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
AppComponent_DeleteAppComponent (removed)
Description :  Delete app component
Reference :  Link ¶

⚼ Request

DELETE:  /appcomponents/{name}
{
name:
{
Description: Unique identifier for app component name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
AppComponent_GetAppComponentByName (removed)
Description :  Get App components for a given appComponentName in query param.
Reference :  Link ¶

⚼ Request

GET:  /appcomponents/{name}
{
name:
{
Description: Unique identifier for app component name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
resourceId:
{
Description: [ReadOnly] Load test resource id ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
name:
{
Description: [ReadOnly] AppComponent name ,
Required: False ,
}
string ,
value:
{
Description: AppComponents Map { resource id (Fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
AppComponent_GetAppComponent (removed)
Description :  Get App components for a test model or a test run of given name in query param.
Reference :  Link ¶

⚼ Request

GET:  /appcomponents
{
testId:
{
Description: Required testId, if testRunId name is not provided ,
Required: False ,
}
string ,
testRunId:
{
Description: Required testRunId, if testId is not provided ,
Required: False ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
resourceId:
{
Description: [ReadOnly] Load test resource id ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
name:
{
Description: [ReadOnly] AppComponent name ,
Required: False ,
}
string ,
value:
{
Description: AppComponents Map { resource id (Fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
File_FileValidate (removed)
Description :  Validate input file. File name must be a valid URL character ^[a-z0-9_-]*$. File size can't be more than 50 MB.
Reference :  Link ¶

⚼ Request

POST:  /file/{fileId}:validate
{
fileId:
{
Description: Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
file:
{
Description: Input test file ,
Required: True ,
}
file ,
}

⚐ Response (200)

{
valid:
{
Description: File is valid or not ,
Required: False ,
}
boolean ,
error:
{
Description: In case file is not valid then error message ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ServerMetrics_CreateOrUpdateServerMetricsConfig (removed)
Description :  Associate server metrics config to a test model or test run
Reference :  Link ¶

⚼ Request

PATCH:  /serverMetricsConfig/{name}
{
name:
{
Description: Unique identifier for server metric name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
body:
{
Description: Server metrics config model ,
Required: True ,
}
{
name:
{
Description: [ReadOnly] Server metrics config name ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Metrics map {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id) ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
name:
{
Description: [ReadOnly] Server metrics config name ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Metrics map {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id) ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
name:
{
Description: [ReadOnly] Server metrics config name ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Metrics map {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id) ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ServerMetrics_GetServerMetricsByName (removed)
Description :  Get server metrics config for a given name in query param.
Reference :  Link ¶

⚼ Request

GET:  /serverMetricsConfig/{name}
{
name:
{
Description: Unique identifier for server metric name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: [ReadOnly] Server metrics config name ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Metrics map {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id) ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ServerMetrics_DeleteServerMetrics (removed)
Description :  Delete server metrics config by given name
Reference :  Link ¶

⚼ Request

DELETE:  /serverMetricsConfig/{name}
{
name:
{
Description: Unique identifier for server metric name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ServerMetrics_GetServerMetrics (removed)
Description :  Get server metrics config for a test model or test run of given name in query param.
Reference :  Link ¶

⚼ Request

GET:  /serverMetricsConfig
{
testId:
{
Description: Required testId, if testRunId name is not provided ,
Required: False ,
}
string ,
testRunId:
{
Description: Required testRunId, if testId is not provided ,
Required: False ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: [ReadOnly] Server metrics config name ,
Required: False ,
}
string ,
testId:
{
Description: [Required if testRunId is not given] Load test unique identifier ,
Required: False ,
}
string ,
testRunId:
{
Description: [Required if testId is not given] Load test run unique identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Metrics map {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id) ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ServerMetrics_GetServerDefaultMetrics (removed)
Description :  Get all default server metrics config with supported resource type
Reference :  Link ¶

⚼ Request

GET:  /serverMetricsConfig/default
{
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
defaultMetrics:
{
Description: Default metrics map {resourceType : list of metrics config} (Refer for metrics structure: https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition) ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
ServerMetrics_ListSupportedResourceType (removed)
Description :  Get all supported resource types for app components(azure resource types)
Reference :  Link ¶

⚼ Request

GET:  /serverMetricsConfig/supportedResourceTypes
{
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Test_CreateOrUpdateTest (removed)
Description :  Creates/Updates a new load test. Test name must be a valid URL character ^[a-z0-9_-]*$
Reference :  Link ¶

⚼ Request

PATCH:  /loadtests/{testId}
{
testId:
{
Description: Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
body:
{
Description: Load test model ,
Required: True ,
}
{
testId:
{
Description: [ReadOnly] Unique test name as identifier ,
Required: False ,
}
string ,
description:
{
Description: The test description ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Fully qualified resource Id e.g /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test model ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last Modified DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that last modified the test model ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: False ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret type: AKV_SECRET_URI ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
testId:
{
Description: [ReadOnly] Unique test name as identifier ,
Required: False ,
}
string ,
description:
{
Description: The test description ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Fully qualified resource Id e.g /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test model ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last Modified DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that last modified the test model ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: False ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret type: AKV_SECRET_URI ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
testId:
{
Description: [ReadOnly] Unique test name as identifier ,
Required: False ,
}
string ,
description:
{
Description: The test description ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Fully qualified resource Id e.g /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test model ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last Modified DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that last modified the test model ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: False ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret type: AKV_SECRET_URI ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Test_DeleteLoadTest (removed)
Description :  Delete a test with given name. Test name must be a valid URL character ^[a-z0-9_-]*$
Reference :  Link ¶

⚼ Request

DELETE:  /loadtests/{testId}
{
testId:
{
Description: Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Test_GetLoadTest (removed)
Description :  Get load test model of given test name
Reference :  Link ¶

⚼ Request

GET:  /loadtests/{testId}
{
testId:
{
Description: Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
testId:
{
Description: [ReadOnly] Unique test name as identifier ,
Required: False ,
}
string ,
description:
{
Description: The test description ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Fully qualified resource Id e.g /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test model ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last Modified DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that last modified the test model ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: False ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret type: AKV_SECRET_URI ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Test_ListLoadTestSearch (removed)
Description :  Get all load tests for a given Fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}
Reference :  Link ¶

⚼ Request

GET:  /loadtests/sortAndFilter
{
orderBy:
{
Description: Sort on one of the field - lastModifiedDateTime, displayName, createdBy in (field asc/desc) format. eg: displayName asc ,
Required: False ,
}
string ,
search:
{
Description: Filter search based on searchable fields- testId, createdBy. ,
Required: False ,
}
string ,
lastUpdatedStartTime:
{
Description: Start DateTime(Iso8601Literal format) of the last updated time range to filter tests. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedEndTime:
{
Description: End DateTime(Iso8601Literal format) of the last updated time range to filter tests. ,
Format: date-time ,
Required: False ,
}
string ,
nextLink:
{
Description: NextLink Token to get next page of response ,
Required: False ,
}
string ,
maxPageSize:
{
Description: No of results in response ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Resources ,
Required: False ,
}
[
{
testId:
{
Description: [ReadOnly] Unique test name as identifier ,
Required: False ,
}
string ,
description:
{
Description: The test description ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Fully qualified resource Id e.g /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test model ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last Modified DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that last modified the test model ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: False ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret type: AKV_SECRET_URI ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
}
,
]
,
continuationToken:
{
Description: Continuation token for list of resources in case of paginated results, if applicable ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Test_UploadTestFile (removed)
Description :  Upload input file for a given test name. File name must be a valid URL character ^[a-z0-9_-]*$. File size can't be more than 50 MB. Existing file with same name for the given test will be overwritten.
Reference :  Link ¶

⚼ Request

PUT:  /loadtests/{testId}/files/{fileId}
{
testId:
{
Description: Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
fileId:
{
Description: Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
file:
{
Description: Artifact to upload as input for test ,
Required: True ,
}
file ,
}

⚐ Response (201)

{
testId:
{
Description: [ReadOnly] Unique test name as identifier ,
Required: False ,
}
string ,
description:
{
Description: The test description ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Fully qualified resource Id e.g /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
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 ,
}
,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test model ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last Modified DateTime(Iso8601Literal format) of the test model ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that last modified the test model ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: False ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret type: AKV_SECRET_URI ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Test_GetTestFile (removed)
Description :  Get test file with given file name.
Reference :  Link ¶

⚼ Request

GET:  /loadtests/{testId}/files/{fileId}
{
testId:
{
Description: Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
fileId:
{
Description: Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Path of the file ,
Required: False ,
}
string ,
url:
{
Description: url of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Test_DeleteTestFile (removed)
Description :  Delete file of given file name for a test. File name must be a valid URL character ^[a-z0-9_-]*$
Reference :  Link ¶

⚼ Request

DELETE:  /loadtests/{testId}/files/{fileId}
{
testId:
{
Description: Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
fileId:
{
Description: Unique identifier for test file, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
Test_GetAllTestFiles (removed)
Description :  Get all test files.
Reference :  Link ¶

⚼ Request

GET:  /loadtests/{testId}/files
{
testId:
{
Description: Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of file urls ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
TestRun_DeleteTestRun (removed)
Description :  Delete a test run with given name. Test run name must be a valid URL character ^[a-z0-9_-]*$
Reference :  Link ¶

⚼ Request

DELETE:  /testruns/{testRunId}
{
testRunId:
{
Description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
TestRun_CreateAndUpdateTest (removed)
Description :  Create and start new test run of the given name, test run name must be a valid URL character ^[a-z0-9_-]*$
Reference :  Link ¶

⚼ Request

PATCH:  /testruns/{testRunId}
{
testRunId:
{
Description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
oldTestRunId:
{
Description: Existing testRunId to re run new test ,
Required: False ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
body:
{
Description: Load test run model ,
Required: True ,
}
{
testRunId:
{
Description: [ReadOnly] Unique test run name as identifier ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a testRun ,
Required: False ,
}
string ,
testId:
{
Description: Associated testId ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Load test resource Id ,
Required: False ,
}
string ,
description:
{
Description: The test run description ,
Required: False ,
}
string ,
status:
{
Description: [ReadOnly] The test run status ,
Required: False ,
}
string ,
startDateTime:
{
Description: [ReadOnly] The test run start DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: [ReadOnly] The test run end DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
testResult:
{
Description: [ReadOnly] Test result for pass/Fail criteria used during the test run. possible outcome - ‘Passed’ , ‘Failed’ , ‘Not Applicable’ ,
Required: False ,
}
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 ,
}
,
testArtifacts:
{
Required: False ,
}
{
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: True ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run ,
Required: False ,
}
{
resultUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
logsUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: [ReadOnly] Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: [ReadOnly] No of virtual users, for which test has been run ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: [ReadOnly] Testrun statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test run ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last updated DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that updated the test run ,
Required: False ,
}
string ,
portalUrl:
{
Description: [ReadOnly] Portal url ,
Required: False ,
}
string ,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret types: AKV_SECRET_URI/SECRET_VALUE ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
duration:
{
Description: [ReadOnly] Test run duration in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
testRunId:
{
Description: [ReadOnly] Unique test run name as identifier ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a testRun ,
Required: False ,
}
string ,
testId:
{
Description: Associated testId ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Load test resource Id ,
Required: False ,
}
string ,
description:
{
Description: The test run description ,
Required: False ,
}
string ,
status:
{
Description: [ReadOnly] The test run status ,
Required: False ,
}
string ,
startDateTime:
{
Description: [ReadOnly] The test run start DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: [ReadOnly] The test run end DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
testResult:
{
Description: [ReadOnly] Test result for pass/Fail criteria used during the test run. possible outcome - ‘Passed’ , ‘Failed’ , ‘Not Applicable’ ,
Required: False ,
}
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 ,
}
,
testArtifacts:
{
Required: False ,
}
{
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: True ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run ,
Required: False ,
}
{
resultUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
logsUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: [ReadOnly] Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: [ReadOnly] No of virtual users, for which test has been run ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: [ReadOnly] Testrun statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test run ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last updated DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that updated the test run ,
Required: False ,
}
string ,
portalUrl:
{
Description: [ReadOnly] Portal url ,
Required: False ,
}
string ,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret types: AKV_SECRET_URI/SECRET_VALUE ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
duration:
{
Description: [ReadOnly] Test run duration in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
TestRun_GetTestRun (removed)
Description :  Get test run of given name.
Reference :  Link ¶

⚼ Request

GET:  /testruns/{testRunId}
{
testRunId:
{
Description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
testRunId:
{
Description: [ReadOnly] Unique test run name as identifier ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a testRun ,
Required: False ,
}
string ,
testId:
{
Description: Associated testId ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Load test resource Id ,
Required: False ,
}
string ,
description:
{
Description: The test run description ,
Required: False ,
}
string ,
status:
{
Description: [ReadOnly] The test run status ,
Required: False ,
}
string ,
startDateTime:
{
Description: [ReadOnly] The test run start DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: [ReadOnly] The test run end DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
testResult:
{
Description: [ReadOnly] Test result for pass/Fail criteria used during the test run. possible outcome - ‘Passed’ , ‘Failed’ , ‘Not Applicable’ ,
Required: False ,
}
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 ,
}
,
testArtifacts:
{
Required: False ,
}
{
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: True ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run ,
Required: False ,
}
{
resultUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
logsUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: [ReadOnly] Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: [ReadOnly] No of virtual users, for which test has been run ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: [ReadOnly] Testrun statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test run ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last updated DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that updated the test run ,
Required: False ,
}
string ,
portalUrl:
{
Description: [ReadOnly] Portal url ,
Required: False ,
}
string ,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret types: AKV_SECRET_URI/SECRET_VALUE ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
duration:
{
Description: [ReadOnly] Test run duration in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
TestRun_GetTestRunFile (removed)
Description :  Get testrun file with given file name.
Reference :  Link ¶

⚼ Request

GET:  /testruns/{testRunId}/files/{fileId}
{
testRunId:
{
Description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
fileId:
{
Description: Unique identifier for test run file, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Path of the file ,
Required: False ,
}
string ,
url:
{
Description: url of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
TestRun_GetAppTestRunsSearch (removed)
Description :  Get all test runs with given filters
Reference :  Link ¶

⚼ Request

GET:  /testruns/sortAndFilter
{
orderBy:
{
Description: Sort on one of the field - status, displayName, executedDateTime in (field asc/desc) format. eg: displayName asc ,
Required: False ,
}
string ,
nextLink:
{
Description: NextLink Token to get next page of response ,
Required: False ,
}
string ,
search:
{
Description: Filter search based on searchable fields - description, executedUser. ,
Required: False ,
}
string ,
testId:
{
Description: Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: False ,
}
string ,
executionFrom:
{
Description: The end DateTime(Iso8601Literal format) of test-run execution time filter range. ,
Format: date-time ,
Required: False ,
}
string ,
executionTo:
{
Description: The start DateTime(Iso8601Literal format) of test-run execution time filter range. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Comma separated list of test run status, value can be - "ACCEPTED", "NOTSTARTED","PROVISIONING","PROVISIONED","CONFIGURING", "CONFIGURED","EXECUTING","EXECUTED","DEPROVISIONING","DEPROVISIONED","DONE","CANCELLED","FAILED" ,
Required: False ,
}
string ,
maxPageSize:
{
Description: No of results in response ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Resources ,
Required: False ,
}
[
{
testRunId:
{
Description: [ReadOnly] Unique test run name as identifier ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a testRun ,
Required: False ,
}
string ,
testId:
{
Description: Associated testId ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Load test resource Id ,
Required: False ,
}
string ,
description:
{
Description: The test run description ,
Required: False ,
}
string ,
status:
{
Description: [ReadOnly] The test run status ,
Required: False ,
}
string ,
startDateTime:
{
Description: [ReadOnly] The test run start DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: [ReadOnly] The test run end DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
testResult:
{
Description: [ReadOnly] Test result for pass/Fail criteria used during the test run. possible outcome - ‘Passed’ , ‘Failed’ , ‘Not Applicable’ ,
Required: False ,
}
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 ,
}
,
testArtifacts:
{
Required: False ,
}
{
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: True ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run ,
Required: False ,
}
{
resultUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
logsUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: [ReadOnly] Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: [ReadOnly] No of virtual users, for which test has been run ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: [ReadOnly] Testrun statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test run ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last updated DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that updated the test run ,
Required: False ,
}
string ,
portalUrl:
{
Description: [ReadOnly] Portal url ,
Required: False ,
}
string ,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret types: AKV_SECRET_URI/SECRET_VALUE ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
duration:
{
Description: [ReadOnly] Test run duration in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
continuationToken:
{
Description: Continuation token for list of resources in case of paginated results, if applicable ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
TestRun_StopTestRun (removed)
Description :  Stop test run of given name.
Reference :  Link ¶

⚼ Request

POST:  /testruns/{testRunId}:stop
{
testRunId:
{
Description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
testRunId:
{
Description: [ReadOnly] Unique test run name as identifier ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a testRun ,
Required: False ,
}
string ,
testId:
{
Description: Associated testId ,
Required: False ,
}
string ,
resourceId:
{
Description: [ReadOnly] Load test resource Id ,
Required: False ,
}
string ,
description:
{
Description: The test run description ,
Required: False ,
}
string ,
status:
{
Description: [ReadOnly] The test run status ,
Required: False ,
}
string ,
startDateTime:
{
Description: [ReadOnly] The test run start DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: [ReadOnly] The test run end DateTime(Iso8601Literal format) ,
Format: date-time ,
Required: False ,
}
string ,
loadTestConfig:
{
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-50. Required for creating a new Test. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
testResult:
{
Description: [ReadOnly] Test result for pass/Fail criteria used during the test run. possible outcome - ‘Passed’ , ‘Failed’ , ‘Not Applicable’ ,
Required: False ,
}
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 ,
}
,
testArtifacts:
{
Required: False ,
}
{
inputArtifacts:
{
Description: [ReadOnly]The input artifacts for the test ,
Required: True ,
}
{
configUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
testScriptUrl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileurl:
{
Description: FileUrl Model ,
Required: False ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: [ReadOnly]The input artifacts file { name : url } map for the test run ,
Required: False ,
}
[
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run ,
Required: False ,
}
{
resultUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
logsUrl:
{
Description: FileUrl Model ,
Required: True ,
}
{
url:
{
Description: File url ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file ,
Required: False ,
}
string ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: [ReadOnly] Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: [ReadOnly] No of virtual users, for which test has been run ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: [ReadOnly] Testrun statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: [ReadOnly] The created DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: [ReadOnly] The user that created the test run ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: [ReadOnly] The last updated DateTime(Iso8601Literal format) of the test run ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: [ReadOnly] The user that updated the test run ,
Required: False ,
}
string ,
portalUrl:
{
Description: [ReadOnly] Portal url ,
Required: False ,
}
string ,
secrets:
{
Description: Secrets of higher importance , which are stored in a key-vault typically. Allowed secret types: AKV_SECRET_URI/SECRET_VALUE ,
Required: False ,
}
object ,
environmentVariables:
{
Description: Secrets of relatively lesser importance , which are defined as a set of pairs. ,
Required: False ,
}
object ,
duration:
{
Description: [ReadOnly] Test run duration in milliseconds ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
TestRun_GetTestRunClientMetrics (removed)
Description :  Get all client metrics for a given load test run
Reference :  Link ¶

⚼ Request

GET:  /testruns/{testRunId}/clientMetrics
{
testRunId:
{
Description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
filter:
{
Description: Filter to be used in metrics queries, filters can be applied on following fields : request, error, percentile( possible values : 90, 99, 95) or time (can be between start and end time). Request and error filter values can be get from /clientMetricsFilter API. Example of filter : (request eq 'HTTP Request1' or request eq 'total-4bec6d5b-c3c3-4f5f-be09-5c4abb28aedd') and (error eq 'Non HTTP response code: org.apache.http.conn.ConnectTimeoutException' or error eq 'total-4bec6d5b-c3c3-4f5f-be09-5c4abb28aedd') and (percentile eq 90) and (time ge 1626346535054 and time le 1626346924744) ,
Required: False ,
}
string ,
groupByInterval:
{
Description: Group by time interval, in which interval metrics needs to be retrieved, values can be 10s,20s,30s,1m,2m,5m,1h ,
Required: False ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
testRunId:
{
Description: Test run name for which client metrics results is required. ,
Required: False ,
}
string ,
timeSeries:
{
Required: False ,
}
{
activeUsers:
{
Description: Active users time series data ,
Required: False ,
}
object ,
responseTime:
{
Description: Response time, time series data ,
Required: False ,
}
object ,
throughput:
{
Description: Throughput time series data ,
Required: False ,
}
object ,
errors:
{
Description: Errors time series data ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
TestRun_GetTestRunClientMetricsFilters (removed)
Description :  Get all client metrics supported filters list for a given load test run
Reference :  Link ¶

⚼ Request

GET:  /testruns/{testRunId}/clientMetricsFilters
{
testRunId:
{
Description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ ,
Required: True ,
}
string ,
api-version:
{
Description: Api version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
testRunId:
{
Description: Test run name for which client metrics filters is required. ,
Required: False ,
}
string ,
filters:
{
Required: False ,
}
{
requestSamplerValues:
{
Description: List of request sampler for the test run, for which client metrics can be filtered ,
Required: False ,
}
[
string ,
]
,
errorFiltersValues:
{
Description: List of errors occurred for the test run, for which client metrics can be filtered ,
Required: False ,
}
[
string ,
]
,
}
,
timeRange:
{
Required: False ,
}
{
startTime:
{
Description: start DateTime(Iso8601Literal format) for the requested client metrics filter ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end DateTime(Iso8601Literal format) for the requested client metrics filter ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: The error code for specific error that occurred. ,
}
string ,
}
,
$schema:
{
Description: The definition of an error object. ,
}
{
error:
{
Description: The error response object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: Additional details and inner errors. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}