swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Test API
schemes:
- https
tags:
- name: Test
paths:
  /tests:
    get:
      operationId: microsoftAzureLoadtestadministrationListtests
      tags:
      - Test
      summary: 'Microsoft Azure Get All Load Tests By The Fully Qualified Resource Id E G

        subscriptions {subid} Resourcegroups {rg} Providers Microsoft Loadtestservice Loadtests {resname}'
      description: Get all load tests by the fully qualified resource Id e.g<br>subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/ListTestQueryParams.orderby'
      - $ref: '#/parameters/ListTestQueryParams.search'
      - $ref: '#/parameters/ListTestQueryParams.lastModifiedStartTime'
      - $ref: '#/parameters/ListTestQueryParams.lastModifiedEndTime'
      - $ref: '#/parameters/ListTestQueryParams.maxpagesize'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/PagedTest'
        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 all load tests.:
          $ref: ./examples/ListTests.json
      x-ms-pageable:
        nextLinkName: nextLink
  /tests/{testId}:
    get:
      operationId: microsoftAzureLoadtestadministrationGettest
      tags:
      - Test
      summary: Microsoft Azure Get Load Test Details By Test Id
      description: Get load test details by test Id
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: Unique test identifier for the load test, 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/Test'
        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.:
          $ref: ./examples/GetTest.json
    patch:
      operationId: microsoftAzureLoadtestadministrationCreateorupdatetest
      tags:
      - Test
      summary: Microsoft Azure Create A New Test Or Update An Existing Test By Providing The Test Id
      description: Create a new test or update an existing test by providing the test Id.
      consumes:
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: Unique test identifier for the load test, 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: The resource instance.
        required: true
        schema:
          $ref: '#/definitions/TestCreateOrUpdate'
        x-ms-client-name: resource
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/Test'
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          schema:
            $ref: '#/definitions/Test'
        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 or update a load test:
          $ref: ./examples/CreateOrUpdateTest.json
    delete:
      operationId: microsoftAzureLoadtestadministrationDeletetest
      tags:
      - Test
      summary: Microsoft Azure Delete A Test By Its Test Id
      description: Delete a test by its test Id.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: Unique test identifier for the load test, 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:
          $ref: ./examples/DeleteTest.json
  /tests/{testId}/app-components:
    get:
      operationId: microsoftAzureLoadtestadministrationGetappcomponents
      tags:
      - Test
      summary: Microsoft Azure Get Associated App Component Collection Of Azure Resources For The Given Test
      description: Get associated app component (collection of azure resources) for the given test.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: 'Unique name for the load test, 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/TestAppComponents'
        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.:
          $ref: ./examples/ListTestAppComponents.json
    patch:
      operationId: microsoftAzureLoadtestadministrationCreateorupdateappcomponents
      tags:
      - Test
      summary: Microsoft Azure Add An App Component To A Test
      description: Add an app component to a test by providing the resource Id, name and type.
      consumes:
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: 'Unique name for the load test, 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/TestAppComponentsUpdate'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/TestAppComponents'
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          schema:
            $ref: '#/definitions/TestAppComponents'
        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:
          $ref: ./examples/CreateOrUpdateTestAppComponents.json
  /tests/{testId}/files:
    get:
      operationId: microsoftAzureLoadtestadministrationListtestfiles
      tags:
      - Test
      summary: Microsoft Azure Get All Test Files
      description: Get all test files.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: Unique test identifier for the load test, 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/PagedTestFileInfo'
        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 all test files.:
          $ref: ./examples/ListTestFiles.json
      x-ms-pageable:
        nextLinkName: nextLink
  /tests/{testId}/files/{fileName}:
    get:
      operationId: microsoftAzureLoadtestadministrationGettestfile
      tags:
      - Test
      summary: Microsoft Azure Get All The Files That Are Associated With A Test
      description: Get all the files that are associated with a test.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: Unique test identifier for the load test, 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/TestFileInfo'
        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 from a load test:
          $ref: ./examples/GetTestFile.json
    put:
      operationId: microsoftAzureLoadtestadministrationUploadtestfile
      tags:
      - Test
      summary: "Microsoft Azure Upload Input File For A Given Test Id File Size Can T Be More Than 50 Mb \nexisting File With Same Name For The Given Test Will Be Overwritten File\nshould Be Provided In The Request Body As Application Octet Stream"
      description: Upload input file for a given test Id. File size can't be more than 50 MB.<br>Existing file with same name for the given test will be overwritten. File<br>should be provided in the request body as application/octet-stream.
      consumes:
      - application/octet-stream
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: 'Unique name for the load test, 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: 'Unique name for test file with file extension like : App.jmx'
        required: true
        type: string
      - name: fileType
        in: query
        description: File type
        required: false
        type: string
        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.
      - name: body
        in: body
        description: The file content as application/octet-stream.
        required: true
        schema:
          type: string
          format: binary
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          schema:
            $ref: '#/definitions/TestFileInfo'
        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:
        Upload input file for a given test name.:
          $ref: ./examples/UploadTestFile.json
    delete:
      operationId: microsoftAzureLoadtestadministrationDeletetestfile
      tags:
      - Test
      summary: Microsoft Azure Delete File By The File Name For A Test
      description: Delete file by the file name for a test
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: Unique test identifier for the load test, 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:
        '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 file from a load test:
          $ref: ./examples/DeleteTestFile.json
  /tests/{testId}/server-metrics-config:
    get:
      operationId: microsoftAzureLoadtestadministrationGetservermetricsconfig
      tags:
      - Test
      summary: Microsoft Azure List Server Metrics Configuration For The Given Test
      description: List server metrics configuration for the given test.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: 'Unique name for the load test, 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/TestServerMetricConfig'
        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.:
          $ref: ./examples/ListTestServerMetricsConfig.json
    patch:
      operationId: microsoftAzureLoadtestadministrationCreateorupdateservermetricsconfig
      tags:
      - Test
      summary: Microsoft Azure Configure Server Metrics For A Test
      description: Configure server metrics for a test
      consumes:
      - application/merge-patch+json
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - name: testId
        in: path
        description: 'Unique name for the load test, 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/TestServerMetricConfigUpdate'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/TestServerMetricConfig'
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          schema:
            $ref: '#/definitions/TestServerMetricConfig'
        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.:
          $ref: ./examples/CreateOrUpdateTestServerMetricsConfig.json
  /loadtests/{testId}:
    patch:
      tags:
      - Test
      summary: Microsoft Azure Creates Updates A New Load Test Test Name Must Be A Valid Url Character ^[a Z0 9 ]*$
      operationId: microsoftAzureTestCreateorupdatetest
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: testId
        description: Unique identifier for load test 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
      - in: body
        name: body
        description: Load test model
        required: true
        schema:
          $ref: '#/definitions/TestModel'
      responses:
        '200':
          description: The loadtest was updated
          schema:
            $ref: '#/definitions/TestModel'
        '201':
          description: The loadtest was created
          schema:
            $ref: '#/definitions/TestModel'
        default:
          description: '***Error Responses: ***


            * "400", "InvalidHostOrResourceName", "Host name or domain is not valid"


            * "400", "InvalidTestId", "testId field should be valid"


            * "400", "RequiredTestId", "testId field is required"


            * "400", "InvalidPassFailCriteria", "Invalid pass fail criteria "


            * "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:
        Test_CreateOrUpdateTest_MaximumSet_Gen:
          $ref: ./examples/Test_CreateOrUpdateTest_MaximumSet_Gen.json
        Test_CreateOrUpdateTest_MinimumSet_Gen:
          $ref: ./examples/Test_CreateOrUpdateTest_MinimumSet_Gen.json
      description: Needs a more full description created.
    delete:
      tags:
      - Test
      summary: Microsoft Azure Delete A Test With Given Name Test Name Must Be A Valid Url Character ^[a Z0 9 ]*$
      operationId: microsoftAzureTestDeleteloadtest
      produces:
      - application/json
      parameters:
      - in: path
        name: testId
        description: Unique identifier for load test 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 is deleted
        default:
          description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestId\", \"testId field is required\"\n\n * \"400\", \"InvalidTestId\", \"testId field should be valid\"\n\n * \"404\", \"TestNotFound\", \"Test 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:
        Test_DeleteLoadTest_MaximumSet_Gen:
          $ref: ./examples/Test_DeleteLoadTest_MaximumSet_Gen.json
        Test_DeleteLoadTest_MinimumSet_Gen:
          $ref: ./examples/Test_DeleteLoadTest_MinimumSet_Gen.json
      description: Needs a more full description created.
    get:
      tags:
      - Test
      summary: Microsoft Azure Get Load Test Model Of Given Test Name
      operationId: microsoftAzureTestGetloadtest
      produces:
      - application/json
      parameters:
      - in: path
        name: testId
        description: Unique identifier for load test 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 load test
          schema:
            $ref: '#/definitions/TestModel'
        default:
          description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestId\", \"testId field is required\"\n\n * \"400\", \"InvalidTestId\", \"testId field should be valid\"\n\n * \"404\", \"TestNotFound\", \"Test 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:
        Test_GetLoadTest_MaximumSet_Gen:
          $ref: ./examples/Test_GetLoadTest_MaximumSet_Gen.json
        Test_GetLoadTest_MinimumSet_Gen:
          $ref: ./examples/Test_GetLoadTest_MinimumSet_Gen.json
      description: Needs a more full description created.
  /loadtests/sortAndFilter:
    get:
      tags:
      - Test
      summary: Microsoft Azure Get All Load Tests For A Given Fully Qualified Resource Id E G Subscriptions {subid} Resourcegroups {rg} Providers Microsoft Loadtestservice Loadtests {resname}
      operationId: microsoftAzureTestListloadtestsearch
      produces:
      - application/json
      parameters:
      - in: query
        name: orderBy
        description: 'Sort on one of the field - lastModifiedDateTime, displayName, createdBy in (field asc/desc) format. eg: displayName asc'
        type: string
      - in: query
        name: search
        description: Filter search based on searchable fields- testId, createdBy.
        type: string
      - in: query
        name: lastUpdatedStartTime
        description: Start DateTime(Iso8601Literal format) of the last updated time range to filter tests.
        type: string
        format: date-time
      - in: query
        name: lastUpdatedEndTime
        description: End DateTime(Iso8601Literal format) of the last updated time range to filter tests.
        type: string
        format: date-time
      - in: query
        name: nextLink
        description: NextLink Token to get next page of response
        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 loadtests
          schema:
            $ref: '#/definitions/TestModelResourceList'
        default:
          description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\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:
        Test_ListLoadTestSearch_MaximumSet_Gen:
          $ref: ./examples/Test_ListLoadTestSearch_MaximumSet_Gen.json
        Test_ListLoadTestSearch_MinimumSet_Gen:
          $ref: ./examples/Test_ListLoadTestSearch_MinimumSet_Gen.json
      description: Needs a more full description created.
  /loadtests/{testId}/files/{fileId}:
    put:
      tags:
      - Test
      summary: Microsoft Azure Upload Input File For A Given Test Name File Name Must Be A Valid Url Character ^[a Z0 9 ]*$ File Size Can T Be More Than 50 Mb Existing File With Same Name For The Given Test Will Be Overwritten
      operationId: microsoftAzureTestUploadtestfile
      consumes:
      - multipart/form-data
      produces:
      - application/json
      parameters:
      - in: path
        name: testId
        description: Unique identifier for load test 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 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
      - in: formData
        name: file
        description: Artifact to upload as input for test
        required: true
        type: file
      responses:
        '201':
          description: The test artifact was uploaded
          schema:
            $ref: '#/definitions/TestModel'
        default:
          description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestId\", \"testId field is required\"\n\n * \"400\", \"InvalidTestId\", \"testId field should be valid\"\n\n * \"400\", \"RequiredFileId\", \"fileId field is required\"\n\n * \"400\", \"InvalidFileId\", \"fileId field is not valid\"   \n\n * \"400\", \"InvalidFile\", \"File is not valid error -\"\n\n * \"404\", \"TestNotFound\", \"Test 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:
        Test_UploadTestFile_MaximumSet_Gen:
          $ref: ./examples/Test_UploadTestFile_MaximumSet_Gen.json
      description: Needs a more full description created.
    get:
      tags:
      - Test
      summary: Microsoft Azure Get Test File With Given File Name
      operationId: microsoftAzureTestGettestfile
      produces:
      - application/json
      parameters:
      - in: path
        name: testId
        description: Unique identifier for load test 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 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 test file url
          schema:
            $ref: '#/definitions/FileUrlPath'
        default:
          description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestId\", \"testId field is required\"\n\n * \"400\", \"InvalidTestId\", \"testId field should be valid\"\n\n * \"400\", \"RequiredFileId\", \"fileId field is required\"\n\n * \"400\", \"InvalidFileId\", \"fileId field is not valid\"   \n\n * \"404\", \"TestNotFound\", \"Test not found with given identifier\"\n\n * \"404\", \"TestFileNotFound\",  \"Test file not found with given name\"\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:
        Test_GetTestFile_MaximumSet_Gen:
          $ref: ./examples/Test_GetTestFile_MaximumSet_Gen.json
        Test_GetTestFile_MinimumSet_Gen:
          $ref: ./examples/Test_GetTestFile_MinimumSet_Gen.json
      description: Needs a more full description created.
    delete:
      tags:
      - Test
      summary: Microsoft Azure Delete File Of Given File Name For A Test File Name Must Be A Valid Url Character ^[a Z0 9 ]*$
      operationId: microsoftAzureTestDeletetestfile
      produces:
      - application/json
      parameters:
      - in: path
        name: testId
        description: Unique identifier for load test 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 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:
        '204':
          description: The requested artifact is deleted
        default:
          description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestId\", \"testId field is required\"\n\n * \"400\", \"InvalidTestId\", \"testId field should be valid\"\n\n * \"400\", \"RequiredFileId\", \"fileId field is required\"\n\n* \"400\", \"InvalidFileId\", \"fileId field is not valid\"   \n\n * \"404\", \"TestNotFound\", \"Test not found with given identifier\"\n\n * \"404\", \"TestFileNotFound\",  \"Test file not found with given name\"\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:
        Test_DeleteTestFile_MaximumSet_Gen:
          $ref: ./examples/Test_DeleteTestFile_MaximumSet_Gen.json
        Test_DeleteTestFile_MinimumSet_Gen:
          $ref: ./examples/Test_DeleteTestFile_MinimumSet_Gen.json
      description: Needs a more full description created.
  /loadtests/{testId}/files:
    get:
      tags:
      - Test
      summary: Microsoft Azure Get All Test Files
      operationId: microsoftAzureTestGetalltestfiles
      produces:
      - application/json
      parameters:
      - in: path
        name: testId
        description: Unique identifier for load test 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 files urls
          schema:
            $ref: '#/definitions/FileUrlList'
        default:
          description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredTestId\", \"testId field is required\"\n\n * \"400\", \"InvalidTestId\", \"testId field should be valid\"\n\n* \"404\", \"TestNotFound\", \"Test 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:
        Test_GetAllTestFiles_MaximumSet_Gen:
          $ref: ./examples/Test_GetAllTestFiles_MaximumSet_Gen.json
        Test_GetAllTestFiles_MinimumSet_Gen:
          $ref: ./examples/Test_GetAllTestFiles_MinimumSet_Gen.json
      description: Needs a more full description created.
