swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Test Base Account API
schemes:
- https
tags:
- name: Test Base Account
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.TestBase/skus:
    get:
      tags:
      - Test Base Account
      operationId: microsoftAzureSkusList
      description: Lists the available SKUs of Test Base Account in a subscription.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/TestBaseAccountSKUListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        TestBaseAccountSKUsList:
          $ref: ./examples/TestBaseAccountSKUsList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Testbase Skus
  /subscriptions/{subscriptionId}/providers/Microsoft.TestBase/testBaseAccounts:
    get:
      tags:
      - Test Base Account
      operationId: microsoftAzureTestbaseaccountsListbysubscription
      description: Lists all the Test Base Accounts in a subscription. This API is required by ARM guidelines.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/TestBaseAccountIncludeSoftDeletedParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/TestBaseAccountListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        TestBaseAccountsListBySubscription:
          $ref: ./examples/TestBaseAccountsListBySubscription.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Testbase Testbaseaccounts
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts:
    get:
      tags:
      - Test Base Account
      operationId: microsoftAzureTestbaseaccountsListbyresourcegroup
      description: Lists all the Test Base Accounts in a resource group.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountIncludeSoftDeletedParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The operation is completed.
          schema:
            $ref: '#/definitions/TestBaseAccountListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        TestBaseAccountsList:
          $ref: ./examples/TestBaseAccountsList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}
  : put:
      tags:
      - Test Base Account
      operationId: microsoftAzureTestbaseaccountsCreate
      description: Create or replace (overwrite/recreate, with potential downtime) a Test Base Account in the specified subscription.
      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/TestBaseAccountResource'
        description: Parameters supplied to create a Test Base Account.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/TestBaseAccountRestoreSoftDeletedParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The Test Base Account was successfully created or updated.
          schema:
            $ref: '#/definitions/TestBaseAccountResource'
        '201':
          description: The Test Base Account '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/TestBaseAccountResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        TestBaseAccountCreate:
          $ref: ./examples/TestBaseAccountCreate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname
    patch:
      tags:
      - Test Base Account
      operationId: microsoftAzureTestbaseaccountsUpdate
      description: Update an existing Test Base Account.
      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/TestBaseAccountUpdateParameters'
        description: Parameters supplied to update a Test Base Account.
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The existing Test Base Account was successfully updated.
          schema:
            $ref: '#/definitions/TestBaseAccountResource'
        '201':
          description: The Test Base Account '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 Account '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:
        TestBaseAccountUpdate:
          $ref: ./examples/TestBaseAccountUpdate.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname
    delete:
      tags:
      - Test Base Account
      operationId: microsoftAzureTestbaseaccountsDelete
      description: Deletes a Test Base Account.
      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/ApiVersionParameter'
      responses:
        '200':
          description: The Test Base Account 'delete' operation was completed successfully.
        '202':
          description: The Test Base Account '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 Account 'delete' operation was completed successfully.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        TestBaseAccountDelete:
          $ref: ./examples/TestBaseAccountDelete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname
    get:
      tags:
      - Test Base Account
      operationId: microsoftAzureTestbaseaccountsGet
      description: Gets a Test Base Account.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The Test Base Account was successfully found.
          schema:
            $ref: '#/definitions/TestBaseAccountResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        TestBaseAccountGet:
          $ref: ./examples/TestBaseAccountGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/offboard
  : post:
      tags:
      - Test Base Account
      operationId: microsoftAzureTestbaseaccountsOffboard
      description: Offboard a Test Base Account.
      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/ApiVersionParameter'
      responses:
        '200':
          description: The Test Base Account 'offboard' operation was completed successfully.
        '202':
          description: The Test Base Account 'offboard' 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 Account 'offboard' operation was completed successfully.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        TestBaseAccountOffboard:
          $ref: ./examples/TestBaseAccountOffboard.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Offboard
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/usages
  : get:
      tags:
      - Test Base Account
      operationId: microsoftAzureUsageList
      description: Lists the usage data of a Test Base Account.
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupParameter'
      - $ref: '#/parameters/TestBaseAccountNameParameter'
      - $ref: '#/parameters/FilterParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: The usage of the Test Base Account was returned.
          schema:
            $ref: '#/definitions/TestBaseAccountUsageDataList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        TestBaseAccountUsagesList:
          $ref: ./examples/TestBaseAccountUsagesList.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Testbase Testbaseaccounts Testbaseaccountname Usages
