swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector TestRun API schemes: - https tags: - name: TestRun paths: /test-runs: get: operationId: microsoftAzureLoadtestrunListtestruns tags: - TestRun summary: Microsoft Azure Get All Test Runs For The Given Filters description: Get all test runs for the given filters. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - $ref: '#/parameters/ListTestRunQueryParams.orderby' - $ref: '#/parameters/ListTestRunQueryParams.search' - $ref: '#/parameters/ListTestRunQueryParams.testId' - $ref: '#/parameters/ListTestRunQueryParams.executionFrom' - $ref: '#/parameters/ListTestRunQueryParams.executionTo' - $ref: '#/parameters/ListTestRunQueryParams.status' - $ref: '#/parameters/ListTestRunQueryParams.maxpagesize' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/PagedTestRun' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List test runs.: $ref: ./examples/ListTestRuns.json x-ms-pageable: nextLinkName: nextLink /test-runs/{testRunId}: get: operationId: microsoftAzureLoadtestrunGettestrun tags: - TestRun summary: Microsoft Azure Get Test Run Details By Test Run Id description: Get test run details by test run Id. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/TestRun' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Get a load test run.: $ref: ./examples/GetTestRun.json patch: operationId: microsoftAzureLoadtestrunCreateorupdatetestrun tags: - TestRun summary: Microsoft Azure Create And Start A New Test Run With The Given Test Run Id description: Create and start a new test run with the given test run Id. consumes: - application/merge-patch+json parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ - $ref: '#/parameters/OldTestRunIdQueryParam' - name: body in: body description: The resource instance. required: true schema: $ref: '#/definitions/TestRunCreateOrUpdate' x-ms-client-name: resource responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/TestRun' '201': description: The request has succeeded and a new resource has been created as a result. schema: $ref: '#/definitions/TestRun' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Create/update and start a load test run: $ref: ./examples/CreateOrUpdateTestRun.json delete: operationId: microsoftAzureLoadtestrunDeletetestrun tags: - TestRun summary: Microsoft Azure Delete An Existing Load Test Run description: Delete an existing load test run by providing the testRunId. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ responses: '204': description: 'There is no content to send for this request, but the headers may be useful. ' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Delete a load test run: $ref: ./examples/DeleteTestRun.json /test-runs/{testRunId}:stop: post: operationId: microsoftAzureLoadtestrunStoptestrun tags: - TestRun summary: Microsoft Azure Stop Test Run By Test Run Id description: Stop test run by test run Id. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/TestRun' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Stop test run by name.: $ref: ./examples/StopTestRun.json /test-runs/{testRunId}/app-components: get: operationId: microsoftAzureLoadtestrunGetappcomponents tags: - TestRun summary: 'Microsoft Azure Get Associated App Component Collection Of Azure Resources For The Given Test run' description: Get associated app component (collection of azure resources) for the given test
run. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: 'Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.' required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/TestRunAppComponents' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Get associated app component for the given test run.: $ref: ./examples/ListTestRunAppComponents.json patch: operationId: microsoftAzureLoadtestrunCreateorupdateappcomponents tags: - TestRun summary: Microsoft Azure Add An App Component To A Test Run description: Add an app component to a test run by providing the resource Id, name and type. consumes: - application/merge-patch+json parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: 'Unique Id for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.' required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ - name: body in: body description: App Component model. required: true schema: $ref: '#/definitions/TestRunAppComponentsUpdate' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/TestRunAppComponents' '201': description: The request has succeeded and a new resource has been created as a result. schema: $ref: '#/definitions/TestRunAppComponents' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Add or update app components to a load test run: $ref: ./examples/CreateOrUpdateTestRunAppComponents.json /test-runs/{testRunId}/files/{fileName}: get: operationId: microsoftAzureLoadtestrunGettestrunfile tags: - TestRun summary: Microsoft Azure Get Test Run File By File Name description: Get test run file by file name. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ - name: fileName in: path description: Name of the file. required: true type: string responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/TestRunFileInfo' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Get a file associated to a load test run.: $ref: ./examples/GetTestRunFile.json /test-runs/{testRunId}/metric-definitions: get: operationId: microsoftAzureLoadtestrunListmetricdefinitions tags: - TestRun summary: Microsoft Azure List The Metric Definitions For A Load Test Run description: List the metric definitions for a load test run. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: 'Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.' required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ - name: metricNamespace in: query description: Metric namespace to query metric definitions for. required: true type: string responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/MetricDefinitionCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List the metric definitions for a load test run.: $ref: ./examples/ListTestRunMetricsDefinitions.json /test-runs/{testRunId}/metric-dimensions/{name}/values: get: operationId: microsoftAzureLoadtestrunListmetricdimensionvalues tags: - TestRun summary: Microsoft Azure List The Dimension Values For The Given Metric Dimension Name description: List the dimension values for the given metric dimension name. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: 'Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.' required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ - name: name in: path description: Dimension name required: true type: string - $ref: '#/parameters/MetricDimensionsRequest.metricname' - $ref: '#/parameters/MetricDimensionsRequest.interval' - $ref: '#/parameters/MetricDimensionsRequest.metricNamespace' - $ref: '#/parameters/MetricDimensionsRequest.timespan' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/DimensionValueList' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List the dimension values for the given metric dimension name.: $ref: ./examples/ListMetricDimensionValues.json /test-runs/{testRunId}/metric-namespaces: get: operationId: microsoftAzureLoadtestrunListmetricnamespaces tags: - TestRun summary: Microsoft Azure List The Metric Namespaces For A Load Test Run description: List the metric namespaces for a load test run. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: 'Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.' required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/MetricNamespaceCollection' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List the metric namespaces for a load test run.: $ref: ./examples/ListTestRunMetricsNamespaces.json /test-runs/{testRunId}/metrics: post: operationId: microsoftAzureLoadtestrunListmetrics tags: - TestRun summary: Microsoft Azure List The Metric Values For A Load Test Run description: List the metric values for a load test run. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: 'Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.' required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ - name: aggregation in: query description: The aggregation required: false type: string - $ref: '#/parameters/MetricDimensionsRequest.metricname' - $ref: '#/parameters/MetricDimensionsRequest.interval' - $ref: '#/parameters/MetricDimensionsRequest.metricNamespace' - $ref: '#/parameters/MetricDimensionsRequest.timespan' - name: body in: body description: 'Metric dimension filter ' required: false schema: $ref: '#/definitions/MetricRequestPayload' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/Metrics' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List the metric values for a load test run.: $ref: ./examples/ListTestRunMetrics.json x-ms-pageable: nextLinkName: nextLink /test-runs/{testRunId}/server-metrics-config: get: operationId: microsoftAzureLoadtestrunGetservermetricsconfig tags: - TestRun summary: Microsoft Azure Get Associated Server Metrics Configuration For The Given Test Run description: Get associated server metrics configuration for the given test run. parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: 'Unique name for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.' required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/TestRunServerMetricConfig' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: List server metrics configuration for the given test run.: $ref: ./examples/ListTestRunServerMetricsConfig.json patch: operationId: microsoftAzureLoadtestrunCreateorupdateservermetricsconfig tags: - TestRun summary: Microsoft Azure Configure Server Metrics For A Test Run description: Configure server metrics for a test run consumes: - application/merge-patch+json parameters: - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter' - name: testRunId in: path description: 'Unique Id for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.' required: true type: string minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ - name: body in: body description: Server metric configuration model. required: true schema: $ref: '#/definitions/TestRunServerMetricConfig' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/TestRunServerMetricConfig' '201': description: The request has succeeded and a new resource has been created as a result. schema: $ref: '#/definitions/TestRunServerMetricConfig' default: description: An unexpected error response. schema: $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse' headers: x-ms-error-code: type: string description: String error code indicating what went wrong. x-ms-examples: Add or update server metrics configuration for a load test run: $ref: ./examples/CreateOrUpdateTestRunServerMetricsConfig.json /testruns/{testRunId}: delete: tags: - TestRun summary: Microsoft Azure Delete A Test Run With Given Name Test Run Name Must Be A Valid Url Character ^[a Z0 9 ]*$ operationId: microsoftAzureTestrunDeletetestrun produces: - application/json parameters: - in: path name: testRunId description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: api-version description: Api version required: true type: string responses: '204': description: The test run is deleted default: description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestRunId\", \"testRunId field is required\"\n\n* \"400\", \"InvalidTestRunId\", \"testRunId field should be valid\"\n\n * \"404\", \"TestRunNotFound\", \"test run not found with given identifier\"\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: TestRun_DeleteTestRun_MaximumSet_Gen: $ref: ./examples/TestRun_DeleteTestRun_MaximumSet_Gen.json TestRun_DeleteTestRun_MinimumSet_Gen: $ref: ./examples/TestRun_DeleteTestRun_MinimumSet_Gen.json description: Needs a more full description created. patch: tags: - TestRun summary: Microsoft Azure Create And Start New Test Run Of The Given Name, Test Run Name Must Be A Valid Url Character ^[a Z0 9 ]*$ operationId: microsoftAzureTestrunCreateandupdatetest consumes: - application/merge-patch+json produces: - application/json parameters: - in: path name: testRunId description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: oldTestRunId description: Existing testRunId to re run new test type: string - in: query name: api-version description: Api version required: true type: string - in: body name: body description: Load test run model required: true schema: $ref: '#/definitions/TestRunModel' responses: '200': description: The test run is updated schema: $ref: '#/definitions/TestRunModel' default: description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestRunId\", \"testRunId field is required\"\n\n * \"400\", \"InvalidTestRunId\", \"testRunId field should be valid\"\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\" * \"400\", \"ResourceMetadataNotFound\", \"Resource metadata not found\"\n\n * \"400\", \"ManagedIdentityNotEnabled\", \"Managed identity is not enabled over resource\"\n\n * \"400\", \"SecretNotFound\", \"Unable to find the given secret\"\n\n " schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: TestRun_CreateAndUpdateTest_MaximumSet_Gen: $ref: ./examples/TestRun_CreateAndUpdateTest_MaximumSet_Gen.json TestRun_CreateAndUpdateTest_MinimumSet_Gen: $ref: ./examples/TestRun_CreateAndUpdateTest_MinimumSet_Gen.json description: Needs a more full description created. get: tags: - TestRun summary: Microsoft Azure Get Test Run Of Given Name operationId: microsoftAzureTestrunGettestrun produces: - application/json parameters: - in: path name: testRunId description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: api-version description: Api version required: true type: string responses: '200': description: The requested test run schema: $ref: '#/definitions/TestRunModel' default: description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestRunId\", \"testRunId field is required\"\n\n * \"400\", \"InvalidTestRunId\", \"testRunId field should be valid\"\n\n * \"404\", \"TestRunNotFound\", \"test run not found with given identifier\"\n\n* \"500\", \"InternalServerError\", \"Unable to process the request, please retry\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: TestRun_GetTestRun_MaximumSet_Gen: $ref: ./examples/TestRun_GetTestRun_MaximumSet_Gen.json TestRun_GetTestRun_MinimumSet_Gen: $ref: ./examples/TestRun_GetTestRun_MinimumSet_Gen.json description: Needs a more full description created. /testruns/{testRunId}/files/{fileId}: get: tags: - TestRun summary: Microsoft Azure Get Testrun File With Given File Name operationId: microsoftAzureTestrunGettestrunfile produces: - application/json parameters: - in: path name: testRunId description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: path name: fileId description: Unique identifier for test run file, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: api-version description: Api version required: true type: string responses: '200': description: The requested testrun file url schema: $ref: '#/definitions/FileUrlPath' default: description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestRunId\", \"testRunId field is required\"\n\n* \"400\", \"InvalidTestRunId\", \"testRunId field should be valid\"\n\n * \"400\", \"RequiredFileId\", \"fileId field is required\"\n\n * \"400\", \"InvalidFileId\", \"fileId field is not valid\" \n\n * \"404\", \"TestRunNotFound\", \"test run not found with given identifier\"\n\n * \"404\", \"TestRunFileNotFound\", \"test run file not found\"\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: TestRun_GetTestRunFile_MaximumSet_Gen: $ref: ./examples/TestRun_GetTestRunFile_MaximumSet_Gen.json TestRun_GetTestRunFile_MinimumSet_Gen: $ref: ./examples/TestRun_GetTestRunFile_MinimumSet_Gen.json description: Needs a more full description created. /testruns/sortAndFilter: get: tags: - TestRun summary: Microsoft Azure Get All Test Runs With Given Filters operationId: microsoftAzureTestrunGetapptestrunssearch produces: - application/json parameters: - in: query name: orderBy description: 'Sort on one of the field - status, displayName, executedDateTime in (field asc/desc) format. eg: displayName asc' type: string - in: query name: nextLink description: NextLink Token to get next page of response type: string - in: query name: search description: Filter search based on searchable fields - description, executedUser. type: string - in: query name: testId description: Unique identifier for load test name, must be a valid URL character ^[a-z0-9_-]*$ type: string pattern: ^[a-z0-9_-]*$ - in: query name: executionFrom description: The end DateTime(Iso8601Literal format) of test-run execution time filter range. type: string format: date-time - in: query name: executionTo description: The start DateTime(Iso8601Literal format) of test-run execution time filter range. type: string format: date-time - in: query name: status description: 'Comma separated list of test run status, value can be - "ACCEPTED", "NOTSTARTED","PROVISIONING","PROVISIONED","CONFIGURING", "CONFIGURED","EXECUTING","EXECUTED","DEPROVISIONING","DEPROVISIONED","DONE","CANCELLED","FAILED"' type: string - in: query name: maxPageSize description: No of results in response type: integer format: int32 default: 50 - in: query name: api-version description: Api version required: true type: string responses: '200': description: The requested test runs schema: $ref: '#/definitions/TestRunModelResourceList' default: description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"404\", \"TestRunNotFound\", \"test run not found with given identifier\"\n\n* \"500\", \"InternalServerError\", \"Unable to process the request, please retry\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: TestRun_GetAppTestRunsSearch_MaximumSet_Gen: $ref: ./examples/TestRun_GetAppTestRunsSearch_MaximumSet_Gen.json TestRun_GetAppTestRunsSearch_MinimumSet_Gen: $ref: ./examples/TestRun_GetAppTestRunsSearch_MinimumSet_Gen.json description: Needs a more full description created. /testruns/{testRunId}:stop: post: tags: - TestRun summary: Microsoft Azure Stop Test Run Of Given Name operationId: microsoftAzureTestrunStoptestrun produces: - application/json parameters: - in: path name: testRunId description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: api-version description: Api version required: true type: string responses: '200': description: The requested test run is stopped. Call GET /testruns/{testRunId} to check the status schema: $ref: '#/definitions/TestRunModel' default: description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n* \"400\", \"TestRunAlreadyFinished\", \"Test run was already either finished or cancelled or failed\"\n\n* \"400\", \"RequiredTestRunId\", \"testRunId field is required\"\n\n * \"400\", \"InvalidTestRunId\", \"testRunId field should be valid\"\n\n * \"404\", \"TestRunNotFound\", \"test run not found with given identifier\"\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: TestRun_StopTestRun_MaximumSet_Gen: $ref: ./examples/TestRun_StopTestRun_MaximumSet_Gen.json TestRun_StopTestRun_MinimumSet_Gen: $ref: ./examples/TestRun_StopTestRun_MinimumSet_Gen.json description: Needs a more full description created. /testruns/{testRunId}/clientMetrics: get: tags: - TestRun summary: Microsoft Azure Get All Client Metrics For A Given Load Test Run operationId: microsoftAzureTestrunGettestrunclientmetrics produces: - application/json parameters: - in: path name: testRunId description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: filter description: 'Filter to be used in metrics queries, filters can be applied on following fields : request, error, percentile( possible values : 90, 99, 95) or time (can be between start and end time). Request and error filter values can be get from /clientMetricsFilter API. Example of filter : (request eq ''HTTP Request1'' or request eq ''total-4bec6d5b-c3c3-4f5f-be09-5c4abb28aedd'') and (error eq ''Non HTTP response code: org.apache.http.conn.ConnectTimeoutException'' or error eq ''total-4bec6d5b-c3c3-4f5f-be09-5c4abb28aedd'') and (percentile eq 90) and (time ge 1626346535054 and time le 1626346924744)' type: string - in: query name: groupByInterval description: Group by time interval, in which interval metrics needs to be retrieved, values can be 10s,20s,30s,1m,2m,5m,1h type: string - in: query name: api-version description: Api version required: true type: string responses: '200': description: The requested client metrics schema: $ref: '#/definitions/ClientMetricsResults' default: description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestRunId\", \"testRunId field is required\"\n\n * \"400\", \"InvalidTestRunId\", \"testRunId field should be valid\"\n\n * \"404\", \"TestRunNotFound\", \"test run not found with given identifier\"\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: TestRun_GetTestRunClientMetrics_MaximumSet_Gen: $ref: ./examples/TestRun_GetTestRunClientMetrics_MaximumSet_Gen.json TestRun_GetTestRunClientMetrics_MinimumSet_Gen: $ref: ./examples/TestRun_GetTestRunClientMetrics_MinimumSet_Gen.json description: Needs a more full description created. /testruns/{testRunId}/clientMetricsFilters: get: tags: - TestRun summary: Microsoft Azure Get All Client Metrics Supported Filters List For A Given Load Test Run operationId: microsoftAzureTestrunGettestrunclientmetricsfilters produces: - application/json parameters: - in: path name: testRunId description: Unique identifier for load test run name, must be a valid URL character ^[a-z0-9_-]*$ required: true type: string maxLength: 50 minLength: 2 pattern: ^[a-z0-9_-]*$ - in: query name: api-version description: Api version required: true type: string responses: '200': description: The requested client metrics filters schema: $ref: '#/definitions/ClientMetricsFilters' default: description: "***Error Responses: ***\n\n* \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"InvalidTestRunId\", \"testRunId field should be valid\"\n\n * \"400\", \"RequiredTestRunId\", \"testRunId field is required\" * \"404\", \"TestRunNotFound\", \"test run not found with given identifier\"\n\n * \"500\", \"InternalServerError\", \"Unable to process the request, please retry\"" schema: $ref: '#/definitions/DefaultErrorResponseBody' headers: x-ms-error-code: description: The error code for specific error that occurred. type: string x-ms-examples: TestRun_GetTestRunClientMetricsFilters_MaximumSet_Gen: $ref: ./examples/TestRun_GetTestRunClientMetricsFilters_MaximumSet_Gen.json TestRun_GetTestRunClientMetricsFilters_MinimumSet_Gen: $ref: ./examples/TestRun_GetTestRunClientMetricsFilters_MinimumSet_Gen.json description: Needs a more full description created. definitions: TimeRange: type: object properties: startTime: format: date-time description: start DateTime(Iso8601Literal format) for the requested client metrics filter type: string endTime: format: date-time description: end DateTime(Iso8601Literal format) for the requested client metrics filter type: string Azure.Core.Foundations.Error: type: object description: The error object. properties: code: type: string description: One of a server-defined set of error codes. message: type: string description: A human-readable representation of the error. target: type: string description: The target of the error. details: type: array description: An array of details about specific errors that led to this reported error. items: $ref: '#/definitions/Azure.Core.Foundations.Error' x-ms-identifiers: [] innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: An object containing more specific information than the current object about the error. required: - code - message TestRun: type: object description: Load test run model properties: testRunId: type: string description: Unique test run identifier for the load test run, must contain only lower-case alphabetic, numeric, underscore or hyphen characters. minLength: 2 maxLength: 50 pattern: ^[a-z0-9_-]*$ readOnly: true passFailCriteria: $ref: '#/definitions/PassFailCriteria' description: Pass fail criteria for a test. autoStopCriteria: $ref: '#/definitions/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. secrets: type: object 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.' additionalProperties: $ref: '#/definitions/Secret' certificate: $ref: '#/definitions/CertificateMetadata' description: Certificates metadata environmentVariables: type: object description: Environment variables which are defined as a set of pairs. additionalProperties: type: string errorDetails: type: array description: Error details if there is any failure in load test run items: $ref: '#/definitions/ErrorDetails' readOnly: true x-ms-identifiers: [] testRunStatistics: type: object description: Test run statistics. additionalProperties: $ref: '#/definitions/TestRunStatistics' readOnly: true loadTestConfiguration: $ref: '#/definitions/LoadTestConfiguration' description: The load test configuration. testArtifacts: $ref: '#/definitions/TestRunArtifacts' description: Collection of test run artifacts readOnly: true testResult: $ref: '#/definitions/PFTestResult' description: Test result for pass/Fail criteria used during the test run. readOnly: true virtualUsers: type: integer format: int32 description: Number of virtual users, for which test has been run. readOnly: true displayName: type: string description: Display name of a testRun. minLength: 2 maxLength: 50 testId: type: string description: Associated test Id. minLength: 2 maxLength: 50 description: type: string description: The test run description. maxLength: 100 status: $ref: '#/definitions/Status' description: The test run status. readOnly: true startDateTime: type: string format: date-time description: The test run start DateTime(RFC 3339 literal format). readOnly: true endDateTime: type: string format: date-time description: The test run end DateTime(RFC 3339 literal format). readOnly: true executedDateTime: type: string format: date-time description: Test run initiated time. readOnly: true portalUrl: type: string description: Portal url. readOnly: true duration: type: integer format: int64 description: Test run duration in milliseconds. readOnly: true subnetId: type: string description: Subnet ID on which the load test instances should run. readOnly: true kind: $ref: '#/definitions/TestKind' description: Type of test. readOnly: true publicIPDisabled: type: boolean description: Inject load test engines without deploying public IP for outbound access readOnly: true createdDateTime: type: string format: date-time description: The creation datetime(RFC 3339 literal format). readOnly: true createdBy: type: string description: The user that created. readOnly: true lastModifiedDateTime: type: string format: date-time description: The last Modified datetime(RFC 3339 literal format). readOnly: true lastModifiedBy: type: string description: The user that last modified. readOnly: true required: - testRunId Azure.Core.Foundations.ErrorResponse: type: object description: A response containing error details. properties: error: $ref: '#/definitions/Azure.Core.Foundations.Error' description: The error object. required: - error PFAgFunc: type: string description: Aggregation functions for pass/fail criteria. enum: - count - percentage - avg - p50 - p90 - p95 - p99 - min - max x-ms-enum: name: PFAgFunc modelAsString: true values: - name: count value: count description: Criteria applies for count value. - name: percentage value: percentage description: Criteria applies for given percentage value. - name: avg value: avg description: Criteria applies for avg value. - name: p50 value: p50 description: Criteria applies for 50th percentile value. - name: p90 value: p90 description: Criteria applies for 90th percentile value. - name: p95 value: p95 description: Criteria applies for 95th percentile value. - name: p99 value: p99 description: Criteria applies for 99th percentile value. - name: min value: min description: Criteria applies for minimum value. - name: max value: max description: Criteria applies for maximum value. Metrics: type: object description: The response to a metrics query. properties: value: type: array description: The TimeSeriesElement items on this page items: $ref: '#/definitions/TimeSeriesElement' x-ms-identifiers: [] nextLink: type: string format: uri description: The link to the next page of items required: - value CertificateType: type: string description: Types of certificates supported. enum: - AKV_CERT_URI x-ms-enum: name: CertificateType modelAsString: true values: - name: AKV_CERT_URI value: AKV_CERT_URI description: If the certificate is stored in an Azure Key Vault. Secret: type: object description: Secret properties: value: type: string description: The value of the secret for the respective type type: $ref: '#/definitions/SecretType' description: Type of secret TestRunAppComponents: type: object description: Test run app component properties: components: type: object description: 'Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ' additionalProperties: $ref: '#/definitions/AppComponent' testRunId: type: string description: Test run identifier readOnly: true createdDateTime: type: string format: date-time description: The creation datetime(RFC 3339 literal format). readOnly: true createdBy: type: string description: The user that created. readOnly: true lastModifiedDateTime: type: string format: date-time description: The last Modified datetime(RFC 3339 literal format). readOnly: true lastModifiedBy: type: string description: The user that last modified. readOnly: true required: - components ErrorResponseBody: description: The error response object. type: object properties: code: description: The error code. type: string message: description: The error message. type: string target: description: The error target. type: string details: description: Additional details and inner errors. type: array items: $ref: '#/definitions/ErrorResponseBody' AppComponent: type: object description: An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource) properties: resourceId: type: string description: fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName} readOnly: true resourceName: type: string description: Azure resource name, required while creating the app component. resourceType: type: string description: Azure resource type, required while creating the app component. displayName: type: string description: Azure resource display name resourceGroup: type: string description: Resource group name of the Azure resource readOnly: true subscriptionId: type: string description: Subscription Id of the Azure resource readOnly: true kind: type: string description: Kind of Azure resource type required: - resourceId - resourceName - resourceType TestRunCreateOrUpdate: type: object description: Load test run model properties: passFailCriteria: $ref: '#/definitions/PassFailCriteria' description: Pass fail criteria for a test. autoStopCriteria: $ref: '#/definitions/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. secrets: type: object 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.' additionalProperties: $ref: '#/definitions/Secret' certificate: $ref: '#/definitions/CertificateMetadata' description: Certificates metadata environmentVariables: type: object description: Environment variables which are defined as a set of pairs. additionalProperties: type: string loadTestConfiguration: $ref: '#/definitions/LoadTestConfiguration' description: The load test configuration. displayName: type: string description: Display name of a testRun. minLength: 2 maxLength: 50 testId: type: string description: Associated test Id. minLength: 2 maxLength: 50 description: type: string description: The test run description. maxLength: 100 TestRunOutputArtifacts: type: object description: The output artifacts for the test run. properties: resultFileInfo: $ref: '#/definitions/TestRunFileInfo' description: File info logsFileInfo: $ref: '#/definitions/TestRunFileInfo' description: File info artifactsContainerInfo: $ref: '#/definitions/ArtifactsContainerInfo' description: The container for test run artifacts. MetricUnit: type: string description: Metric unit. enum: - NotSpecified - Percent - Count - Seconds - Milliseconds - Bytes - BytesPerSecond - CountPerSecond x-ms-enum: name: MetricUnit modelAsString: true values: - name: NotSpecified value: NotSpecified description: No unit specified. - name: Percent value: Percent description: Percentage. - name: Count value: Count description: Value count. - name: Seconds value: Seconds description: Seconds. - name: Milliseconds value: Milliseconds description: Milliseconds - name: Bytes value: Bytes description: Bytes - name: BytesPerSecond value: BytesPerSecond description: Bytes per second - name: CountPerSecond value: CountPerSecond description: Count per second AggregationType: type: string description: Aggregation type. enum: - Average - Count - None - Total - Percentile90 - Percentile95 - Percentile99 x-ms-enum: name: AggregationType modelAsString: true values: - name: Average value: Average description: Average value. - name: Count value: Count description: Total count. - name: None value: None description: Aggregation will be average in this case. - name: Total value: Total description: Total sum. - name: Percentile90 value: Percentile90 description: 90th percentile. - name: Percentile95 value: Percentile95 description: 95th percentile. - name: Percentile99 value: Percentile99 description: 99th percentile. FileStatus: type: string description: File status. enum: - NOT_VALIDATED - VALIDATION_SUCCESS - VALIDATION_FAILURE - VALIDATION_INITIATED - VALIDATION_NOT_REQUIRED x-ms-enum: name: FileStatus modelAsString: true values: - name: NOT_VALIDATED value: NOT_VALIDATED description: File is not validated. - name: VALIDATION_SUCCESS value: VALIDATION_SUCCESS description: File is validated. - name: VALIDATION_FAILURE value: VALIDATION_FAILURE description: File validation is failed. - name: VALIDATION_INITIATED value: VALIDATION_INITIATED description: File validation is in progress. - name: VALIDATION_NOT_REQUIRED value: VALIDATION_NOT_REQUIRED description: Validation is not required. ErrorDetails: type: object description: Error details if there is any failure in load test run properties: message: type: string description: Error details in case test run was not successfully run. readOnly: true AutoStopCriteria: type: object 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. properties: autoStopDisabled: type: boolean description: Whether auto-stop should be disabled. The default value is false. default: false errorRate: type: number format: float description: Threshold percentage of errors on which test run should be automatically stopped. Allowed values are in range of 0.0-100.0 default: 90 errorRateTimeWindowInSeconds: type: integer format: int32 description: Time window during which the error percentage should be evaluated in seconds. default: 60 MetricNamespaceCollection: type: object description: Represents collection of metric namespaces. properties: value: type: array description: The values for the metric namespaces. items: $ref: '#/definitions/MetricNamespace' x-ms-identifiers: [] required: - value Series: type: object properties: activeUsers: description: Active users time series data type: object additionalProperties: type: array items: $ref: '#/definitions/TimeSeries' responseTime: description: Response time, time series data type: object additionalProperties: type: array items: $ref: '#/definitions/TimeSeries' throughput: description: Throughput time series data type: object additionalProperties: type: array items: $ref: '#/definitions/TimeSeries' errors: description: Errors time series data type: object additionalProperties: type: array items: $ref: '#/definitions/TimeSeries' FileUrl: description: FileUrl Model type: object properties: url: description: File url type: string fileId: description: File unique identifier type: string filename: description: Name of the file type: string expireTime: format: date-time description: Expiry time of the file type: string SecretType: type: string description: Types of secrets supported. enum: - AKV_SECRET_URI - SECRET_VALUE x-ms-enum: name: SecretType modelAsString: true values: - name: AKV_SECRET_URI value: AKV_SECRET_URI description: If the secret is stored in an Azure Key Vault. - name: SECRET_VALUE value: SECRET_VALUE description: If the secret value provided as plain text. TimeGrain: type: string description: Time Grain enum: - PT5S - PT10S - PT1M - PT5M - PT1H x-ms-enum: name: TimeGrain modelAsString: true values: - name: PT5S value: PT5S description: 5 seconds, available only if test run duration is less than 10 minutes. - name: PT10S value: PT10S description: 10 seconds, available only if test run duration is less than 10 minutes. - name: PT1M value: PT1M description: 1 minute - name: PT5M value: PT5M description: 5 minutes, available only if test run duration is greater than 1 minute. - name: PT1H value: PT1H description: 1 hour, available only if test run duration is greater than 1 minute. PassFailMetric: type: object description: Pass fail metric properties: clientMetric: $ref: '#/definitions/PFMetrics' description: The client metric on which the criteria should be applied. aggregate: $ref: '#/definitions/PFAgFunc' description: 'The aggregation function to be applied on the client metric. Allowed functions - ‘percentage’ - for error metric , ‘avg’, ‘p50’, ‘p90’, ‘p95’, ‘p99’, ‘min’, ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, ‘count’ - for requests' condition: type: string description: 'The comparison operator. Supported types ‘>’, ‘<’ ' requestName: type: string description: 'Request name for which the Pass fail criteria has to be applied ' value: type: number format: double description: 'The value to compare with the client metric. Allowed values - ‘error : [0.0 , 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.' action: type: string description: Action taken after the threshold is met. Default is ‘continue’. default: continue enum: - continue - stop x-ms-enum: name: PFAction modelAsString: true values: - name: continue value: continue description: Test will continue to run even if pass fail metric criteria metric gets failed. - name: stop value: stop description: Test run will stop if pass fail criteria metric is not passed. actualValue: type: number format: double description: The actual value of the client metric for the test run. readOnly: true result: $ref: '#/definitions/PFResult' description: Outcome of the test run. readOnly: true TestRunServerMetricConfig: type: object description: Test run server metrics configuration properties: testRunId: type: string description: Test run identifier readOnly: true metrics: type: object 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).' additionalProperties: $ref: '#/definitions/ResourceMetric' createdDateTime: type: string format: date-time description: The creation datetime(RFC 3339 literal format). readOnly: true createdBy: type: string description: The user that created. readOnly: true lastModifiedDateTime: type: string format: date-time description: The last Modified datetime(RFC 3339 literal format). readOnly: true lastModifiedBy: type: string description: The user that last modified. readOnly: true TestRunArtifacts: type: object description: Collection of test run artifacts properties: inputArtifacts: $ref: '#/definitions/TestRunInputArtifacts' description: The input artifacts for the test run. readOnly: true outputArtifacts: $ref: '#/definitions/TestRunOutputArtifacts' description: The output artifacts for the test run. TimeSeries: type: object properties: timestamp: format: date-time description: Timestamp(Iso8601Literal format) type: string value: format: double description: Value at timestamp type: number FileUrlPath: type: object properties: id: description: Path of the file type: string url: description: url of the file type: string expireTime: format: date-time description: Expiry time of the file type: string TestRunAppComponentsUpdate: type: object description: Test run app component properties: components: type: object description: 'Azure resource collection { resource id (fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } ' additionalProperties: $ref: '#/definitions/AppComponentUpdate' PassFailMetric_2: type: object properties: clientmetric: description: 'The client metric on which the criteria should be applied. Allowed values - ‘response_time_ms’ , ‘latency’, ‘error’ ' type: string aggregate: description: 'The aggregation function to be applied on the client metric. Allowed functions - ‘percentage’ - for error metric , ‘avg’ - for response_time_ms and latency metric ' type: string condition: description: 'The comparison operator. Supported types ‘>’ ' type: string value: format: double description: 'The value to compare with the client metric. Allowed values - ‘error : [0.0 , 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms' type: number action: description: Either ‘stop’ or ‘continue’ after the threshold is met. Default is ‘continue’ type: string actualValue: format: double description: '[ReadOnly] The actual value of the client metric for the test run ' type: number result: description: '[ReadOnly] Outcome of the testRun. possible outcome - ‘passed’ , ‘failed’ , ‘undetermined’ ' type: string Filters: type: object properties: requestSamplerValues: description: List of request sampler for the test run, for which client metrics can be filtered type: array items: type: string errorFiltersValues: description: List of errors occurred for the test run, for which client metrics can be filtered type: array items: type: string TestRunInputArtifacts: type: object description: The input artifacts for the test run. properties: configFileInfo: $ref: '#/definitions/TestRunFileInfo' description: File info testScriptFileInfo: $ref: '#/definitions/TestRunFileInfo' description: File info userPropFileInfo: $ref: '#/definitions/TestRunFileInfo' description: File info inputArtifactsZipFileInfo: $ref: '#/definitions/TestRunFileInfo' description: File info urlTestConfigFileInfo: $ref: '#/definitions/TestRunFileInfo' description: The config json file for url based test additionalFileInfo: type: array description: Additional supported files for the test run items: $ref: '#/definitions/TestRunFileInfo' readOnly: true x-ms-identifiers: [] NameAndDesc: type: object description: The name and description properties: description: type: string description: The description name: type: string description: The name ResourceMetric: type: object description: 'Associated metric definition for particular metrics of the azure resource ( Refer : https://docs.microsoft.com/en-us/rest/api/monitor/metric-definitions/list#metricdefinition).' properties: id: type: string description: Unique name for metric. readOnly: true resourceId: type: string description: Azure resource id. metricNamespace: type: string description: Metric name space. displayDescription: type: string description: Metric description. name: type: string description: The invariant value of metric name aggregation: type: string description: Metric aggregation. unit: type: string description: Metric unit. resourceType: type: string description: Azure resource type. required: - resourceId - metricNamespace - name - aggregation - resourceType PFResult: type: string description: Pass/fail criteria result. enum: - passed - undetermined - failed x-ms-enum: name: PFResult modelAsString: true values: - name: passed value: passed description: Given pass fail criteria metric has passed. - name: undetermined value: undetermined description: Given pass fail criteria metric couldn't determine. - name: failed value: failed description: Given pass fail criteria metric has failed. TestRunStatistics: type: object description: Test run statistics. properties: transaction: type: string description: Transaction name. readOnly: true sampleCount: type: number format: double description: Sampler count. readOnly: true errorCount: type: number format: double description: Error count. readOnly: true errorPct: type: number format: double description: Error percentage. readOnly: true meanResTime: type: number format: double description: Mean response time. readOnly: true medianResTime: type: number format: double description: Median response time. readOnly: true maxResTime: type: number format: double description: Max response time. readOnly: true minResTime: type: number format: double description: Minimum response time. readOnly: true pct1ResTime: type: number format: double description: 90 percentile response time. readOnly: true pct2ResTime: type: number format: double description: 95 percentile response time. readOnly: true pct3ResTime: type: number format: double description: 99 percentile response time. readOnly: true throughput: type: number format: double description: Throughput. readOnly: true receivedKBytesPerSec: type: number format: double description: Received network bytes. readOnly: true sentKBytesPerSec: type: number format: double description: Send network bytes. readOnly: true MetricDefinition: type: object description: Metric definition properties: dimensions: type: array description: List of dimensions items: $ref: '#/definitions/NameAndDesc' x-ms-identifiers: [] description: type: string description: The metric description name: type: string description: The metric name namespace: type: string description: The namespace the metric belongs to. primaryAggregationType: $ref: '#/definitions/AggregationType' description: The primary aggregation type value defining how to use the values for display. supportedAggregationTypes: type: array description: The collection of what all aggregation types are supported. items: type: string unit: $ref: '#/definitions/MetricUnit' description: The unit of the metric. metricAvailabilities: type: array description: 'Metric availability specifies the time grain (aggregation interval or frequency).' items: $ref: '#/definitions/MetricAvailability' x-ms-identifiers: [] TestKind: type: string description: Test kind enum: - URL - JMX x-ms-enum: name: TestKind modelAsString: true values: - name: URL value: URL description: URL Test - name: JMX value: JMX description: JMX Test DimensionValueList: type: object description: Metrics dimension values. properties: name: type: string description: The dimension name readOnly: true value: type: array description: The dimension value items: type: string nextLink: type: string format: uri description: Link for the next set of values in case of paginated results, if applicable. MetricValue: type: object description: Represents a metric value. properties: timestamp: type: string format: date-time description: The timestamp for the metric value in RFC 3339 format. value: type: number format: double description: The metric value. MetricDefinitionCollection: type: object description: Represents collection of metric definitions. properties: value: type: array description: the values for the metric definitions. items: $ref: '#/definitions/MetricDefinition' x-ms-identifiers: [] required: - value PagedTestRun: type: object description: Paged collection of TestRun items properties: value: type: array description: The TestRun items on this page items: $ref: '#/definitions/TestRun' x-ms-identifiers: [] nextLink: type: string format: uri description: The link to the next page of items required: - value MetricAvailability: type: object description: Metric availability specifies the time grain (aggregation interval or frequency) properties: timeGrain: $ref: '#/definitions/TimeGrain' description: 'The time grain specifies the aggregation interval for the metric. Expressed as a duration ''PT1M'', ''PT1H'', etc.' TestRunFileInfo: type: object description: Test run file info. properties: fileName: type: string description: Name of the file. url: type: string format: uri description: File URL. readOnly: true fileType: $ref: '#/definitions/FileType' description: File type readOnly: true expireDateTime: type: string format: date-time description: Expiry time of the file (RFC 3339 literal format) readOnly: true validationStatus: $ref: '#/definitions/FileStatus' description: Validation status of the file readOnly: true validationFailureDetails: type: string description: Validation failure error details readOnly: true required: - fileName DefaultErrorResponseBody: description: The definition of an error object. type: object properties: error: $ref: '#/definitions/ErrorResponseBody' AppComponentUpdate: type: object description: An Azure resource object (Refer azure generic resource model :https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource) properties: resourceName: type: string description: Azure resource name, required while creating the app component. resourceType: type: string description: Azure resource type, required while creating the app component. displayName: type: string description: Azure resource display name kind: type: string description: Kind of Azure resource type Azure.Core.Foundations.InnerError: type: object description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. properties: code: type: string description: One of a server-defined set of error codes. innererror: $ref: '#/definitions/Azure.Core.Foundations.InnerError' description: Inner error. Status: type: string description: Test run status. enum: - ACCEPTED - NOTSTARTED - PROVISIONING - PROVISIONED - CONFIGURING - CONFIGURED - EXECUTING - EXECUTED - DEPROVISIONING - DEPROVISIONED - DONE - CANCELLING - CANCELLED - FAILED - VALIDATION_SUCCESS - VALIDATION_FAILURE x-ms-enum: name: Status modelAsString: true values: - name: ACCEPTED value: ACCEPTED description: Test run request is accepted. - name: NOTSTARTED value: NOTSTARTED description: Test run is not yet started. - name: PROVISIONING value: PROVISIONING description: Test run is provisioning. - name: PROVISIONED value: PROVISIONED description: Test run is provisioned. - name: CONFIGURING value: CONFIGURING description: Test run is getting configured. - name: CONFIGURED value: CONFIGURED description: Test run configuration is done. - name: EXECUTING value: EXECUTING description: Test run has started executing. - name: EXECUTED value: EXECUTED description: Test run execution is completed. - name: DEPROVISIONING value: DEPROVISIONING description: Test run is getting deprovisioned. - name: DEPROVISIONED value: DEPROVISIONED description: Test run is deprovisioned. - name: DONE value: DONE description: Test run is completed. - name: CANCELLING value: CANCELLING description: Test run is being cancelled. - name: CANCELLED value: CANCELLED description: Test run request is cancelled. - name: FAILED value: FAILED description: Test run request is failed. - name: VALIDATION_SUCCESS value: VALIDATION_SUCCESS description: Test run JMX file is validated. - name: VALIDATION_FAILURE value: VALIDATION_FAILURE description: Test run JMX file validation is failed. InputTestArtifacts: description: '[ReadOnly]The input artifacts for the test' type: object properties: configUrl: $ref: '#/definitions/FileUrl' testScriptUrl: $ref: '#/definitions/FileUrl' inputArtifactsZipFileurl: $ref: '#/definitions/FileUrl' additionalUrls: description: '[ReadOnly]The input artifacts file { name : url } map for the test run' type: array items: $ref: '#/definitions/FileUrl' LoadTestConfig: description: The load test configuration type: object properties: engineInstances: format: int32 description: The number of engine instances to execute load test. Supported values are in range of 1-50. Required for creating a new Test. type: integer TestArtifacts: required: - inputArtifacts type: object properties: inputArtifacts: $ref: '#/definitions/InputTestArtifacts' outputArtifacts: $ref: '#/definitions/OutputTestArtifacts' TestRunModelResourceList: description: List of Resources type: object properties: value: description: List of Resources type: array items: $ref: '#/definitions/TestRunModel' continuationToken: description: Continuation token for list of resources in case of paginated results, if applicable type: string OutputTestArtifacts: description: The output artifacts for the test run required: - logsUrl - resultUrl type: object properties: resultUrl: $ref: '#/definitions/FileUrl' logsUrl: $ref: '#/definitions/FileUrl' ClientMetricsFilters: type: object properties: testRunId: description: Test run name for which client metrics filters is required. type: string filters: $ref: '#/definitions/Filters' timeRange: $ref: '#/definitions/TimeRange' SecretMetadata: type: object properties: value: description: The value of the secret. of type== akv-secret-uri or secret-value type: string type: description: Type of secret. eg. AKV_SECRET_URI/SECRET_VALUE type: string PFMetrics: type: string description: Metrics for pass/fail criteria. enum: - response_time_ms - latency - error - requests - requests_per_sec x-ms-enum: name: PFMetrics modelAsString: true values: - name: response_time_ms value: response_time_ms description: Pass fail criteria for response time metric in milliseconds. - name: latency value: latency description: Pass fail criteria for latency metric in milliseconds. - name: error value: error description: Pass fail criteria for error metric. - name: requests value: requests description: Pass fail criteria for total requests. - name: requests_per_sec value: requests_per_sec description: Pass fail criteria for request per second. OptionalLoadTestConfig: type: object description: Configuration for quick load test properties: endpointUrl: type: string description: Test URL. Provide the complete HTTP URL. For example, https://contoso-app.azurewebsites.net/login requestsPerSecond: type: integer format: int32 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. maxResponseTimeInMs: type: integer format: int32 description: Maximum response time in milliseconds of the API/endpoint. virtualUsers: type: integer format: int32 description: No of concurrent virtual users. rampUpTime: type: integer format: int32 description: Ramp up time in seconds. duration: type: integer format: int32 description: Test run duration in seconds. ClientMetricsResults: type: object properties: testRunId: description: Test run name for which client metrics results is required. type: string timeSeries: $ref: '#/definitions/Series' DimensionFilter: type: object description: Dimension name and values to filter properties: name: type: string description: The dimension name values: type: array description: The dimension values. Maximum values can be 20. items: type: string PassFailCriteria_2: description: Pass fail criteria for a test type: object properties: passFailMetrics: description: 'Map of id and pass fail metrics { id : pass fail metrics }' type: object additionalProperties: $ref: '#/definitions/PassFailMetric_2' FileType: type: string description: Types of file supported. enum: - JMX_FILE - USER_PROPERTIES - ADDITIONAL_ARTIFACTS - ZIPPED_ARTIFACTS - URL_TEST_CONFIG_JSON x-ms-enum: name: FileType modelAsString: true values: - name: JMX_FILE value: JMX_FILE description: If the file is a JMX script. - name: USER_PROPERTIES value: USER_PROPERTIES description: If the file is a user properties file. - name: ADDITIONAL_ARTIFACTS value: ADDITIONAL_ARTIFACTS description: If the file is not among any of the other supported file types. - name: ZIPPED_ARTIFACTS value: ZIPPED_ARTIFACTS description: If the file is a compressed archive containing a collection of various artifacts or resources. - name: URL_TEST_CONFIG_JSON value: URL_TEST_CONFIG_JSON description: If the file is a JSON config file to define the requests for a URL test. PFTestResult: type: string description: Test result based on pass/fail criteria. enum: - PASSED - NOT_APPLICABLE - FAILED x-ms-enum: name: PFTestResult modelAsString: true values: - name: PASSED value: PASSED description: Pass/fail criteria has passed. - name: NOT_APPLICABLE value: NOT_APPLICABLE description: Pass/fail criteria is not applicable. - name: FAILED value: FAILED description: Pass/fail criteria has failed. DimensionValue: type: object description: Represents a metric dimension value. properties: name: type: string description: The name of the dimension. value: type: string description: The value of the dimension. LoadTestConfiguration: type: object description: Configurations for the load test. properties: engineInstances: type: integer format: int32 description: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test. splitAllCSVs: type: boolean 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.' default: false quickStartTest: type: boolean description: 'If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload.' default: false optionalLoadTestConfig: $ref: '#/definitions/OptionalLoadTestConfig' description: Configuration for quick load test MetricNamespace: type: object description: Metric namespace class specifies the metadata for a metric namespace. properties: description: type: string description: The namespace description. name: type: string description: The metric namespace name. TestRunModel: description: Load test run model type: object properties: testRunId: description: '[ReadOnly] Unique test run name as identifier' type: string displayName: description: 'Display name of a testRun ' maxLength: 50 minLength: 2 type: string testId: description: Associated testId maxLength: 50 minLength: 2 type: string resourceId: description: '[ReadOnly] Load test resource Id' type: string description: description: The test run description maxLength: 100 type: string status: description: '[ReadOnly] The test run status' type: string startDateTime: format: date-time description: '[ReadOnly] The test run start DateTime(Iso8601Literal format)' type: string endDateTime: format: date-time description: '[ReadOnly] The test run end DateTime(Iso8601Literal format)' type: string loadTestConfig: $ref: '#/definitions/LoadTestConfig' testResult: description: '[ReadOnly] Test result for pass/Fail criteria used during the test run. possible outcome - ‘Passed’ , ‘Failed’ , ‘Not Applicable’' type: string passFailCriteria: $ref: '#/definitions/PassFailCriteria_2' testArtifacts: $ref: '#/definitions/TestArtifacts' executedDateTime: format: date-time description: '[ReadOnly] Test run initiated time' type: string vusers: format: int32 description: '[ReadOnly] No of virtual users, for which test has been run' type: integer testRunStatistics: description: '[ReadOnly] Testrun statistics' type: object additionalProperties: $ref: '#/definitions/TestRunStatisticsModel' createdDateTime: format: date-time description: '[ReadOnly] The created DateTime(Iso8601Literal format) of the test run' type: string createdBy: description: '[ReadOnly] The user that created the test run' type: string lastModifiedDateTime: format: date-time description: '[ReadOnly] The last updated DateTime(Iso8601Literal format) of the test run' type: string lastModifiedBy: description: '[ReadOnly] The user that updated the test run' type: string portalUrl: description: '[ReadOnly] Portal url ' type: string secrets: description: 'Secrets of higher importance , which are stored in a key-vault typically. Allowed secret types: AKV_SECRET_URI/SECRET_VALUE' type: object additionalProperties: $ref: '#/definitions/SecretMetadata' environmentVariables: description: Secrets of relatively lesser importance , which are defined as a set of pairs. type: object additionalProperties: type: string duration: format: int64 description: '[ReadOnly] Test run duration in milliseconds' type: integer TestRunStatisticsModel: description: '[Readonly] Test run statistics' type: object properties: transaction: description: '[Readonly] Transaction name' type: string sampleCount: format: double description: '[Readonly] Sampler count' type: number errorCount: format: double description: '[Readonly] Error count' type: number errorPct: format: double description: '[Readonly] Error percentage' type: number meanResTime: format: double description: '[Readonly] Mean response time' type: number medianResTime: format: double description: '[Readonly] Median response time' type: number maxResTime: format: double description: '[Readonly] Max response time' type: number minResTime: format: double description: '[Readonly] Minimum response time' type: number pct1ResTime: format: double description: '[Readonly] 90 percentile response time' type: number pct2ResTime: format: double description: '[Readonly] 95 percentile response time' type: number pct3ResTime: format: double description: '[Readonly] 99 percentile response time' type: number throughput: format: double description: '[Readonly] Throughput' type: number receivedKBytesPerSec: format: double description: '[Readonly] Received network bytes' type: number sentKBytesPerSec: format: double description: '[Readonly] Send network bytes' type: number PassFailCriteria: type: object description: Pass fail criteria for a test. properties: passFailMetrics: type: object description: 'Map of id and pass fail metrics { id : pass fail metrics }.' additionalProperties: $ref: '#/definitions/PassFailMetric' CertificateMetadata: type: object description: Certificates metadata properties: value: type: string description: The value of the certificate for respective type type: $ref: '#/definitions/CertificateType' description: Type of certificate name: type: string description: Name of the certificate. MetricRequestPayload: type: object description: Filters to fetch the set of metric. properties: filters: type: array 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"}' items: $ref: '#/definitions/DimensionFilter' x-ms-identifiers: [] ArtifactsContainerInfo: type: object description: Artifacts container info. properties: url: type: string format: uri description: This is a SAS URI to an Azure Storage Container that contains the test run artifacts. expireDateTime: type: string format: date-time description: Expiry time of the container (RFC 3339 literal format) TimeSeriesElement: type: object description: The time series returned when a data query is performed. properties: data: type: array description: An array of data points representing the metric values. items: $ref: '#/definitions/MetricValue' x-ms-identifiers: [] dimensionValues: type: array description: 'The dimension values ' items: $ref: '#/definitions/DimensionValue' x-ms-identifiers: [] parameters: ListTestRunQueryParams.executionFrom: name: executionFrom in: query description: Start DateTime(RFC 3339 literal format) of test-run execution time filter range. required: false type: string format: date-time x-ms-parameter-location: method ListTestRunQueryParams.testId: name: testId in: query description: Unique name of an existing load test. required: false type: string x-ms-parameter-location: method MetricDimensionsRequest.timespan: name: timespan in: query description: The timespan of the query. It is a string with the following format 'startDateTime_ISO/endDateTime_ISO'. required: true type: string x-ms-parameter-location: method ListTestRunQueryParams.status: name: status in: query description: Comma separated list of test run status. required: false type: string x-ms-parameter-location: method ListTestRunQueryParams.search: name: search in: query 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 type: string x-ms-parameter-location: method OldTestRunIdQueryParam: name: oldTestRunId in: query 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 type: string x-ms-parameter-location: method Azure.Core.Foundations.ApiVersionParameter: name: api-version in: query description: The API version to use for this operation. required: true type: string minLength: 1 x-ms-parameter-location: method x-ms-client-name: apiVersion ListTestRunQueryParams.executionTo: name: executionTo in: query description: End DateTime(RFC 3339 literal format) of test-run execution time filter range. required: false type: string format: date-time x-ms-parameter-location: method ListTestRunQueryParams.maxpagesize: name: maxpagesize in: query description: Number of results in response. required: false type: integer format: int32 default: 50 x-ms-parameter-location: method MetricDimensionsRequest.metricNamespace: name: metricNamespace in: query description: Metric namespace to query metric definitions for. required: true type: string x-ms-parameter-location: method ListTestRunQueryParams.orderby: name: orderby in: query description: 'Sort on the supported fields in (field asc/desc) format. eg: executedDateTime asc. Supported fields - executedDateTime' required: false type: string x-ms-parameter-location: method MetricDimensionsRequest.interval: name: interval in: query description: The interval (i.e. timegrain) of the query. required: false type: string default: PT1M enum: - PT5S - PT10S - PT1M - PT5M - PT1H x-ms-enum: name: TimeGrain modelAsString: true values: - name: PT5S value: PT5S description: 5 seconds, available only if test run duration is less than 10 minutes. - name: PT10S value: PT10S description: 10 seconds, available only if test run duration is less than 10 minutes. - name: PT1M value: PT1M description: 1 minute - name: PT5M value: PT5M description: 5 minutes, available only if test run duration is greater than 1 minute. - name: PT1H value: PT1H description: 1 hour, available only if test run duration is greater than 1 minute. x-ms-parameter-location: method MetricDimensionsRequest.metricname: name: metricname in: query description: Metric name required: true type: string x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'