swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector LoadTests API
schemes:
- https
tags:
- name: LoadTests
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.LoadTestService/loadTests:
    get:
      tags:
      - LoadTests
      description: Lists loadtests resources in a subscription.
      operationId: microsoftAzureLoadtestsListbysubscription
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/LoadTestResourcePageList'
        default:
          description: Resource provider error response about the failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        LoadTests_ListBySubscription:
          $ref: ./examples/LoadTests_ListBySubscription.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Loadtestservice Loadtests
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests:
    get:
      tags:
      - LoadTests
      description: Lists loadtest resources in a resource group.
      operationId: microsoftAzureLoadtestsListbyresourcegroup
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK -- list of loadtests resources retrieved
          schema:
            $ref: '#/definitions/LoadTestResourcePageList'
        default:
          description: Resource provider error response about the failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        LoadTests_ListByResourceGroup:
          $ref: ./examples/LoadTests_ListByResourceGroup.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Loadtestservice Loadtests
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LoadTestService/loadTests/{loadTestName}
  : get:
      tags:
      - LoadTests
      description: Get a LoadTest resource.
      operationId: microsoftAzureLoadtestsGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/LoadTestNameParameter'
      responses:
        '200':
          description: OK -- loadtest resource retrieved
          schema:
            $ref: '#/definitions/LoadTestResource'
        default:
          description: Resource provider error response about the failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        LoadTests_Get:
          $ref: ./examples/LoadTests_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Loadtestservice Loadtests Loadtestname
    put:
      tags:
      - LoadTests
      description: Create or update LoadTest resource.
      operationId: microsoftAzureLoadtestsCreateorupdate
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/LoadTestNameParameter'
      - in: body
        name: LoadTestResource
        description: LoadTest resource data
        required: true
        schema:
          $ref: '#/definitions/LoadTestResource'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/LoadTestResource'
        '201':
          description: Created -- LoadTest resource created
          schema:
            $ref: '#/definitions/LoadTestResource'
        default:
          description: Resource provider error response about the failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        LoadTests_CreateOrUpdate:
          $ref: ./examples/LoadTests_CreateOrUpdate.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Loadtestservice Loadtests Loadtestname
    patch:
      tags:
      - LoadTests
      description: Update a loadtest resource.
      operationId: microsoftAzureLoadtestsUpdate
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/LoadTestNameParameter'
      - in: body
        name: LoadTestResourcePatchRequestBody
        description: LoadTest resource update data
        required: true
        schema:
          $ref: '#/definitions/LoadTestResourcePatchRequestBody'
      responses:
        '200':
          description: OK -- resource updated
          schema:
            $ref: '#/definitions/LoadTestResource'
        '202':
          description: Accepted -- LoadTest resource patch request accepted
        default:
          description: Resource provider error response about the failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        LoadTests_Update:
          $ref: ./examples/LoadTests_Update.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Loadtestservice Loadtests Loadtestname
    delete:
      tags:
      - LoadTests
      description: Delete a LoadTest resource.
      operationId: microsoftAzureLoadtestsDelete
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: '#/parameters/LoadTestNameParameter'
      responses:
        '200':
          description: OK -- resource deleted
        '202':
          description: Accepted -- LoadTest resource delete request accepted
        '204':
          description: No Content -- resource deleted
        default:
          description: Resource provider error response about the failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        LoadTests_Delete:
          $ref: ./examples/LoadTests_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Loadtestservice Loadtests Loadtestname
definitions:
  LoadTestResource:
    type: object
    description: LoadTest details
    properties:
      properties:
        description: Load Test resource properties
        $ref: '#/definitions/LoadTestProperties'
        x-ms-client-flatten: true
      identity:
        $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity
        description: The type of identity used for the resource.
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
  LoadTestResourcePageList:
    description: List of resources page result.
    type: object
    properties:
      value:
        description: List of resources in current page.
        type: array
        items:
          $ref: '#/definitions/LoadTestResource'
      nextLink:
        description: Link to next page of resources.
        type: string
  EncryptionProperties:
    description: Key and identity details for Customer Managed Key encryption of load test resource
    type: object
    properties:
      identity:
        type: object
        description: All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault.
        properties:
          type:
            type: string
            enum:
            - SystemAssigned
            - UserAssigned
            x-ms-enum:
              name: type
              modelAsString: true
            description: Managed identity type to use for accessing encryption key Url
          resourceId:
            type: string
            description: 'user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups/<resource group>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId'
      keyUrl:
        type: string
        description: 'key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek.'
  LoadTestProperties:
    description: LoadTest resource properties.
    type: object
    properties:
      description:
        description: Description of the resource.
        maxLength: 512
        type: string
      provisioningState:
        description: Resource provisioning state.
        $ref: '#/definitions/ResourceState'
        readOnly: true
      dataPlaneURI:
        description: Resource data plane URI.
        maxLength: 2083
        type: string
        readOnly: true
      encryption:
        description: CMK Encryption property.
        type: object
        $ref: '#/definitions/EncryptionProperties'
  ResourceState:
    description: Load Test resources provisioning states.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Deleted
    type: string
    x-ms-enum:
      name: ResourceState
      modelAsString: true
  LoadTestResourcePatchRequestBody:
    description: LoadTest resource patch request body.
    type: object
    properties:
      tags:
        description: Resource tags.
        type: object
      identity:
        $ref: ../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/ManagedServiceIdentity
        description: The type of identity used for the resource.
      properties:
        description: Load Test resource properties
        type: object
        x-ms-client-flatten: true
        properties:
          description:
            description: Description of the resource.
            maxLength: 512
            type: string
          encryption:
            description: CMK Encryption property.
            type: object
            $ref: '#/definitions/EncryptionProperties'
parameters:
  LoadTestNameParameter:
    in: path
    name: loadTestName
    description: Load Test resource name.
    required: true
    x-ms-parameter-location: method
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'