Microsoft.LoadTestService (preview:2022-06-01)

2025/06/26 • 26 deleted methods

AppComponent_CreateOrUpdateAppComponents (removed)
Description :  Associate an App Component (Azure resource) to a test or test run.
Reference :  Link ¶

⚼ Request

PATCH:  /appcomponents/{name}
{
name:
{
Description: Unique name of the App Component, 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: Azure Load Testing 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: 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: Azure Load Testing 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: 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: Azure Load Testing 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: 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: Error from a REST request. ,
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 an App Component.
Reference :  Link ¶

⚼ Request

DELETE:  /appcomponents/{name}
{
name:
{
Description: Unique name of the App Component, 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: Error from a REST request. ,
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 Component details by App Component name.
Reference :  Link ¶

⚼ Request

GET:  /appcomponents/{name}
{
name:
{
Description: Unique name of the App Component, must be a valid URL character ^[a-z0-9_-]*$. ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
resourceId:
{
Description: Azure Load Testing 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: 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: Error from a REST request. ,
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 or a test run by its name.
Reference :  Link ¶

⚼ Request

GET:  /appcomponents
{
testRunId:
{
Description: [Required, if testId is not provided] Test run Id. ,
Required: False ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
resourceId:
{
Description: Azure Load Testing 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: 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: Error from a REST request. ,
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 :  Configure server metrics for a test or test run
Reference :  Link ¶

⚼ Request

PATCH:  /serverMetricsConfig/{name}
{
name:
{
Description: Unique name for server metrics, must be a valid URL character ^[a-z0-9_-]*$. ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
body:
{
Description: Server metrics configuration model ,
Required: True ,
}
{
name:
{
Description: 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: 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: 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: Error from a REST request. ,
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 configuration by its name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
name:
{
Description: 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: Error from a REST request. ,
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 configuration by its name
Reference :  Link ¶

⚼ Request

DELETE:  /serverMetricsConfig/{name}
{
name:
{
Description: Unique name for server metrics, 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: Error from a REST request. ,
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 configuration for a test or test run by its name.
Reference :  Link ¶

⚼ Request

GET:  /serverMetricsConfig
{
testRunId:
{
Description: [Required, if testId is not provided] Test run Id. ,
Required: False ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: 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: Error from a REST request. ,
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 configuration for supported resource types.
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: Error from a REST request. ,
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: Error from a REST request. ,
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 :  Create a new test or Update an existing test.
Reference :  Link ¶

⚼ Request

PATCH:  /loadtests/{testId}
{
api-version:
{
Description: API version ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. ,
Required: True ,
}
string ,
body:
{
Description: Load test model ,
Required: True ,
}
{
testId:
{
Description: 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: 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
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: The created DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test model. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified the test model. ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
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)

{
testId:
{
Description: 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: 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
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: The created DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test model. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified the test model. ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
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 (201)

{
testId:
{
Description: 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: 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
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: The created DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test model. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified the test model. ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
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 (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: Error from a REST request. ,
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 by its name.
Reference :  Link ¶

⚼ Request

DELETE:  /loadtests/{testId}
{
api-version:
{
Description: API version ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. ,
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: Error from a REST request. ,
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 details by test name
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
testId:
{
Description: 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: 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
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: The created DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test model. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified the test model. ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
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 (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: Error from a REST request. ,
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 by the 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(ISO 8601 literal format) of the last updated time range to filter tests. ,
Format: date-time ,
Required: False ,
}
string ,
lastUpdatedEndTime:
{
Description: End DateTime(ISO 8601 literal format) of the last updated time range to filter tests. ,
Format: date-time ,
Required: False ,
}
string ,
continuationToken:
{
Description: Continuation token to get the next page of response. ,
Required: False ,
}
string ,
maxPageSize:
{
Description: Number 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: True ,
}
[
{
testId:
{
Description: 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: 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
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: The created DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test model. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified DateTime(ISO 8601 literal format) of the test model. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified the test model. ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
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 ,
}
,
]
,
nextLink:
{
Description: Link for the next 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: Error from a REST request. ,
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 size can't be more than 50 MB. Existing file with same name for the given test will be overwritten. File should be provided in the request body as multipart/form-data.
Reference :  Link ¶

⚼ Request

PUT:  /loadtests/{testId}/files/{fileId}
{
testId:
{
Description: Unique name for load test, 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS). ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
file:
{
Description: The file to be uploaded. ,
Required: True ,
}
file ,
}

⚐ Response (201)

{
url:
{
Description: File URL. ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier. ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file. ,
Required: False ,
}
string ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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: Error from a REST request. ,
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 by the file name.
Reference :  Link ¶

⚼ Request

GET:  /loadtests/{testId}/files/{fileId}
{
testId:
{
Description: Unique name for load test, 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)

{
url:
{
Description: File URL. ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier. ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file. ,
Required: False ,
}
string ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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: Error from a REST request. ,
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 by the file name for a test.
Reference :  Link ¶

⚼ Request

DELETE:  /loadtests/{testId}/files/{fileId}
{
testId:
{
Description: Unique name for load test, 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: Error from a REST request. ,
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
{
api-version:
{
Description: API version ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. ,
Required: True ,
}
string ,
continuationToken:
{
Description: Continuation token to get the next page of response. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of file URLs. ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link for the next list of file URLs, 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: Error from a REST request. ,
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 by its name.
Reference :  Link ¶

⚼ Request

DELETE:  /testruns/{testRunId}
{
testRunId:
{
Description: Unique name of the load test run, 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: Error from a REST request. ,
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 a new test run with the given name.
Reference :  Link ¶

⚼ Request

PATCH:  /testruns/{testRunId}
{
testRunId:
{
Description: Unique name of the load test run, must be a valid URL character ^[a-z0-9_-]*$. ,
Required: True ,
}
string ,
oldTestRunId:
{
Description: Existing test run Id that should be rerun. ,
Required: False ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
body:
{
Description: Load test run model ,
Required: True ,
}
{
testRunId:
{
Description: Unique test run name as identifier. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test run. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
resourceId:
{
Description: Load test resource Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The test run start DateTime(ISO 8601 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(ISO 8601 literal 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
testResult:
{
Description: 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: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
logsUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: Test run statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The created DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test run. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last updated DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that updated the test run. ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
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 ,
}
,
}

⚐ Response (200)

{
testRunId:
{
Description: Unique test run name as identifier. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test run. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
resourceId:
{
Description: Load test resource Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The test run start DateTime(ISO 8601 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(ISO 8601 literal 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
testResult:
{
Description: 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: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
logsUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: Test run statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The created DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test run. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last updated DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that updated the test run. ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
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 ,
}

⚐ 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: Error from a REST request. ,
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 details by name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
testRunId:
{
Description: Unique test run name as identifier. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test run. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
resourceId:
{
Description: Load test resource Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The test run start DateTime(ISO 8601 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(ISO 8601 literal 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
testResult:
{
Description: 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: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
logsUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: Test run statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The created DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test run. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last updated DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that updated the test run. ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
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 ,
}

⚐ 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: Error from a REST request. ,
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 test run file by file name.
Reference :  Link ¶

⚼ Request

GET:  /testruns/{testRunId}/files/{fileId}
{
testRunId:
{
Description: Unique name of load test run, 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)

{
url:
{
Description: File URL. ,
Required: False ,
}
string ,
fileId:
{
Description: File unique identifier. ,
Required: False ,
}
string ,
filename:
{
Description: Name of the file. ,
Required: False ,
}
string ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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: Error from a REST request. ,
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_ListTestRunsSearch (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 ,
continuationToken:
{
Description: Continuation token to get the next page of response. ,
Required: False ,
}
string ,
search:
{
Description: Filter search based on searchable fields - description, executedUser. ,
Required: False ,
}
string ,
executionFrom:
{
Description: The end DateTime(ISO 8601 literal format) of test-run execution time filter range. ,
Format: date-time ,
Required: False ,
}
string ,
executionTo:
{
Description: The start DateTime(ISO 8601 literal 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: Number of results in response. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for load test, must be a valid URL character ^[a-z0-9_-]*$. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Resources ,
Required: True ,
}
[
{
testRunId:
{
Description: Unique test run name as identifier. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test run. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
resourceId:
{
Description: Load test resource Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The test run start DateTime(ISO 8601 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(ISO 8601 literal 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
testResult:
{
Description: 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: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
logsUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: Test run statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The created DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test run. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last updated DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that updated the test run. ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
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 ,
}
,
]
,
nextLink:
{
Description: Link for the next 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: Error from a REST request. ,
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 by name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
testRunId:
{
Description: Unique test run name as identifier. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test run. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
resourceId:
{
Description: Load test resource Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Required: False ,
}
string ,
startDateTime:
{
Description: The test run start DateTime(ISO 8601 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(ISO 8601 literal 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-45. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: Whether all the input CSV files should be split evenly across all engines. ,
Required: False ,
}
boolean ,
}
,
testResult:
{
Description: 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: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
userPropUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
additionalUrls:
{
Description: 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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
logsUrl:
{
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 ,
fileType:
{
Description: Integer representation of the file type (0 = JMX_FILE, 1 = USER_PROPERTIES, 2 = ADDITIONAL_ARTIFACTS) ,
Format: int32 ,
Required: False ,
}
integer ,
expireTime:
{
Description: Expiry time of the file ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Required: False ,
}
string ,
}
,
}
,
}
,
executedDateTime:
{
Description: Test run initiated time ,
Format: date-time ,
Required: False ,
}
string ,
vusers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
testRunStatistics:
{
Description: Test run statistics ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The created DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created the test run. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last updated DateTime(ISO 8601 literal format) of the test run. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that updated the test run. ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
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 ,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
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 ,
}

⚐ 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: Error from a REST request. ,
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 load test run.
Reference :  Link ¶

⚼ Request

POST:  /testruns/{testRunId}/clientMetrics
{
testRunId:
{
Description: Unique name of the load test run, must be a valid URL character ^[a-z0-9_-]*$. ,
Required: True ,
}
string ,
api-version:
{
Description: API version ,
Required: True ,
}
string ,
body:
{
Description: Client metrics request model ,
Required: True ,
}
{
requestSamplers:
{
Description: List of request samplers, maximum supported samplers for queries are 20. In case of empty, it will return metrics for maximum 20 samplers ,
Required: False ,
}
[
string ,
]
,
errors:
{
Description: List of errors, maximum supported errors for queries are 20. In case of empty, by default will return metrics for maximum 20 errors ,
Required: False ,
}
[
string ,
]
,
percentiles:
{
Description: List of percentiles values for response time, supported values 50,90,99,95. Default value is 50th percentile. ,
Required: False ,
}
[
string ,
]
,
groupByInterval:
{
Description: For test duration less than 10 minutes group by time interval can be any one of 5s,10s,1m,5m.\n\nFor test duration greater than 10 minutes, group by time interval can be any one of 1m,5m,1h. Default value is 1m. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time ,
Format: date-time ,
Required: True ,
}
string ,
endTime:
{
Description: End time ,
Format: date-time ,
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: Error from a REST request. ,
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 filters that are supported for client metrics for a given load test run
Reference :  Link ¶

⚼ Request

GET:  /testruns/{testRunId}/clientMetricsFilters
{
testRunId:
{
Description: Unique name for load test run, 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(ISO 8601 literal format) for the requested client metrics filter. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: end DateTime(ISO 8601 literal 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: Error from a REST request. ,
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 ,
]
,
}
,
}
,
}