Microsoft Azure TestRun API

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<br>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

# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-testrun-api-openapi.yml