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

2025/01/24 • 2 updated methods

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

⚶ Changes

{
  "#id": "TestProfileRunAdministration_ListTestProfileRuns",
  "$parameters": [
    {
      "#name": "testProfileRunIds",
      "Type": {
        "new": "array",
        "old": "string"
      }
    },
    {
      "#name": "testProfileIds",
      "Type": {
        "new": "array",
        "old": "string"
      }
    },
    {
      "#name": "statuses",
      "Type": {
        "new": "array",
        "old": "string"
      }
    }
  ]
}

⚼ 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 ,
}
array ,
testProfileIds:
{
Description: Comma separated IDs of the test profiles which should be associated with the test profile runs to fetch. ,
Required: False ,
}
array ,
statuses:
{
Description: Comma separated list of Statuses of the test profile runs to filter. ,
Required: False ,
}
array ,
}

⚐ 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 ,
}
,
}
,
}
,
}
TestProfileAdministration_ListTestProfiles (updated)
Description :  Get all test profiles for the given filters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TestProfileAdministration_ListTestProfiles",
  "$parameters": [
    {
      "#name": "testProfileIds",
      "Type": {
        "new": "array",
        "old": "string"
      }
    }
  ]
}

⚼ 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 ,
}
array ,
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 ,
}
,
}
,
}
,
}