swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Test Base Package API
schemes:
- https
tags:
- name: Test Base Package
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/getFileUploadUrl
  : post:
      tags:
      - Test Base Package
      operationId: microsoftAzureTestbaseaccountsGetfileuploadurl
      description: Gets the file upload URL of a Test Base Account.
      parameters:
      - name: parameters
        in: body
        schema:
          $ref: '#/definitions/GetFileUploadURLParameters'
        description: Parameters supplied to the Test Base Account GetFileUploadURL operation.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The file upload URL of the Test Base Account was returned.
          schema:
            $ref: '#/definitions/FileUploadURLResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        TestBaseAccountGetFileUploadUrl:
          $ref: ./examples/TestBaseAccountGetFileUploadUrl.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Getfileuploadurl
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/availableOSs
  : get:
      tags:
      - Test Base Package
      operationId: microsoftAzureAvailableosList
      description: Lists all the available OSs to run a package under a Test Base Account.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/OSUpdateTypeParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/AvailableOSListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        AvailableOSsList:
          $ref: ./examples/AvailableOSsList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Availableoss
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/availableOSs/{availableOSResourceName}
  : get:
      tags:
      - Test Base Package
      operationId: microsoftAzureAvailableosGet
      description: Gets an available OS to run a package under a Test Base Account.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - name: availableOSResourceName
        in: path
        required: true
        type: string
        x-ms-parameter-location: method
        description: The resource name of an Available OS.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/AvailableOSResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        AvailableOSGet:
          $ref: ./examples/AvailableOSGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Availableoss Availableosresourcename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/flightingRings
  : get:
      tags:
      - Test Base Package
      operationId: microsoftAzureFlightingringsList
      description: Lists all the flighting rings of a Test Base Account.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/FlightingRingListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        FlightingRingsList:
          $ref: ./examples/FlightingRingsList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Flightingrings
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/flightingRings/{flightingRingResourceName}
  : get:
      tags:
      - Test Base Package
      operationId: microsoftAzureFlightingringsGet
      description: Gets a flighting ring of a Test Base Account.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - name: flightingRingResourceName
        in: path
        required: true
        type: string
        x-ms-parameter-location: method
        description: The resource name of a flighting ring.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/FlightingRingResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        FlightingRingGet:
          $ref: ./examples/FlightingRingGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Flightingrings Flightingringresourcename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/testTypes
  : get:
      tags:
      - Test Base Package
      operationId: microsoftAzureTesttypesList
      description: Lists all the test types of a Test Base Account.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/TestTypeListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        TestTypesList:
          $ref: ./examples/TestTypesList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Testtypes
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/testTypes/{testTypeResourceName}
  : get:
      tags:
      - Test Base Package
      operationId: microsoftAzureTesttypesGet
      description: Gets a test type of a Test Base Account.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - name: testTypeResourceName
        in: path
        required: true
        type: string
        x-ms-parameter-location: method
        description: The resource name of a test type.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/TestTypeResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        TestTypeGet:
          $ref: ./examples/TestTypeGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Testtypes Testtyperesourcename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/checkPackageNameAvailability
  : post:
      tags:
      - Test Base Package
      operationId: microsoftAzureTestbaseaccountsCheckpackagenameavailability
      description: Checks that the Test Base Package name and version is valid and is not already in use.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/PackageCheckNameAvailabilityParameters'
        description: Parameters supplied to the Test Base Package CheckNameAvailability operation.
      responses:
        '200':
          description: Name is available
          schema:
            $ref: '#/definitions/CheckNameAvailabilityResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        CheckPackageNameAvailability:
          $ref: ./examples/CheckPackageNameAvailability.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Checkpackagenameavailability
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages
  : get:
      tags:
      - Test Base Package
      operationId: microsoftAzurePackagesListbytestbaseaccount
      description: Lists all the packages under a Test Base Account.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/PackageListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        PackagesList:
          $ref: ./examples/PackagesList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Packages
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}
  : put:
      tags:
      - Test Base Package
      operationId: microsoftAzurePackagesCreate
      description: Create or replace (overwrite/recreate, with potential downtime) a Test Base Package.
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      parameters:
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/PackageResource'
        description: Parameters supplied to create a Test Base Package.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/PackageNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The Test Base Package was successfully created or updated.
          schema:
            $ref: '#/definitions/PackageResource'
        '201':
          description: The Test Base Package 'create' or 'update' operation was successfully enqueued. Check provisioningState to see detailed status.
          headers:
            Azure-AsyncOperation:
              description: URL to query for status of the operation.
              type: string
          schema:
            $ref: '#/definitions/PackageResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        PackageCreate:
          $ref: ./examples/PackageCreate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Packages Packagename
    patch:
      tags:
      - Test Base Package
      operationId: microsoftAzurePackagesUpdate
      description: Update an existing Test Base Package.
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      parameters:
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/PackageUpdateParameters'
        description: Parameters supplied to update a Test Base Package.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/PackageNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The existing Test Base Package was successfully updated. Check provisioningState to see detailed status.
          schema:
            $ref: '#/definitions/PackageResource'
        '201':
          description: The Test Base Package 'update' operation was successfully enqueued. Follow the Location header to poll for final outcome.
          headers:
            Azure-AsyncOperation:
              description: URL to query for status of the operation.
              type: string
            Location:
              description: URL to query for status of the operation.
              type: string
        '202':
          description: The Test Base Package 'update' operation was successfully enqueued. Follow the Location header to poll for final outcome.
          headers:
            Azure-AsyncOperation:
              description: URL to query for status of the operation.
              type: string
            Location:
              description: URL to query for status of the operation.
              type: string
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        PackageUpdate:
          $ref: ./examples/PackageUpdate.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Packages Packagename
    delete:
      tags:
      - Test Base Package
      operationId: microsoftAzurePackagesDelete
      description: Deletes a Test Base Package.
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/PackageNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The Test Base Package 'delete' operation was completed successfully.
        '202':
          description: The Test Base Package 'delete' operation was successfully enqueued. Follow the Location header to poll for final outcome.
          headers:
            Azure-AsyncOperation:
              description: URL to query for status of the operation.
              type: string
            Location:
              description: URL to query for status of the operation.
              type: string
        '204':
          description: The Test Base Package 'delete' operation was completed successfully.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        PackageDelete:
          $ref: ./examples/PackageDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Packages Packagename
    get:
      tags:
      - Test Base Package
      operationId: microsoftAzurePackagesGet
      description: Gets a Test Base Package.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/PackageNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The Test Base Package was successfully found.
          schema:
            $ref: '#/definitions/PackageResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        PackageGet:
          $ref: ./examples/PackageGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Packages Packagename
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/hardDelete
  : post:
      tags:
      - Test Base Package
      operationId: microsoftAzurePackagesHarddelete
      description: Hard Delete a Test Base Package.
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/PackageNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The Test Base Package 'HardDelete' operation was completed successfully.
        '202':
          description: The Test Base Package 'HardDelete' operation was successfully enqueued. Follow the Location header to poll for final outcome.
          headers:
            Azure-AsyncOperation:
              description: URL to query for status of the operation.
              type: string
            Location:
              description: URL to query for status of the operation.
              type: string
        '204':
          description: The Test Base Package 'HardDelete' operation was completed successfully.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        PackageHardDelete:
          $ref: ./examples/PackageHardDelete.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Packages Packagename Harddelete
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/getDownloadUrl
  : post:
      tags:
      - Test Base Package
      operationId: microsoftAzurePackagesGetdownloadurl
      description: Gets the download URL of a package.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/PackageNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The package download URL is returned.
          schema:
            $ref: '#/definitions/DownloadURLResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        PackageGetDownloadURL:
          $ref: ./examples/PackageGetDownloadURL.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Packages Packagename Getdownloadurl