definitions:
  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.
  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
  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
  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
  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
  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.
  TestInputArtifacts:
    type: object
    description: The input artifacts for the test.
    properties:
      configFileInfo:
        $ref: '#/definitions/TestFileInfo'
        description: File info
      testScriptFileInfo:
        $ref: '#/definitions/TestFileInfo'
        description: File info
      userPropFileInfo:
        $ref: '#/definitions/TestFileInfo'
        description: File info
      inputArtifactsZipFileInfo:
        $ref: '#/definitions/TestFileInfo'
        description: File info
      urlTestConfigFileInfo:
        $ref: '#/definitions/TestFileInfo'
        description: The config json file for url based test
      additionalFileInfo:
        type: array
        description: Additional supported files for the test run
        items:
          $ref: '#/definitions/TestFileInfo'
        readOnly: true
        x-ms-identifiers: []
  TestServerMetricConfigUpdate:
    type: object
    description: Test server metrics configuration
    properties:
      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/ResourceMetricUpdate'
  FileUrlList:
    type: object
    properties:
      value:
        description: List of file urls
        type: array
        items:
          $ref: '#/definitions/FileUrl'
  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
  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.
  PagedTest:
    type: object
    description: Paged collection of Test items
    properties:
      value:
        type: array
        description: The Test items on this page
        items:
          $ref: '#/definitions/Test'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  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
  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.
  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
  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'
  DefaultErrorResponseBody:
    description: The definition of an error object.
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorResponseBody'
  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.
  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
  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.
  TestAppComponentsUpdate:
    type: object
    description: Test app components
    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'
  PagedTestFileInfo:
    type: object
    description: Paged collection of TestFileInfo items
    properties:
      value:
        type: array
        description: The TestFileInfo items on this page
        items:
          $ref: '#/definitions/TestFileInfo'
        x-ms-identifiers: []
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  TestServerMetricConfig:
    type: object
    description: Test server metrics configuration
    properties:
      testId:
        type: string
        description: Test 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
    required:
    - metrics
  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.
  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
  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
  TestCreateOrUpdate:
    type: object
    description: Load test 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 <name,value> pairs.
        additionalProperties:
          type: string
      loadTestConfiguration:
        $ref: '#/definitions/LoadTestConfiguration'
        description: The load test configuration.
      baselineTestRunId:
        type: string
        description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs
      description:
        type: string
        description: The test description.
        maxLength: 100
      displayName:
        type: string
        description: Display name of a test.
        minLength: 2
        maxLength: 50
      subnetId:
        type: string
        description: Subnet ID on which the load test instances should run.
      kind:
        $ref: '#/definitions/TestKind'
        description: Kind of test.
      publicIPDisabled:
        type: boolean
        description: Inject load test engines without deploying public IP for outbound access
      keyvaultReferenceIdentityType:
        type: string
        description: Type of the managed identity referencing the Key vault.
      keyvaultReferenceIdentityId:
        type: string
        description: Resource Id of the managed identity referencing the Key vault.
  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.
  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'
  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'
  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
  TestModel:
    description: Load test model
    type: object
    properties:
      testId:
        description: '[ReadOnly] Unique test name as identifier'
        maxLength: 50
        minLength: 2
        type: string
      description:
        description: The test description
        maxLength: 100
        type: string
      displayName:
        description: 'Display name of a test '
        maxLength: 50
        minLength: 2
        type: string
      resourceId:
        description: '[ReadOnly] Fully qualified resource Id e.g /subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}'
        type: string
      loadTestConfig:
        $ref: '#/definitions/LoadTestConfig'
      passFailCriteria:
        $ref: '#/definitions/PassFailCriteria_2'
      createdDateTime:
        format: date-time
        description: '[ReadOnly] The created DateTime(Iso8601Literal format) of the test model'
        type: string
      createdBy:
        description: '[ReadOnly] The user that created the test model'
        type: string
      lastModifiedDateTime:
        format: date-time
        description: '[ReadOnly] The last Modified DateTime(Iso8601Literal format) of the test model'
        type: string
      lastModifiedBy:
        description: '[ReadOnly] The user that last modified the test model'
        type: string
      inputArtifacts:
        $ref: '#/definitions/InputTestArtifacts'
      secrets:
        description: 'Secrets of higher importance , which are stored in a key-vault typically. Allowed secret type: AKV_SECRET_URI'
        type: object
        additionalProperties:
          $ref: '#/definitions/SecretMetadata'
      environmentVariables:
        description: Secrets of relatively lesser importance , which are defined as a set of <name,value> pairs.
        type: object
        additionalProperties:
          type: string
  TestAppComponents:
    type: object
    description: Test app components
    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'
      testId:
        type: string
        description: Test 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'
  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.
  ResourceMetricUpdate:
    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:
      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.
  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
  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
  TestModelResourceList:
    description: List of Resources
    type: object
    properties:
      value:
        description: List of Resources
        type: array
        items:
          $ref: '#/definitions/TestModel'
      continuationToken:
        description: Continuation token for list of resources in case of paginated results, if applicable
        type: string
  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
  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
  TestFileInfo:
    type: object
    description: Test 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
  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.
  Test:
    type: object
    description: Load test 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 <name,value> pairs.
        additionalProperties:
          type: string
      loadTestConfiguration:
        $ref: '#/definitions/LoadTestConfiguration'
        description: The load test configuration.
      baselineTestRunId:
        type: string
        description: Id of the test run to be marked as baseline to view trends of client-side metrics from recent test runs
      inputArtifacts:
        $ref: '#/definitions/TestInputArtifacts'
        description: The input artifacts for the test.
        readOnly: true
      testId:
        type: string
        description: Unique test identifier for the load test, must contain only lower-case alphabetic, numeric, underscore or hyphen characters.
        minLength: 2
        maxLength: 50
        pattern: ^[a-z0-9_-]*$
        readOnly: true
      description:
        type: string
        description: The test description.
        maxLength: 100
      displayName:
        type: string
        description: Display name of a test.
        minLength: 2
        maxLength: 50
      subnetId:
        type: string
        description: Subnet ID on which the load test instances should run.
      kind:
        $ref: '#/definitions/TestKind'
        description: Kind of test.
      publicIPDisabled:
        type: boolean
        description: Inject load test engines without deploying public IP for outbound access
      keyvaultReferenceIdentityType:
        type: string
        description: Type of the managed identity referencing the Key vault.
      keyvaultReferenceIdentityId:
        type: string
        description: Resource Id of the managed identity referencing the Key vault.
      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:
    - testId
