swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AppComponent API
schemes:
- https
tags:
- name: AppComponent
paths:
  /appcomponents/{name}:
    patch:
      tags:
      - AppComponent
      summary: Microsoft Azure Associate App Component A Azure Resource Model To A Test Model Or Test Run
      operationId: microsoftAzureAppcomponentCreateorupdateappcomponents
      consumes:
      - application/merge-patch+json
      produces:
      - application/json
      parameters:
      - in: path
        name: name
        description: Unique identifier for app component 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: App component model
        required: true
        schema:
          $ref: '#/definitions/AppComponentsMap'
      responses:
        '200':
          description: The app component were updated
          schema:
            $ref: '#/definitions/AppComponentsMap'
        '201':
          description: The app component were created
          schema:
            $ref: '#/definitions/AppComponentsMap'
        default:
          description: "***Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\" .\n\n * \"400\", \"RequiredAppComponentName\", \"name field is required\"\n\n * \"400\", \"RequiredTestOrTestRun\", \"Either test name or test run name is required\"\n\n * \"400\", \"InvalidAppComponentName\", \"name field should be valid\"\n\n * \"400\", \"InvalidValue\",  \"value field is either null or not a valid map\".\n\n * \"404\", \"TestRunNotFound\", \"test run not found with given name\"\n\n * \"404\", \"TestNotFound\", \"Test 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:
        AppComponent_CreateOrUpdateAppComponents_MaximumSet_Gen:
          $ref: ./examples/AppComponent_CreateOrUpdateAppComponents_MaximumSet_Gen.json
        AppComponent_CreateOrUpdateAppComponents_MinimumSet_Gen:
          $ref: ./examples/AppComponent_CreateOrUpdateAppComponents_MinimumSet_Gen.json
      description: Needs a more full description created.
    delete:
      tags:
      - AppComponent
      summary: Microsoft Azure Delete App Component
      operationId: microsoftAzureAppcomponentDeleteappcomponent
      produces:
      - application/json
      parameters:
      - in: path
        name: name
        description: Unique identifier for app component 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 app component is deleted
        default:
          description: "*** Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\"\n\n * \"400\", \"RequiredAppComponentName\", \"name field is required\"\n\n * \"400\", \"InvalidAppComponentName\", \"name field should be valid\"\n\n * \"404\", \"AppComponentNotFound\", \"AppComponent 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:
        AppComponent_DeleteAppComponent_MaximumSet_Gen:
          $ref: ./examples/AppComponent_DeleteAppComponent_MaximumSet_Gen.json
        AppComponent_DeleteAppComponent_MinimumSet_Gen:
          $ref: ./examples/AppComponent_DeleteAppComponent_MinimumSet_Gen.json
      description: Needs a more full description created.
    get:
      tags:
      - AppComponent
      summary: Microsoft Azure Get App Components For A Given Appcomponentname In Query Param
      operationId: microsoftAzureAppcomponentGetappcomponentbyname
      produces:
      - application/json
      parameters:
      - in: path
        name: name
        description: Unique identifier for app component 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 app components
          schema:
            $ref: '#/definitions/AppComponentsMap'
        default:
          description: "***Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\" .\n\n * \"400\", \"RequiredAppComponentName\", \"name field is required\"\n\n * \"400\", \"InvalidAppComponentName\", \"name field should be 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:
        AppComponent_GetAppComponentByName_MaximumSet_Gen:
          $ref: ./examples/AppComponent_GetAppComponentByName_MaximumSet_Gen.json
        AppComponent_GetAppComponentByName_MinimumSet_Gen:
          $ref: ./examples/AppComponent_GetAppComponentByName_MinimumSet_Gen.json
      description: Needs a more full description created.
  /appcomponents:
    get:
      tags:
      - AppComponent
      summary: Microsoft Azure Get App Components For A Test Model Or A Test Run Of Given Name In Query Param
      operationId: microsoftAzureAppcomponentGetappcomponent
      produces:
      - application/json
      parameters:
      - in: query
        name: testId
        description: Required testId, if testRunId name is not provided
        type: string
        maxLength: 50
        minLength: 2
        pattern: ^[a-z0-9_-]*$
      - in: query
        name: testRunId
        description: Required testRunId, if testId is not provided
        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 app components
          schema:
            $ref: '#/definitions/AppComponentsMap'
        default:
          description: "***Error Responses: ***\n\n * \"400\", \"InvalidHostOrResourceName\", \"Host name or domain is not valid\" .\n\n  * \"400\", \"RequiredTestOrTestRun\", \"Either test name or test run name is required\"\n\n  * \"404\", \"TestRunNotFound\", \"test run not found with given name\"\n\n * \"404\", \"TestNotFound\", \"Test 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:
        AppComponent_GetAppComponent_MaximumSet_Gen:
          $ref: ./examples/AppComponent_GetAppComponent_MaximumSet_Gen.json
        AppComponent_GetAppComponent_MinimumSet_Gen:
          $ref: ./examples/AppComponent_GetAppComponent_MinimumSet_Gen.json
      description: Needs a more full description created.
definitions:
  AppComponentsMap:
    description: App components model
    required:
    - value
    type: object
    properties:
      resourceId:
        description: '[ReadOnly] Load test resource id'
        type: string
      testId:
        description: '[Required if testRunId is not given] Load test unique identifier'
        type: string
      testRunId:
        description: '[Required if testId is not given] Load test run unique identifier'
        type: string
      name:
        description: '[ReadOnly] AppComponent name'
        type: string
      value:
        description: 'AppComponents Map { resource id (Fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}) : resource object } '
        type: object
        additionalProperties:
          $ref: '#/definitions/AppComponent'
  DefaultErrorResponseBody:
    description: The definition of an error object.
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorResponseBody'
  AppComponent:
    description: 'The Azure resource object (Refer azure generic resource model : https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id#genericresource)'
    type: object
    properties:
      resourceId:
        description: '[ReadOnly] Fully qualified resource Id e.g subscriptions/{subId}/resourceGroups/{rg}/providers/Microsoft.LoadTestService/loadtests/{resName}'
        type: string
      resourceName:
        description: Azure resource name
        type: string
      resourceType:
        description: Azure resource type
        type: string
      displayName:
        description: '[ReadOnly] Azure resource display name'
        type: string
      resourceGroup:
        description: '[ReadOnly] Resource group name of Azure resource'
        type: string
      subscriptionId:
        description: '[ReadOnly] Subscription Id of Azure resource'
        type: string
      kind:
        description: Kind of Azure resource type
        type: string
  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'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'