definitions:
  ProxyResource:
    description: The resource model definition for an ARM proxy resource. It will have everything other than required location and tags
    allOf:
    - $ref: '#/definitions/Resource'
  FlightingRingListResult:
    description: A list of flighting rings.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/FlightingRingResource'
        description: The list of flighting rings.
      nextLink:
        type: string
        readOnly: true
        description: Link to the next set of results. Not empty if value contains incomplete list of results.
  PackageUpdateParameters:
    description: Parameters supplied to update a Test Base Package.
    properties:
      properties:
        $ref: '#/definitions/PackageUpdateParameterProperties'
        x-ms-client-flatten: true
        description: Test Base Package update parameters.
      tags:
        description: The tags of the Package.
        $ref: '#/definitions/Tags'
  TestTypeResource:
    description: The test type resource.
    properties:
      systemData:
        description: The system metadata relating to this resource
        $ref: '#/definitions/SystemData'
      properties:
        $ref: '#/definitions/TestTypeProperties'
        x-ms-client-flatten: true
        description: Test Type properties.
    allOf:
    - $ref: '#/definitions/ProxyResource'
  AvailableOSResource:
    description: The Available OS resource.
    properties:
      systemData:
        description: The system metadata relating to this resource
        $ref: '#/definitions/SystemData'
      properties:
        $ref: '#/definitions/AvailableOSProperties'
        x-ms-client-flatten: true
        description: Available OS properties.
    allOf:
    - $ref: '#/definitions/ProxyResource'
  PackageListResult:
    description: A list of Test Base Packages.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/PackageResource'
        description: The list of Test Base Packages.
      nextLink:
        type: string
        readOnly: true
        description: Link to the next set of results. Not empty if value contains incomplete list of results.
  GetFileUploadURLParameters:
    description: The parameters supplied to the Test Base Account GetFileUploadURL action.
    properties:
      blobName:
        type: string
        description: The custom file name of the uploaded blob.
  Tags:
    type: object
    additionalProperties:
      type: string
    description: Resource tags.
  TestTypeListResult:
    description: A list of test types.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/TestTypeResource'
        description: The list of test types.
      nextLink:
        type: string
        readOnly: true
        description: Link to the next set of results. Not empty if value contains incomplete list of results.
  Resource:
    description: The Resource definition.
    properties:
      id:
        readOnly: true
        type: string
        description: Resource ID.
      name:
        readOnly: true
        type: string
        description: Resource name.
      type:
        readOnly: true
        type: string
        description: Resource type.
    x-ms-azure-resource: true
  CheckNameAvailabilityResult:
    properties:
      nameAvailable:
        type: boolean
        description: 'Value indicating the availability of the name: true if the name is available; otherwise, false.'
      reason:
        type: string
        description: The reason for unavailability of a name. Required if nameAvailable == false.
        enum:
        - Invalid
        - AlreadyExists
        x-ms-enum:
          name: reason
          modelAsString: true
      message:
        type: string
        readOnly: true
        description: The detailed info regarding the reason associated with the name. Required if nameAvailable == false.
    description: Description of a Check Name availability response properties.
  DownloadURLResponse:
    description: The response of getting a download URL.
    properties:
      downloadUrl:
        type: string
        readOnly: true
        x-ms-secret: true
        description: The download URL.
      expirationTime:
        type: string
        readOnly: true
        format: date-time
        description: Expiry date of the download URL.
  TrackedResource:
    description: The resource model definition for an ARM tracked top level resource
    properties:
      tags:
        description: The tags of the resource.
        $ref: '#/definitions/Tags'
      location:
        type: string
        x-ms-mutability:
        - read
        - create
        description: The geo-location where the resource lives
      etag:
        type: string
        readOnly: true
        description: Resource Etag.
    required:
    - location
    allOf:
    - $ref: '#/definitions/Resource'
  PackageValidationResult:
    description: The validation results. There's validation on package when it's created or updated.
    properties:
      validationName:
        type: string
        readOnly: true
        description: Validation name.
      isValid:
        type: boolean
        readOnly: true
        description: Indicates whether the package passed the validation.
      errors:
        type: array
        readOnly: true
        items:
          type: string
        description: Error information.
  TestType:
    type: string
    description: The test type.
    enum:
    - OutOfBoxTest
    - FunctionalTest
    x-ms-enum:
      name: testType
      modelAsString: true
  AvailableOSProperties:
    description: The Available OS properties.
    properties:
      osId:
        type: string
        description: The Id of an Available OS of a Test Base Account.
      osName:
        type: string
        description: The name of an Available OS of a Test Base Account.
      osVersion:
        type: string
        description: The version of an Available OS of a Test Base Account.
      insiderChannel:
        type: string
        description: The insider channel of an Available OS of a Test Base Account.
      osUpdateType:
        type: string
        description: The OS update type of an Available OS of a Test Base Account.
      osPlatform:
        type: string
        description: The Platform of an Available OS of a Test Base Account.
  ErrorDefinition:
    description: Error definition.
    properties:
      code:
        description: The error code.
        type: string
        readOnly: true
      message:
        description: The error message.
        type: string
        readOnly: true
      target:
        type: string
        description: The target of the particular error.
        readOnly: true
      details:
        description: The error details.
        type: array
        items:
          $ref: '#/definitions/ErrorDefinition'
        readOnly: true
  FlightingRingResource:
    description: The flighting ring resource.
    properties:
      systemData:
        description: The system metadata relating to this resource
        $ref: '#/definitions/SystemData'
      properties:
        $ref: '#/definitions/FlightingRingProperties'
        x-ms-client-flatten: true
        description: Flighting Ring properties.
    allOf:
    - $ref: '#/definitions/ProxyResource'
  PackageCheckNameAvailabilityParameters:
    description: Parameters body to pass for Test Base Package name availability check.
    properties:
      name:
        type: string
        description: Resource name to verify.
      applicationName:
        type: string
        description: Application name to verify.
      version:
        type: string
        description: Version name to verify.
      type:
        type: string
        description: fully qualified resource type which includes provider namespace.
    required:
    - name
    - applicationName
    - version
    - type
  Command:
    description: The command used in the test
    properties:
      name:
        type: string
        description: The name of the command.
      action:
        type: string
        description: The action of the command.
        enum:
        - Install
        - Launch
        - Close
        - Uninstall
        - Custom
        x-ms-enum:
          name: action
          modelAsString: true
      contentType:
        type: string
        description: The type of command content.
        enum:
        - Inline
        - File
        - Path
        x-ms-enum:
          name: contentType
          modelAsString: true
      content:
        type: string
        description: The content of the command. The content depends on source type.
      runElevated:
        type: boolean
        description: Specifies whether to run the command as administrator.
      restartAfter:
        type: boolean
        description: Specifies whether to restart the VM after the command executed.
      maxRunTime:
        type: integer
        format: int32
        description: Specifies the max run time of the command.
      runAsInteractive:
        type: boolean
        description: Specifies whether to run the command in interactive mode.
      alwaysRun:
        type: boolean
        description: Specifies whether to run the command even if a previous command is failed.
      applyUpdateBefore:
        type: boolean
        description: Specifies whether to apply update before the command.
    required:
    - name
    - action
    - contentType
    - content
  TargetOSInfo:
    description: The information of the target OS to be tested.
    properties:
      osUpdateType:
        type: string
        description: Specifies the OS update type to test against, e.g., 'Security updates' or 'Feature updates'.
      targetOSs:
        type: array
        items:
          type: string
        description: Specifies the target OSs to be tested.
    required:
    - osUpdateType
    - targetOSs
  AvailableOSListResult:
    description: A list of available OSs.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/AvailableOSResource'
        description: The list of available OSs.
      nextLink:
        type: string
        readOnly: true
        description: Link to the next set of results. Not empty if value contains incomplete list of results.
  FileUploadURLResponse:
    description: The URL response
    properties:
      uploadUrl:
        type: string
        readOnly: true
        description: The URL used for uploading the package.
      blobPath:
        type: string
        readOnly: true
        description: The blob path of the uploaded package. It will be used as the 'blobPath' property of PackageResource.
  PackageResource:
    description: The Test Base Package resource.
    properties:
      systemData:
        description: The system metadata relating to this resource
        $ref: '#/definitions/SystemData'
      properties:
        $ref: '#/definitions/PackageProperties'
        x-ms-client-flatten: true
        description: Test Base Package properties.
    allOf:
    - $ref: '#/definitions/TrackedResource'
  PackageUpdateParameterProperties:
    description: Parameters supplied to update a Test Base Package.
    properties:
      targetOSList:
        type: array
        items:
          $ref: '#/definitions/TargetOSInfo'
        description: Specifies the target OSs of specific OS Update types.
      flightingRing:
        type: string
        description: The flighting ring for feature update.
      isEnabled:
        type: boolean
        description: Specifies whether the package is enabled. It doesn't schedule test for package which is not enabled.
      blobPath:
        type: string
        description: The file name of the package.
      tests:
        type: array
        items:
          $ref: '#/definitions/Test'
        description: The detailed test information.
  PackageProperties:
    description: The properties of the Test Base Package.
    properties:
      provisioningState:
        description: The provisioning state of the resource.
        $ref: '#/definitions/ProvisioningState'
      applicationName:
        type: string
        description: Application name
      version:
        type: string
        description: Application version
      testTypes:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/TestType'
        description: OOB, functional or both. Mapped to the data in 'tests' property.
      targetOSList:
        type: array
        items:
          $ref: '#/definitions/TargetOSInfo'
        description: Specifies the target OSs of specific OS Update types.
      packageStatus:
        readOnly: true
        type: string
        description: The status of the package.
        enum:
        - Unknown
        - Registered
        - Ready
        - Error
        - ValidatingPackage
        - PreValidationCheckPass
        - Deleted
        - ValidationLongerThanUsual
        - VerifyingPackage
        x-ms-enum:
          name: packageStatus
          modelAsString: true
      lastModifiedTime:
        readOnly: true
        type: string
        format: date-time
        description: The UTC timestamp when the package was last modified.
      flightingRing:
        type: string
        description: The flighting ring for feature update.
      isEnabled:
        type: boolean
        readOnly: true
        description: Flag showing that whether the package is enabled. It doesn't schedule test for package which is not enabled.
      blobPath:
        type: string
        description: The file path of the package.
      validationResults:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/PackageValidationResult'
        description: The validation results. There's validation on package when it's created or updated.
      tests:
        type: array
        items:
          $ref: '#/definitions/Test'
        description: The detailed test information.
    required:
    - applicationName
    - version
    - targetOSList
    - flightingRing
    - blobPath
    - tests
  ErrorResponse:
    description: The error response send when an operation fails.
    properties:
      error:
        $ref: '#/definitions/ErrorDefinition'
        description: The error details.
  TestTypeProperties:
    description: The Test Type properties.
    properties:
      actualTestTypeName:
        type: string
        description: The actual name of a test type of a Test Base Account.
  FlightingRingProperties:
    description: The Flighting Ring properties.
    properties:
      actualFlightingRingName:
        type: string
        description: The actual name of a flighting ring of a Test Base Account.
  ProvisioningState:
    type: string
    description: ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property
    enum:
    - Succeeded
    - Failed
    - Cancelled
    - Creating
    - Deleting
    - Updating
    readOnly: true
    x-ms-enum:
      name: provisioningState
      modelAsString: true
  SystemData:
    description: Metadata pertaining to creation and last modification of the resource.
    type: object
    readOnly: true
    properties:
      createdBy:
        type: string
        description: The identity that created the resource.
      createdByType:
        type: string
        description: The type of identity that created the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        x-ms-enum:
          name: createdByType
          modelAsString: true
      createdAt:
        type: string
        format: date-time
        description: The timestamp of resource creation (UTC).
      lastModifiedBy:
        type: string
        description: The identity that last modified the resource.
      lastModifiedByType:
        type: string
        description: The type of identity that last modified the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        x-ms-enum:
          name: createdByType
          modelAsString: true
      lastModifiedAt:
        type: string
        format: date-time
        description: The type of identity that last modified the resource.
  Test:
    description: The definition of a Test.
    properties:
      testType:
        $ref: '#/definitions/TestType'
        description: The type of the test.
      validationRunStatus:
        readOnly: true
        type: string
        description: The status of the validation run of the package.
        enum:
        - Unknown
        - Pending
        - Passed
        - Failed
        x-ms-enum:
          name: validationRunStatus
          modelAsString: true
      isActive:
        type: boolean
        description: Indicates if this test is active.It doesn't schedule test for not active Test.
      commands:
        type: array
        items:
          $ref: '#/definitions/Command'
        description: The commands used in the test.
    required:
    - testType
    - commands
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to be used with the HTTP request.
  PackageNameParameter:
    name: packageName
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: The resource name of the Test Base Package.
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The Azure subscription ID. This is a GUID-formatted string.
  TestBaseAccountNameParameter:
    name: testBaseAccountName
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: The resource name of the Test Base Account.
  ResourceGroupParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
    description: The name of the resource group that contains the resource.
  OSUpdateTypeParameter:
    name: osUpdateType
    in: query
    required: true
    type: string
    enum:
    - SecurityUpdate
    - FeatureUpdate
    x-ms-enum:
      name: osUpdateType
      modelAsString: true
    x-ms-parameter-location: method
    description: The type of the OS Update.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'