parameters:
  ListTestQueryParams.lastModifiedEndTime:
    name: lastModifiedEndTime
    in: query
    description: End DateTime(RFC 3339 literal format) of the last updated time range to filter tests.
    required: false
    type: string
    format: date-time
    x-ms-parameter-location: method
  ListTestQueryParams.orderby:
    name: orderby
    in: query
    description: 'Sort on the supported fields in (field asc/desc) format. eg:

      lastModifiedDateTime asc. Supported fields - lastModifiedDateTime'
    required: false
    type: string
    x-ms-parameter-location: method
  ListTestQueryParams.search:
    name: search
    in: query
    description: 'Prefix based, case sensitive search on searchable fields - displayName,

      createdBy. For example, to search for a test, with display name is Login Test,

      the search parameter can be Login.'
    required: false
    type: string
    x-ms-parameter-location: method
  ListTestQueryParams.maxpagesize:
    name: maxpagesize
    in: query
    description: Number of results in response.
    required: false
    type: integer
    format: int32
    default: 50
    x-ms-parameter-location: method
  ListTestQueryParams.lastModifiedStartTime:
    name: lastModifiedStartTime
    in: query
    description: Start DateTime(RFC 3339 literal format) of the last updated time range to filter tests.
    required: false
    type: string
    format: date-time
    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
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'