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

2024/12/03 • 39 new methods

TestProfileRunAdministration_ListTestProfileRuns (new)
Description :  Get all test profile runs for the given filters.
Reference :  Link ¶

⚼ Request

GET:  /test-profile-runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: Maximum number of results to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
minStartDateTime:
{
Description: Minimum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on. ,
Format: date-time ,
Required: False ,
}
string ,
maxStartDateTime:
{
Description: Maximum Start DateTime(RFC 3339 literal format) of the test profile runs to filter on. ,
Format: date-time ,
Required: False ,
}
string ,
minEndDateTime:
{
Description: Minimum End DateTime(RFC 3339 literal format) of the test profile runs to filter on. ,
Format: date-time ,
Required: False ,
}
string ,
maxEndDateTime:
{
Description: Maximum End DateTime(RFC 3339 literal format) of the test profile runs to filter on. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateStartTime:
{
Description: Start DateTime(RFC 3339 literal format) of the created time range to filter test profile runs. ,
Format: date-time ,
Required: False ,
}
string ,
createdDateEndTime:
{
Description: End DateTime(RFC 3339 literal format) of the created time range to filter test profile runs. ,
Format: date-time ,
Required: False ,
}
string ,
testProfileRunIds:
{
Description: Comma separated list of IDs of the test profile runs to filter. ,
Required: False ,
}
string ,
testProfileIds:
{
Description: Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch. ,
Required: False ,
}
string ,
statuses:
{
Description: Comma separated list of Statuses of the test profile runs to filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TestProfileRun items on this page ,
Required: True ,
}
[
{
testProfileRunId:
{
Description: Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
displayName:
{
Description: Display name for the test profile run. ,
Required: False ,
}
string ,
description:
{
Description: The test profile run description ,
Required: False ,
}
string ,
testProfileId:
{
Description: Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile run is created ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which the test profile ran. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The test profile run status. ,
Enum:
{
ACCEPTED: Test profile run request is accepted. ,
NOTSTARTED: Test profile run is not yet started. ,
EXECUTING: Test profile run has started executing. ,
DONE: Test profile run has completed successfully. ,
CANCELLING: Test profile run is being cancelled. ,
CANCELLED: Test profile run is cancelled. ,
FAILED: Test profile run has failed. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run. ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
startDateTime:
{
Description: The test profile run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test profile run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Test profile run duration in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
testRunDetails:
{
Description: Details of the test runs ran as part of the test profile run. Key is the testRunId of the corresponding testRun. ,
Required: False ,
}
object ,
recommendations:
{
Description: Recommendations provided based on a successful test profile run. ,
Required: False ,
}
[
{
category:
{
Description: Category of the recommendation. ,
Enum:
{
ThroughputOptimized: The recommendation for this category optimizes the throughput/RPS (Requests per Second) of the app. ,
CostOptimized: The recommendation for this category optimizes the cost of the app. ,
}
,
Required: True ,
}
enum ,
configurations:
{
Description: List of configurations IDs for which the recommendation is applicable. These are a subset of the provided target resource configurations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
testProfileRunId:
{
Description: Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
displayName:
{
Description: Display name for the test profile run. ,
Required: False ,
}
string ,
description:
{
Description: The test profile run description ,
Required: False ,
}
string ,
testProfileId:
{
Description: Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile run is created ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which the test profile ran. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The test profile run status. ,
Enum:
{
ACCEPTED: Test profile run request is accepted. ,
NOTSTARTED: Test profile run is not yet started. ,
EXECUTING: Test profile run has started executing. ,
DONE: Test profile run has completed successfully. ,
CANCELLING: Test profile run is being cancelled. ,
CANCELLED: Test profile run is cancelled. ,
FAILED: Test profile run has failed. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run. ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
startDateTime:
{
Description: The test profile run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test profile run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Test profile run duration in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
testRunDetails:
{
Description: Details of the test runs ran as part of the test profile run. Key is the testRunId of the corresponding testRun. ,
Required: False ,
}
object ,
recommendations:
{
Description: Recommendations provided based on a successful test profile run. ,
Required: False ,
}
[
{
category:
{
Description: Category of the recommendation. ,
Enum:
{
ThroughputOptimized: The recommendation for this category optimizes the throughput/RPS (Requests per Second) of the app. ,
CostOptimized: The recommendation for this category optimizes the cost of the app. ,
}
,
Required: True ,
}
enum ,
configurations:
{
Description: List of configurations IDs for which the recommendation is applicable. These are a subset of the provided target resource configurations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /test-profile-runs/{testProfileRunId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testProfileRunId:
{
Description: Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: The resource instance. ,
Required: True ,
}
{
displayName:
{
Description: Display name for the test profile run. ,
Required: False ,
}
string ,
description:
{
Description: The test profile run description ,
Required: False ,
}
string ,
testProfileId:
{
Description: Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
testProfileRunId:
{
Description: Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
displayName:
{
Description: Display name for the test profile run. ,
Required: False ,
}
string ,
description:
{
Description: The test profile run description ,
Required: False ,
}
string ,
testProfileId:
{
Description: Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile run is created ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which the test profile ran. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The test profile run status. ,
Enum:
{
ACCEPTED: Test profile run request is accepted. ,
NOTSTARTED: Test profile run is not yet started. ,
EXECUTING: Test profile run has started executing. ,
DONE: Test profile run has completed successfully. ,
CANCELLING: Test profile run is being cancelled. ,
CANCELLED: Test profile run is cancelled. ,
FAILED: Test profile run has failed. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run. ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
startDateTime:
{
Description: The test profile run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test profile run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Test profile run duration in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
testRunDetails:
{
Description: Details of the test runs ran as part of the test profile run. Key is the testRunId of the corresponding testRun. ,
Required: False ,
}
object ,
recommendations:
{
Description: Recommendations provided based on a successful test profile run. ,
Required: False ,
}
[
{
category:
{
Description: Category of the recommendation. ,
Enum:
{
ThroughputOptimized: The recommendation for this category optimizes the throughput/RPS (Requests per Second) of the app. ,
CostOptimized: The recommendation for this category optimizes the cost of the app. ,
}
,
Required: True ,
}
enum ,
configurations:
{
Description: List of configurations IDs for which the recommendation is applicable. These are a subset of the provided target resource configurations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
testProfileRunId:
{
Description: Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
displayName:
{
Description: Display name for the test profile run. ,
Required: False ,
}
string ,
description:
{
Description: The test profile run description ,
Required: False ,
}
string ,
testProfileId:
{
Description: Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile run is created ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which the test profile ran. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The test profile run status. ,
Enum:
{
ACCEPTED: Test profile run request is accepted. ,
NOTSTARTED: Test profile run is not yet started. ,
EXECUTING: Test profile run has started executing. ,
DONE: Test profile run has completed successfully. ,
CANCELLING: Test profile run is being cancelled. ,
CANCELLED: Test profile run is cancelled. ,
FAILED: Test profile run has failed. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run. ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
startDateTime:
{
Description: The test profile run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test profile run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Test profile run duration in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
testRunDetails:
{
Description: Details of the test runs ran as part of the test profile run. Key is the testRunId of the corresponding testRun. ,
Required: False ,
}
object ,
recommendations:
{
Description: Recommendations provided based on a successful test profile run. ,
Required: False ,
}
[
{
category:
{
Description: Category of the recommendation. ,
Enum:
{
ThroughputOptimized: The recommendation for this category optimizes the throughput/RPS (Requests per Second) of the app. ,
CostOptimized: The recommendation for this category optimizes the cost of the app. ,
}
,
Required: True ,
}
enum ,
configurations:
{
Description: List of configurations IDs for which the recommendation is applicable. These are a subset of the provided target resource configurations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
testProfileRunId:
{
Description: Unique identifier for the test profile run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
displayName:
{
Description: Display name for the test profile run. ,
Required: False ,
}
string ,
description:
{
Description: The test profile run description ,
Required: False ,
}
string ,
testProfileId:
{
Description: Associated test profile ID for the test profile run. This is required to create a test profile run and can't be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile run is created ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which the test profile ran. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
status:
{
Description: The test profile run status. ,
Enum:
{
ACCEPTED: Test profile run request is accepted. ,
NOTSTARTED: Test profile run is not yet started. ,
EXECUTING: Test profile run has started executing. ,
DONE: Test profile run has completed successfully. ,
CANCELLING: Test profile run is being cancelled. ,
CANCELLED: Test profile run is cancelled. ,
FAILED: Test profile run has failed. ,
}
,
Required: False ,
}
enum ,
errorDetails:
{
Description: Error details if there is any failure in test profile run. These errors are specific to the Test Profile Run. ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
startDateTime:
{
Description: The test profile run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test profile run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
durationInSeconds:
{
Description: Test profile run duration in seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
testRunDetails:
{
Description: Details of the test runs ran as part of the test profile run. Key is the testRunId of the corresponding testRun. ,
Required: False ,
}
object ,
recommendations:
{
Description: Recommendations provided based on a successful test profile run. ,
Required: False ,
}
[
{
category:
{
Description: Category of the recommendation. ,
Enum:
{
ThroughputOptimized: The recommendation for this category optimizes the throughput/RPS (Requests per Second) of the app. ,
CostOptimized: The recommendation for this category optimizes the cost of the app. ,
}
,
Required: True ,
}
enum ,
configurations:
{
Description: List of configurations IDs for which the recommendation is applicable. These are a subset of the provided target resource configurations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /test-profiles
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
maxpagesize:
{
Description: Maximum number of results to include in a single response. ,
Format: int32 ,
Required: False ,
}
integer ,
lastModifiedStartTime:
{
Description: Start DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedEndTime:
{
Description: End DateTime(RFC 3339 literal format) of the last updated time range to filter test profiles. ,
Format: date-time ,
Required: False ,
}
string ,
testProfileIds:
{
Description: Comma separated list of IDs of the test profiles to filter. ,
Required: False ,
}
string ,
testIds:
{
Description: Comma separated list IDs of the tests which should be associated with the test profiles to fetch. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The TestProfile items on this page ,
Required: True ,
}
[
{
testProfileId:
{
Description: Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of the test profile. ,
Required: False ,
}
string ,
description:
{
Description: Description for the test profile. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which testing would be done. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
testProfileId:
{
Description: Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of the test profile. ,
Required: False ,
}
string ,
description:
{
Description: Description for the test profile. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which testing would be done. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /test-profiles/{testProfileId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testProfileId:
{
Description: Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: The resource instance. ,
Required: True ,
}
{
displayName:
{
Description: Display name of the test profile. ,
Required: False ,
}
string ,
description:
{
Description: Description for the test profile. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which testing would be done. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
testProfileId:
{
Description: Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of the test profile. ,
Required: False ,
}
string ,
description:
{
Description: Description for the test profile. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which testing would be done. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
testProfileId:
{
Description: Unique identifier for the test profile, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
displayName:
{
Description: Display name of the test profile. ,
Required: False ,
}
string ,
description:
{
Description: Description for the test profile. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test ID for the test profile. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceId:
{
Description: Target resource ID on which the test profile is created. This property is required for creating a Test Profile and it's not allowed to be updated. ,
Required: False ,
}
string ,
targetResourceConfigurations:
{
Description: Configurations of the target resource on which testing would be done. ,
Required: False ,
}
{
kind:
{
Description: Kind of the resource for which the configurations apply. ,
Enum:
{
FunctionsFlexConsumption: Resource is a Azure FunctionApp on Flex Consumption Plan. ,
}
,
Required: True ,
}
enum ,
}
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The TestRun items on this page ,
Required: True ,
}
[
{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run. The sampler name is the same as the name mentioned in the test script. Sampler name "Total" represents the aggregated statistics of all the samplers. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: Regional statistics. Key is the Azure region name and value is the test run statistics. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
virtualUserHours:
{
Description: Virtual user hours consumed by the test run. ,
Format: double ,
Required: False ,
}
number ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdByType:
{
Description: The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc). ,
Enum:
{
User: Entity was created by a user. ,
ScheduledTrigger: Entity was created by a scheduled trigger. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run. The sampler name is the same as the name mentioned in the test script. Sampler name "Total" represents the aggregated statistics of all the samplers. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: Regional statistics. Key is the Azure region name and value is the test run statistics. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
virtualUserHours:
{
Description: Virtual user hours consumed by the test run. ,
Format: double ,
Required: False ,
}
number ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdByType:
{
Description: The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc). ,
Enum:
{
User: Entity was created by a user. ,
ScheduledTrigger: Entity was created by a scheduled trigger. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /test-runs/{testRunId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
oldTestRunId:
{
Description: Existing test run identifier that should be rerun, if this is provided, the test will run with the JMX file, configuration and app components from the existing test run. You can override the configuration values for new test run in the request body. ,
Required: False ,
}
string ,
body:
{
Description: The resource instance. ,
Required: True ,
}
{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
createdByType:
{
Description: The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc). ,
Enum:
{
User: Entity was created by a user. ,
ScheduledTrigger: Entity was created by a scheduled trigger. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run. The sampler name is the same as the name mentioned in the test script. Sampler name "Total" represents the aggregated statistics of all the samplers. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: Regional statistics. Key is the Azure region name and value is the test run statistics. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
virtualUserHours:
{
Description: Virtual user hours consumed by the test run. ,
Format: double ,
Required: False ,
}
number ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdByType:
{
Description: The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc). ,
Enum:
{
User: Entity was created by a user. ,
ScheduledTrigger: Entity was created by a scheduled trigger. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run. The sampler name is the same as the name mentioned in the test script. Sampler name "Total" represents the aggregated statistics of all the samplers. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: Regional statistics. Key is the Azure region name and value is the test run statistics. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
virtualUserHours:
{
Description: Virtual user hours consumed by the test run. ,
Format: double ,
Required: False ,
}
number ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdByType:
{
Description: The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc). ,
Enum:
{
User: Entity was created by a user. ,
ScheduledTrigger: Entity was created by a scheduled trigger. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
testRunId:
{
Description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
errorDetails:
{
Description: Error details if there is any failure in load test run ,
Required: False ,
}
[
{
message:
{
Description: Error details in case test run was not successfully run. ,
Required: False ,
}
string ,
}
,
]
,
testRunStatistics:
{
Description: Test run statistics. Key is the sampler name and value is the set of statistics for performance metrics like response time, throughput, etc. from the load test run. The sampler name is the same as the name mentioned in the test script. Sampler name "Total" represents the aggregated statistics of all the samplers. ,
Required: False ,
}
object ,
regionalStatistics:
{
Description: Regional statistics. Key is the Azure region name and value is the test run statistics. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
testArtifacts:
{
Description: Collection of test run artifacts ,
Required: False ,
}
{
inputArtifacts:
{
Description: The input artifacts for the test run. ,
Required: False ,
}
{
configFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
outputArtifacts:
{
Description: The output artifacts for the test run. ,
Required: False ,
}
{
resultFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
logsFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
artifactsContainerInfo:
{
Description: The container for test run artifacts. ,
Required: False ,
}
{
url:
{
Description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. ,
Format: uri ,
Required: False ,
}
string ,
expireDateTime:
{
Description: Expiry time of the container (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
reportFileInfo:
{
Description: The report file for the test run. ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
}
,
}
,
testResult:
{
Description: Test result for pass/Fail criteria used during the test run. ,
Enum:
{
PASSED: Pass/fail criteria has passed. ,
NOT_APPLICABLE: Pass/fail criteria is not applicable. ,
FAILED: Pass/fail criteria has failed. ,
}
,
Required: False ,
}
enum ,
virtualUsers:
{
Description: Number of virtual users, for which test has been run. ,
Format: int32 ,
Required: False ,
}
integer ,
displayName:
{
Description: Display name of a testRun. ,
Required: False ,
}
string ,
testId:
{
Description: Associated test Id. ,
Required: False ,
}
string ,
description:
{
Description: The test run description. ,
Required: False ,
}
string ,
status:
{
Description: The test run status. ,
Enum:
{
ACCEPTED: Test run request is accepted. ,
NOTSTARTED: Test run is not yet started. ,
PROVISIONING: Test run is provisioning. ,
PROVISIONED: Test run is provisioned. ,
CONFIGURING: Test run is getting configured. ,
CONFIGURED: Test run configuration is done. ,
EXECUTING: Test run has started executing. ,
EXECUTED: Test run execution is completed. ,
DEPROVISIONING: Test run is getting deprovisioned. ,
DEPROVISIONED: Test run is deprovisioned. ,
DONE: Test run is completed. ,
CANCELLING: Test run is being cancelled. ,
CANCELLED: Test run request is cancelled. ,
FAILED: Test run request is failed. ,
VALIDATION_SUCCESS: Test run JMX file is validated. ,
VALIDATION_FAILURE: Test run JMX file validation is failed. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: The test run start DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
endDateTime:
{
Description: The test run end DateTime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
executedDateTime:
{
Description: Test run initiated time. ,
Format: date-time ,
Required: False ,
}
string ,
portalUrl:
{
Description: Portal url. ,
Required: False ,
}
string ,
duration:
{
Description: Test run duration in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
virtualUserHours:
{
Description: Virtual user hours consumed by the test run. ,
Format: double ,
Required: False ,
}
number ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Type of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
requestDataLevel:
{
Description: Request data collection level for test run ,
Enum:
{
NONE: No request data will be collected ,
ERRORS: Request data will be collected in case of failed requests ,
}
,
Required: False ,
}
enum ,
debugLogsEnabled:
{
Description: Enable or disable debug level logging. True if debug logs are enabled for the test run. False otherwise ,
Required: False ,
}
boolean ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
createdByType:
{
Description: The type of the entity that created the test run. (E.x. User, ScheduleTrigger, etc). ,
Enum:
{
User: Entity was created by a user. ,
ScheduledTrigger: Entity was created by a scheduled trigger. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /test-runs/{testRunId}/app-components
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique Id for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: App Component model. ,
Required: True ,
}
{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: the values for the metric definitions. ,
Required: True ,
}
[
{
dimensions:
{
Description: List of dimensions ,
Required: False ,
}
[
{
description:
{
Description: The description ,
Required: False ,
}
string ,
name:
{
Description: The name ,
Required: False ,
}
string ,
}
,
]
,
description:
{
Description: The metric description ,
Required: False ,
}
string ,
name:
{
Description: The metric name ,
Required: False ,
}
string ,
namespace:
{
Description: The namespace the metric belongs to. ,
Required: False ,
}
string ,
primaryAggregationType:
{
Description: The primary aggregation type value defining how to use the values for display. ,
Enum:
{
Average: Average value. ,
Count: Total count. ,
None: Aggregation will be average in this case. ,
Total: Total sum. ,
Percentile75: 75th percentile. ,
Percentile90: 90th percentile. ,
Percentile95: 95th percentile. ,
Percentile96: 96th percentile. ,
Percentile97: 97th percentile. ,
Percentile98: 98th percentile. ,
Percentile99: 99th percentile. ,
Percentile999: 99.9th percentile. ,
Percentile9999: 99.99th percentile. ,
}
,
Required: False ,
}
enum ,
supportedAggregationTypes:
{
Description: The collection of what all aggregation types are supported. ,
Required: False ,
}
[
string ,
]
,
unit:
{
Description: The unit of the metric. ,
Enum:
{
NotSpecified: No unit specified. ,
Percent: Percentage. ,
Count: Value count. ,
Seconds: Seconds. ,
Milliseconds: Milliseconds ,
Bytes: Bytes ,
BytesPerSecond: Bytes per second ,
CountPerSecond: Count per second ,
}
,
Required: False ,
}
enum ,
metricAvailabilities:
{
Description: Metric availability specifies the time grain (aggregation interval or frequency). ,
Required: False ,
}
[
{
timeGrain:
{
Description: The time grain specifies the aggregation interval for the metric. Expressed as a duration 'PT1M', 'PT1H', etc. ,
Enum:
{
PT5S: 5 seconds, available only if test run duration is less than 10 minutes. ,
PT10S: 10 seconds, available only if test run duration is less than 10 minutes. ,
PT1M: 1 minute ,
PT5M: 5 minutes, available only if test run duration is greater than 1 minute. ,
PT1H: 1 hour, available only if test run duration is greater than 1 minute. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /test-runs/{testRunId}/metric-dimensions/{name}/values
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
name:
{
Description: Dimension name ,
Required: True ,
}
string ,
metricname:
{
Description: Metric name ,
Required: True ,
}
string ,
interval:
{
Description: The interval (i.e. timegrain) of the query. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: Metric namespace to query metric definitions for. ,
Required: True ,
}
string ,
timespan:
{
Description: The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The dimension name ,
Required: False ,
}
string ,
value:
{
Description: The dimension value ,
Required: False ,
}
[
string ,
]
,
nextLink:
{
Description: Link for the next set of values in case of paginated results, if applicable. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The values for the metric namespaces. ,
Required: True ,
}
[
{
description:
{
Description: The namespace description. ,
Required: False ,
}
string ,
name:
{
Description: The metric namespace name. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

POST:  /test-runs/{testRunId}/metrics
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
aggregation:
{
Description: The aggregation ,
Required: False ,
}
string ,
metricname:
{
Description: Metric name ,
Required: True ,
}
string ,
interval:
{
Description: The interval (i.e. timegrain) of the query. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: Metric namespace to query metric definitions for. ,
Required: True ,
}
string ,
timespan:
{
Description: The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. ,
Required: True ,
}
string ,
body:
{
Description: Metric dimension filter ,
Required: False ,
}
{
filters:
{
Description: Get metrics for specific dimension values. Example: Metric contains dimension like SamplerName, Error. To retrieve all the time series data where SamplerName is equals to HTTPRequest1 or HTTPRequest2, the DimensionFilter value will be {"SamplerName", ["HTTPRequest1", "HTTPRequest2"} ,
Required: False ,
}
[
{
name:
{
Description: The dimension name ,
Required: False ,
}
string ,
values:
{
Description: The dimension values. Maximum values can be 20. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: The TimeSeriesElement items on this page ,
Required: True ,
}
[
{
data:
{
Description: An array of data points representing the metric values. ,
Required: False ,
}
[
{
timestamp:
{
Description: The timestamp for the metric value in RFC 3339 format. ,
Format: date-time ,
Required: False ,
}
string ,
value:
{
Description: The metric value. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
dimensionValues:
{
Description: The dimension values ,
Required: False ,
}
[
{
name:
{
Description: The name of the dimension. ,
Required: False ,
}
string ,
value:
{
Description: The value of the dimension. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /test-runs/{testRunId}/server-metrics-config
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testRunId:
{
Description: Unique Id for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: Server metric configuration model. ,
Required: True ,
}
{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
testRunId:
{
Description: Test run identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: False ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestAdministration_ListTests (new)
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:  /tests
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
orderby:
{
Description: Sort on the supported fields in (field asc/desc) format. eg: lastModifiedDateTime asc. Supported fields - lastModifiedDateTime ,
Required: False ,
}
string ,
search:
{
Description: Prefix based, case sensitive search on searchable fields - displayName, createdBy. For example, to search for a test, with display name is Login Test, the search parameter can be Login. ,
Required: False ,
}
string ,
lastModifiedStartTime:
{
Description: Start DateTime(RFC 3339 literal format) of the last updated time range to filter tests. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedEndTime:
{
Description: End DateTime(RFC 3339 literal format) of the last updated time range to filter tests. ,
Format: date-time ,
Required: False ,
}
string ,
maxpagesize:
{
Description: Number of results in response. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Test items on this page ,
Required: True ,
}
[
{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: The input artifacts for the test. ,
Required: False ,
}
{
configFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
metricsReferenceIdentityType:
{
Description: Type of the managed identity referencing the metrics. ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
metricsReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the metrics. ,
Required: False ,
}
string ,
engineBuiltInIdentityType:
{
Description: Type of the managed identity built in load test engines ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
engineBuiltInIdentityIds:
{
Description: Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned. ,
Required: False ,
}
[
string ,
]
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: The input artifacts for the test. ,
Required: False ,
}
{
configFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
metricsReferenceIdentityType:
{
Description: Type of the managed identity referencing the metrics. ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
metricsReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the metrics. ,
Required: False ,
}
string ,
engineBuiltInIdentityType:
{
Description: Type of the managed identity built in load test engines ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
engineBuiltInIdentityIds:
{
Description: Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned. ,
Required: False ,
}
[
string ,
]
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /tests/{testId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: The resource instance. ,
Required: True ,
}
{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
metricsReferenceIdentityType:
{
Description: Type of the managed identity referencing the metrics. ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
metricsReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the metrics. ,
Required: False ,
}
string ,
engineBuiltInIdentityType:
{
Description: Type of the managed identity built in load test engines ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
engineBuiltInIdentityIds:
{
Description: Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: The input artifacts for the test. ,
Required: False ,
}
{
configFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
metricsReferenceIdentityType:
{
Description: Type of the managed identity referencing the metrics. ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
metricsReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the metrics. ,
Required: False ,
}
string ,
engineBuiltInIdentityType:
{
Description: Type of the managed identity built in load test engines ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
engineBuiltInIdentityIds:
{
Description: Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned. ,
Required: False ,
}
[
string ,
]
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
passFailCriteria:
{
Description: Pass fail criteria for a test. ,
Required: False ,
}
{
passFailMetrics:
{
Description: Map of id and pass fail metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
passFailServerMetrics:
{
Description: Map of id and pass fail server metrics { id : pass fail metrics }. ,
Required: False ,
}
object ,
}
,
autoStopCriteria:
{
Description: Auto stop criteria for a test. This will automatically stop a load test if the error percentage is high for a certain time window. ,
Required: False ,
}
{
autoStopDisabled:
{
Description: Whether auto-stop should be disabled. The default value is false. ,
Required: False ,
}
boolean ,
errorRate:
{
Description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 ,
Format: float ,
Required: False ,
}
number ,
errorRateTimeWindowInSeconds:
{
Description: Time window during which the error percentage should be evaluated in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
secrets:
{
Description: Secrets can be stored in an Azure Key Vault or any other secret store. If the secret is stored in an Azure Key Vault, the value should be the secret identifier and the type should be AKV_SECRET_URI. If the secret is stored elsewhere, the secret value should be provided directly and the type should be SECRET_VALUE. ,
Required: False ,
}
object ,
certificate:
{
Description: Certificates metadata. ,
Required: False ,
}
{
value:
{
Description: The value of the certificate for respective type ,
Required: False ,
}
string ,
type:
{
Description: Type of certificate ,
Enum:
{
AKV_CERT_URI: If the certificate is stored in an Azure Key Vault. ,
}
,
Required: False ,
}
enum ,
name:
{
Description: Name of the certificate. ,
Required: False ,
}
string ,
}
,
environmentVariables:
{
Description: Environment variables which are defined as a set of pairs. ,
Required: False ,
}
object ,
loadTestConfiguration:
{
Description: The load test configuration. ,
Required: False ,
}
{
engineInstances:
{
Description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. ,
Format: int32 ,
Required: False ,
}
integer ,
splitAllCSVs:
{
Description: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly. ,
Required: False ,
}
boolean ,
quickStartTest:
{
Description: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload. ,
Required: False ,
}
boolean ,
optionalLoadTestConfig:
{
Description: Configuration for quick load test ,
Required: False ,
}
{
endpointUrl:
{
Description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login ,
Required: False ,
}
string ,
requestsPerSecond:
{
Description: Target throughput (requests per second). This may not be necessarily achieved. The actual throughput will be lower if the application is not capable of handling it. ,
Format: int32 ,
Required: False ,
}
integer ,
maxResponseTimeInMs:
{
Description: Maximum response time in milliseconds of the API/endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
virtualUsers:
{
Description: No of concurrent virtual users. ,
Format: int32 ,
Required: False ,
}
integer ,
rampUpTime:
{
Description: Ramp up time in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
duration:
{
Description: Test run duration in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
regionalLoadTestConfig:
{
Description: Region distribution configuration for the load test. ,
Required: False ,
}
[
{
engineInstances:
{
Description: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400. ,
Format: int32 ,
Required: True ,
}
integer ,
region:
{
Description: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command. ,
Required: True ,
}
string ,
}
,
]
,
}
,
baselineTestRunId:
{
Description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs ,
Required: False ,
}
string ,
inputArtifacts:
{
Description: The input artifacts for the test. ,
Required: False ,
}
{
configFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
testScriptFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
userPropFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
inputArtifactsZipFileInfo:
{
Description: File info ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
urlTestConfigFileInfo:
{
Description: The config json file for url based test ,
Required: False ,
}
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
additionalFileInfo:
{
Description: Additional supported files for the test run ,
Required: False ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
}
,
testId:
{
Description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
description:
{
Description: The test description. ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of a test. ,
Required: False ,
}
string ,
subnetId:
{
Description: Subnet ID on which the load test instances should run. ,
Required: False ,
}
string ,
kind:
{
Description: Kind of test. ,
Enum:
{
URL: URL Test ,
JMX: JMX Test ,
Locust: Locust Test ,
}
,
Required: False ,
}
enum ,
publicIPDisabled:
{
Description: Inject load test engines without deploying public IP for outbound access ,
Required: False ,
}
boolean ,
keyvaultReferenceIdentityType:
{
Description: Type of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
keyvaultReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the Key vault. ,
Required: False ,
}
string ,
metricsReferenceIdentityType:
{
Description: Type of the managed identity referencing the metrics. ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
metricsReferenceIdentityId:
{
Description: Resource Id of the managed identity referencing the metrics. ,
Required: False ,
}
string ,
engineBuiltInIdentityType:
{
Description: Type of the managed identity built in load test engines ,
Enum:
{
SystemAssigned: System-assigned managed identity. ,
UserAssigned: User-assigned managed identity. ,
}
,
Required: False ,
}
enum ,
engineBuiltInIdentityIds:
{
Description: Resource Ids of the managed identity built in to load test engines. Required if engineBuiltInIdentityType is UserAssigned. ,
Required: False ,
}
[
string ,
]
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
testId:
{
Description: Test identifier ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /tests/{testId}/app-components
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: App Component model. ,
Required: True ,
}
{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
testId:
{
Description: Test identifier ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
components:
{
Description: Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ,
Required: True ,
}
object ,
testId:
{
Description: Test identifier ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The TestFileInfo items on this page ,
Required: True ,
}
[
{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
LoadTestAdministration_UploadTestFile (new)
Description :  Upload input file for a given test Id. 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 application/octet-stream.
Reference :  Link ¶

⚼ Request

PUT:  /tests/{testId}/files/{fileName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
fileName:
{
Description: Unique name for test file with file extension like : App.jmx ,
Required: True ,
}
string ,
fileType:
{
Description: File type ,
Required: False ,
}
string ,
body:
{
Description: The file content as application/octet-stream. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
fileName:
{
Description: Name of the file. ,
Required: True ,
}
string ,
url:
{
Description: File URL. ,
Format: uri ,
Required: False ,
}
string ,
fileType:
{
Description: File type ,
Enum:
{
JMX_FILE: If the file is a JMX script. ,
USER_PROPERTIES: If the file is a user properties file. ,
ADDITIONAL_ARTIFACTS: If the file is not among any of the other supported file types. ,
ZIPPED_ARTIFACTS: If the file is a compressed archive containing a collection of various artifacts or resources. ,
URL_TEST_CONFIG: If the file is a JSON config file to define the requests for a URL test. ,
TEST_SCRIPT: If the file is a test script. ,
}
,
Required: False ,
}
enum ,
expireDateTime:
{
Description: Expiry time of the file (RFC 3339 literal format) ,
Format: date-time ,
Required: False ,
}
string ,
validationStatus:
{
Description: Validation status of the file ,
Enum:
{
NOT_VALIDATED: File is not validated. ,
VALIDATION_SUCCESS: File is validated. ,
VALIDATION_FAILURE: File validation is failed. ,
VALIDATION_INITIATED: File validation is in progress. ,
VALIDATION_NOT_REQUIRED: Validation is not required. ,
}
,
Required: False ,
}
enum ,
validationFailureDetails:
{
Description: Validation failure error details ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (204)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

{
testId:
{
Description: Test identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: True ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /tests/{testId}/server-metrics-config
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testId:
{
Description: Unique name for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. ,
Required: True ,
}
string ,
body:
{
Description: Server metric configuration model. ,
Required: True ,
}
{
metrics:
{
Description: Azure resource metrics collection {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)

{
testId:
{
Description: Test identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: True ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
testId:
{
Description: Test identifier ,
Required: False ,
}
string ,
metrics:
{
Description: Azure resource metrics collection {metric id : metrics object} (Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition for metric id). ,
Required: True ,
}
object ,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /triggers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
testIds:
{
Description: Search based on triggers associated with the provided test ids. ,
Required: False ,
}
string ,
states:
{
Description: Filter triggers based on a comma separated list of states. ,
Required: False ,
}
string ,
lastModifiedStartTime:
{
Description: Start DateTime(RFC 3339 literal format) of the last updated time range to filter triggers. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedEndTime:
{
Description: End DateTime(RFC 3339 literal format) of the last updated time range to filter triggers. ,
Format: date-time ,
Required: False ,
}
string ,
maxpagesize:
{
Description: Number of results in response. Default page size is 50. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Trigger items on this page ,
Required: True ,
}
[
{
triggerId:
{
Description: The unique identifier of the trigger. ,
Required: True ,
}
string ,
displayName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
description:
{
Description: The description of the trigger. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the trigger. ,
Enum:
{
ScheduleTestsTrigger: Trigger is a Scheduled Trigger on a Test. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: The current state of the trigger. ,
Enum:
{
Active: The trigger is active. ,
Paused: The trigger is paused manually. ,
Completed: The trigger is completed. ,
Disabled: The trigger is disabled due to error. ,
}
,
Required: False ,
}
enum ,
stateDetails:
{
Description: Details of current state of the trigger. ,
Required: False ,
}
{
message:
{
Description: The error message if the trigger is in disabled state. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

GET:  /triggers/{triggerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
triggerId:
{
Description: The unique identifier of the trigger. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
triggerId:
{
Description: The unique identifier of the trigger. ,
Required: True ,
}
string ,
displayName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
description:
{
Description: The description of the trigger. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the trigger. ,
Enum:
{
ScheduleTestsTrigger: Trigger is a Scheduled Trigger on a Test. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: The current state of the trigger. ,
Enum:
{
Active: The trigger is active. ,
Paused: The trigger is paused manually. ,
Completed: The trigger is completed. ,
Disabled: The trigger is disabled due to error. ,
}
,
Required: False ,
}
enum ,
stateDetails:
{
Description: Details of current state of the trigger. ,
Required: False ,
}
{
message:
{
Description: The error message if the trigger is in disabled state. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

PATCH:  /triggers/{triggerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
triggerId:
{
Description: The unique identifier of the trigger. ,
Required: True ,
}
string ,
body:
{
Description: The resource instance. ,
Required: True ,
}
{
displayName:
{
Description: The name of the trigger. ,
Required: False ,
}
string ,
description:
{
Description: The description of the trigger. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the trigger. ,
Enum:
{
ScheduleTestsTrigger: Trigger is a Scheduled Trigger on a Test. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: The current state of the trigger. ,
Enum:
{
Active: The trigger is active. ,
Paused: The trigger is paused manually. ,
Completed: The trigger is completed. ,
Disabled: The trigger is disabled due to error. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
triggerId:
{
Description: The unique identifier of the trigger. ,
Required: True ,
}
string ,
displayName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
description:
{
Description: The description of the trigger. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the trigger. ,
Enum:
{
ScheduleTestsTrigger: Trigger is a Scheduled Trigger on a Test. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: The current state of the trigger. ,
Enum:
{
Active: The trigger is active. ,
Paused: The trigger is paused manually. ,
Completed: The trigger is completed. ,
Disabled: The trigger is disabled due to error. ,
}
,
Required: False ,
}
enum ,
stateDetails:
{
Description: Details of current state of the trigger. ,
Required: False ,
}
{
message:
{
Description: The error message if the trigger is in disabled state. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
triggerId:
{
Description: The unique identifier of the trigger. ,
Required: True ,
}
string ,
displayName:
{
Description: The name of the trigger. ,
Required: True ,
}
string ,
description:
{
Description: The description of the trigger. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the trigger. ,
Enum:
{
ScheduleTestsTrigger: Trigger is a Scheduled Trigger on a Test. ,
}
,
Required: True ,
}
enum ,
state:
{
Description: The current state of the trigger. ,
Enum:
{
Active: The trigger is active. ,
Paused: The trigger is paused manually. ,
Completed: The trigger is completed. ,
Disabled: The trigger is disabled due to error. ,
}
,
Required: False ,
}
enum ,
stateDetails:
{
Description: Details of current state of the trigger. ,
Required: False ,
}
{
message:
{
Description: The error message if the trigger is in disabled state. ,
Required: False ,
}
string ,
}
,
createdDateTime:
{
Description: The creation datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: The user that created. ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: The last Modified datetime(RFC 3339 literal format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The user that last modified. ,
Required: False ,
}
string ,
}

⚐ Response (default)

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

⚼ Request

DELETE:  /triggers/{triggerId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
triggerId:
{
Description: The unique identifier of the trigger. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

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