Microsoft.LoadTestService (preview:2023-04-01)

2025/03/12 • 7 updated methods

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

⚶ Changes

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

⚼ Request

GET:  /test-runs
{
api-version: string ,
orderby: string ,
search: string ,
testId: string ,
executionFrom: string ,
executionTo: string ,
status: string ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
testRunId: string ,
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
errorDetails:
[
{
message: string ,
}
,
]
,
testRunStatistics: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
testArtifacts:
{
inputArtifacts:
{
configFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
testScriptFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
userPropFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
inputArtifactsZipFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
urlTestConfigFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
additionalFileInfo:
[
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
]
,
}
,
outputArtifacts:
{
resultFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
logsFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
artifactsContainerInfo:
{
url: string ,
expireDateTime: string ,
}
,
}
,
}
,
testResult: enum ,
virtualUsers: integer ,
displayName: string ,
testId: string ,
description: string ,
status: enum ,
startDateTime: string ,
endDateTime: string ,
executedDateTime: string ,
portalUrl: string ,
duration: integer ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
createdDateTime: string ,
createdBy: string ,
lastModifiedDateTime: string ,
lastModifiedBy: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
LoadTestRun_GetTestRun (updated)
Description Get test run details by test run Id.
Reference Link ¶

⚶ Changes

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

⚼ Request

GET:  /test-runs/{testRunId}
{
api-version: string ,
testRunId: string ,
}

⚐ Response (200)

{
testRunId: string ,
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
errorDetails:
[
{
message: string ,
}
,
]
,
testRunStatistics: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
testArtifacts:
{
inputArtifacts:
{
configFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
testScriptFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
userPropFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
inputArtifactsZipFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
urlTestConfigFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
additionalFileInfo:
[
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
]
,
}
,
outputArtifacts:
{
resultFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
logsFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
artifactsContainerInfo:
{
url: string ,
expireDateTime: string ,
}
,
}
,
}
,
testResult: enum ,
virtualUsers: integer ,
displayName: string ,
testId: string ,
description: string ,
status: enum ,
startDateTime: string ,
endDateTime: string ,
executedDateTime: string ,
portalUrl: string ,
duration: integer ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
createdDateTime: string ,
createdBy: string ,
lastModifiedDateTime: string ,
lastModifiedBy: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
LoadTestRun_CreateOrUpdateTestRun (updated)
Description Create and start a new test run with the given test run Id.
Reference Link ¶

⚶ Changes

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

⚼ Request

PATCH:  /test-runs/{testRunId}
{
api-version: string ,
testRunId: string ,
oldTestRunId: string ,
body:
{
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
displayName: string ,
testId: string ,
description: string ,
}
,
}

⚐ Response (200)

{
testRunId: string ,
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
errorDetails:
[
{
message: string ,
}
,
]
,
testRunStatistics: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
testArtifacts:
{
inputArtifacts:
{
configFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
testScriptFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
userPropFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
inputArtifactsZipFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
urlTestConfigFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
additionalFileInfo:
[
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
]
,
}
,
outputArtifacts:
{
resultFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
logsFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
artifactsContainerInfo:
{
url: string ,
expireDateTime: string ,
}
,
}
,
}
,
testResult: enum ,
virtualUsers: integer ,
displayName: string ,
testId: string ,
description: string ,
status: enum ,
startDateTime: string ,
endDateTime: string ,
executedDateTime: string ,
portalUrl: string ,
duration: integer ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
createdDateTime: string ,
createdBy: string ,
lastModifiedDateTime: string ,
lastModifiedBy: string ,
}

⚐ Response (201)

{
testRunId: string ,
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
errorDetails:
[
{
message: string ,
}
,
]
,
testRunStatistics: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
testArtifacts:
{
inputArtifacts:
{
configFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
testScriptFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
userPropFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
inputArtifactsZipFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
urlTestConfigFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
additionalFileInfo:
[
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
]
,
}
,
outputArtifacts:
{
resultFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
logsFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
artifactsContainerInfo:
{
url: string ,
expireDateTime: string ,
}
,
}
,
}
,
testResult: enum ,
virtualUsers: integer ,
displayName: string ,
testId: string ,
description: string ,
status: enum ,
startDateTime: string ,
endDateTime: string ,
executedDateTime: string ,
portalUrl: string ,
duration: integer ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
createdDateTime: string ,
createdBy: string ,
lastModifiedDateTime: string ,
lastModifiedBy: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
LoadTestRun_StopTestRun (updated)
Description Stop test run by test run Id.
Reference Link ¶

⚶ Changes

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

⚼ Request

POST:  /test-runs/{testRunId}:stop
{
api-version: string ,
testRunId: string ,
}

⚐ Response (200)

{
testRunId: string ,
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
errorDetails:
[
{
message: string ,
}
,
]
,
testRunStatistics: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
testArtifacts:
{
inputArtifacts:
{
configFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
testScriptFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
userPropFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
inputArtifactsZipFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
urlTestConfigFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
additionalFileInfo:
[
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
]
,
}
,
outputArtifacts:
{
resultFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
logsFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
artifactsContainerInfo:
{
url: string ,
expireDateTime: string ,
}
,
}
,
}
,
testResult: enum ,
virtualUsers: integer ,
displayName: string ,
testId: string ,
description: string ,
status: enum ,
startDateTime: string ,
endDateTime: string ,
executedDateTime: string ,
portalUrl: string ,
duration: integer ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
createdDateTime: string ,
createdBy: string ,
lastModifiedDateTime: string ,
lastModifiedBy: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
LoadTestAdministration_ListTests (updated)
Description Get all load tests by the fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
Reference Link ¶

⚶ Changes

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

⚼ Request

GET:  /tests
{
api-version: string ,
orderby: string ,
search: string ,
lastModifiedStartTime: string ,
lastModifiedEndTime: string ,
maxpagesize: integer ,
}

⚐ Response (200)

{
value:
[
{
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
baselineTestRunId: string ,
inputArtifacts:
{
configFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
testScriptFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
userPropFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
inputArtifactsZipFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
urlTestConfigFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
additionalFileInfo:
[
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
]
,
}
,
testId: string ,
description: string ,
displayName: string ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
keyvaultReferenceIdentityType: string ,
keyvaultReferenceIdentityId: string ,
createdDateTime: string ,
createdBy: string ,
lastModifiedDateTime: string ,
lastModifiedBy: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
LoadTestAdministration_GetTest (updated)
Description Get load test details by test Id
Reference Link ¶

⚶ Changes

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

⚼ Request

GET:  /tests/{testId}
{
api-version: string ,
testId: string ,
}

⚐ Response (200)

{
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
baselineTestRunId: string ,
inputArtifacts:
{
configFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
testScriptFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
userPropFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
inputArtifactsZipFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
urlTestConfigFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
additionalFileInfo:
[
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
]
,
}
,
testId: string ,
description: string ,
displayName: string ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
keyvaultReferenceIdentityType: string ,
keyvaultReferenceIdentityId: string ,
createdDateTime: string ,
createdBy: string ,
lastModifiedDateTime: string ,
lastModifiedBy: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}
LoadTestAdministration_CreateOrUpdateTest (updated)
Description Create a new test or update an existing test by providing the test Id.
Reference Link ¶

⚶ Changes

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

⚼ Request

PATCH:  /tests/{testId}
{
api-version: string ,
testId: string ,
body:
{
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
baselineTestRunId: string ,
description: string ,
displayName: string ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
keyvaultReferenceIdentityType: string ,
keyvaultReferenceIdentityId: string ,
}
,
}

⚐ Response (200)

{
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
baselineTestRunId: string ,
inputArtifacts:
{
configFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
testScriptFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
userPropFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
inputArtifactsZipFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
urlTestConfigFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
additionalFileInfo:
[
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
]
,
}
,
testId: string ,
description: string ,
displayName: string ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
keyvaultReferenceIdentityType: string ,
keyvaultReferenceIdentityId: string ,
createdDateTime: string ,
createdBy: string ,
lastModifiedDateTime: string ,
lastModifiedBy: string ,
}

⚐ Response (201)

{
passFailCriteria:
{
passFailMetrics: object ,
}
,
autoStopCriteria:
{
autoStopDisabled: boolean ,
errorRate: number ,
errorRateTimeWindowInSeconds: integer ,
}
,
secrets: object ,
certificate:
{
value: string ,
type: enum ,
name: string ,
}
,
environmentVariables: object ,
loadTestConfiguration:
{
engineInstances: integer ,
splitAllCSVs: boolean ,
quickStartTest: boolean ,
optionalLoadTestConfig:
{
endpointUrl: string ,
requestsPerSecond: integer ,
maxResponseTimeInMs: integer ,
virtualUsers: integer ,
rampUpTime: integer ,
duration: integer ,
}
,
}
,
baselineTestRunId: string ,
inputArtifacts:
{
configFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
testScriptFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
userPropFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
inputArtifactsZipFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
urlTestConfigFileInfo:
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
additionalFileInfo:
[
{
fileName: string ,
url: string ,
fileType: enum ,
expireDateTime: string ,
validationStatus: enum ,
validationFailureDetails: string ,
}
,
]
,
}
,
testId: string ,
description: string ,
displayName: string ,
subnetId: string ,
kind: enum ,
publicIPDisabled: boolean ,
keyvaultReferenceIdentityType: string ,
keyvaultReferenceIdentityId: string ,
createdDateTime: string ,
createdBy: string ,
lastModifiedDateTime: string ,
lastModifiedBy: string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code: string ,
}
,
$schema:
{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
innererror:
{
code: string ,
innererror: string ,
}
,
}
,
}
,
}