definitions:
  TestBaseAccountListResult:
    description: A list of Test Base Accounts.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/TestBaseAccountResource'
        description: The list of Test Base Accounts.
      nextLink:
        type: string
        readOnly: true
        description: Link to the next set of results. Not empty if value contains incomplete list of results.
  Tags:
    type: object
    additionalProperties:
      type: string
    description: Resource tags.
  TestBaseAccountSKU:
    description: Describes a Test Base Account SKU.
    properties:
      resourceType:
        type: string
        description: The type of resource the SKU applies to.
      name:
        type: string
        description: The name of the SKU. This is typically a letter + number code, such as B0 or S0.
      tier:
        type: string
        description: The tier of this particular SKU.
        enum:
        - Standard
        x-ms-enum:
          name: tier
          modelAsString: true
      capabilities:
        type: array
        description: The capabilities of a SKU.
        readOnly: true
        items:
          $ref: '#/definitions/TestBaseAccountSKUCapability'
      locations:
        description: The locations that the SKU is available.
        uniqueItems: false
        type: array
        items:
          type: string
    required:
    - name
    - tier
  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
  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'
  TestBaseAccountUsageDataList:
    description: A list of Test Base Account usage data.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/TestBaseAccountUsageData'
        description: The list of Test Base Account usage data.
      nextLink:
        type: string
        readOnly: true
        description: Link to the next set of results. Not empty if value contains incomplete list of results.
  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
  TestBaseAccountUsageData:
    description: The usage data of a Test Base Account.
    properties:
      id:
        description: Fully qualified ARM resource id
        type: string
      name:
        $ref: '#/definitions/TestBaseAccountUsageName'
        description: Localizable String object containing the name and a localized value.
      unit:
        description: 'Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.'
        type: string
      limit:
        format: int64
        description: The maximum permitted value for the usage quota. If there is no limit, this value will be -1.
        type: integer
      currentValue:
        format: int64
        description: Current value for the usage quota.
        type: integer
  TestBaseAccountSKUCapability:
    description: Properties of the Test Base Account SKU Capability.
    properties:
      name:
        type: string
        description: An invariant to describe the feature, such as 'SLA'.
      value:
        type: string
        description: An invariant if the feature is measured by quantity, such as 99.9%.
    required:
    - name
    - value
  TestBaseAccountUpdateParameterProperties:
    description: Parameters supplied to update a Test Base Account.
    properties:
      sku:
        description: The SKU of the Test Base Account.
        $ref: '#/definitions/TestBaseAccountSKU'
  TestBaseAccountUpdateParameters:
    description: Parameters supplied to update a Test Base Account.
    properties:
      properties:
        $ref: '#/definitions/TestBaseAccountUpdateParameterProperties'
        x-ms-client-flatten: true
        description: Test Base Account update parameters.
      tags:
        description: The tags of the Test Base Account.
        $ref: '#/definitions/Tags'
  TestBaseAccountResourceProperties:
    description: The properties of a Test Base Account resource.
    properties:
      provisioningState:
        description: The provisioning state of the resource.
        $ref: '#/definitions/ProvisioningState'
      sku:
        description: The SKU of the Test Base Account.
        $ref: '#/definitions/TestBaseAccountSKU'
      accessLevel:
        description: The access level of the Test Base Account.
        readOnly: true
        type: string
    required:
    - sku
  ErrorResponse:
    description: The error response send when an operation fails.
    properties:
      error:
        $ref: '#/definitions/ErrorDefinition'
        description: The error details.
  TestBaseAccountSKUListResult:
    description: A list of Test Base Account SKUs.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/TestBaseAccountSKU'
        description: The list of Test Base Account SKUs.
      nextLink:
        type: string
        readOnly: true
        description: Link to the next set of results. Not empty if value contains incomplete list of results.
  TestBaseAccountResource:
    description: The Test Base Account resource.
    properties:
      systemData:
        description: The system metadata relating to this resource
        $ref: '#/definitions/SystemData'
      properties:
        x-ms-client-flatten: true
        $ref: '#/definitions/TestBaseAccountResourceProperties'
        description: Properties of a Test Base Account.
    allOf:
    - $ref: '#/definitions/TrackedResource'
  TestBaseAccountUsageName:
    description: Localizable String object containing the name and a localized value.
    type: object
    properties:
      value:
        description: The identifier of the usage.
        type: string
      localizedValue:
        description: Localized name of the usage.
        type: string
  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.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to be used with the HTTP request.
  FilterParameter:
    name: $filter
    in: query
    type: string
    x-ms-parameter-location: method
    description: Odata filter
  TestBaseAccountIncludeSoftDeletedParameter:
    name: getDeleted
    in: query
    required: false
    type: boolean
    x-ms-parameter-location: method
    description: The flag indicating if we need to include the Test Base Accounts which were soft deleted before.
  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.
  TestBaseAccountRestoreSoftDeletedParameter:
    name: restore
    in: query
    required: false
    type: boolean
    x-ms-parameter-location: method
    description: The flag indicating if we would like to restore the Test Base Accounts which were soft deleted before.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'