swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DataMove API
schemes:
- https
tags:
- name: DataMove
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationStatus/{operationId}
  : get:
      tags:
      - DataMove
      description: Fetches operation status for data move operation on vault
      operationId: microsoftAzureGetoperationstatus
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/VaultName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: operationId
        in: path
        required: true
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/NewErrorResponse'
      x-ms-examples:
        Get OperationStatus:
          $ref: ./examples/BackupDataMove/BackupDataMoveOperationStatus_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig Operationstatus Operationid
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/prepareDataMove
  : post:
      tags:
      - DataMove
      description: Prepares source vault for Data Move operation
      operationId: microsoftAzureBmspreparedatamove
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/VaultName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: parameters
        in: body
        description: Prepare data move request
        required: true
        schema:
          $ref: '#/definitions/PrepareDataMoveRequest'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/NewErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Prepare Data Move:
          $ref: ./examples/BackupDataMove/PrepareDataMove_Post.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig Preparedatamove
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/triggerDataMove
  : post:
      tags:
      - DataMove
      description: Triggers Data Move Operation on target vault
      operationId: microsoftAzureBmstriggerdatamove
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/ApiVersion'
      - $ref: '#/parameters/VaultName'
      - $ref: '#/parameters/ResourceGroupName'
      - $ref: '#/parameters/SubscriptionId'
      - name: parameters
        in: body
        description: Trigger data move request
        required: true
        schema:
          $ref: '#/definitions/TriggerDataMoveRequest'
      responses:
        '200':
          description: OK
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/NewErrorResponse'
      x-ms-long-running-operation: true
      x-ms-examples:
        Trigger Data Move:
          $ref: ./examples/BackupDataMove/TriggerDataMove_Post.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupstorageconfig Vaultstorageconfig Triggerdatamove
definitions:
  OperationStatus:
    description: Operation status.
    type: object
    properties:
      id:
        description: ID of the operation.
        type: string
      name:
        description: Name of the operation.
        type: string
      status:
        description: Operation status.
        enum:
        - Invalid
        - InProgress
        - Succeeded
        - Failed
        - Canceled
        type: string
        x-ms-enum:
          name: OperationStatusValues
          modelAsString: true
      startTime:
        format: date-time
        description: 'Operation start time. Format: ISO-8601.'
        type: string
      endTime:
        format: date-time
        description: 'Operation end time. Format: ISO-8601.'
        type: string
      error:
        $ref: '#/definitions/OperationStatusError'
        description: Error information related to this operation.
      properties:
        $ref: '#/definitions/OperationStatusExtendedInfo'
        description: Additional information associated with this operation.
  OperationStatusError:
    description: Error information associated with operation status call.
    type: object
    properties:
      code:
        description: Error code of the operation failure.
        type: string
      message:
        description: Error message displayed if the operation failure.
        type: string
  NewErrorResponse:
    properties:
      error:
        type: object
        description: The error object.
        properties:
          code:
            readOnly: true
            type: string
            description: The error code.
          message:
            readOnly: true
            type: string
            description: The error message.
          target:
            readOnly: true
            type: string
            description: The error target.
          details:
            readOnly: true
            type: array
            items:
              $ref: '#/definitions/NewErrorResponse'
            x-ms-identifiers:
            - /error/code
            description: The error details.
          additionalInfo:
            readOnly: true
            type: array
            items:
              $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorAdditionalInfo
            x-ms-identifiers: []
            description: The error additional info.
    description: The resource management error response.
  OperationStatusExtendedInfo:
    description: Base class for additional information of operation status.
    required:
    - objectType
    type: object
    properties:
      objectType:
        description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
        type: string
    discriminator: objectType
  TriggerDataMoveRequest:
    description: Trigger DataMove Request
    required:
    - sourceResourceId
    - sourceRegion
    - dataMoveLevel
    - correlationId
    type: object
    properties:
      sourceResourceId:
        description: ARM Id of source vault
        type: string
      sourceRegion:
        description: Source Region
        type: string
      dataMoveLevel:
        description: DataMove Level
        enum:
        - Invalid
        - Vault
        - Container
        type: string
        x-ms-enum:
          name: DataMoveLevel
          modelAsString: true
      correlationId:
        description: Correlation Id
        type: string
      sourceContainerArmIds:
        description: Source Container ArmIds
        type: array
        items:
          type: string
      pauseGC:
        description: Pause GC
        type: boolean
  PrepareDataMoveRequest:
    description: Prepare DataMove Request
    required:
    - targetResourceId
    - targetRegion
    - dataMoveLevel
    type: object
    properties:
      targetResourceId:
        description: ARM Id of target vault
        type: string
      targetRegion:
        description: Target Region
        type: string
      dataMoveLevel:
        description: DataMove Level
        enum:
        - Invalid
        - Vault
        - Container
        type: string
        x-ms-enum:
          name: DataMoveLevel
          modelAsString: true
      sourceContainerArmIds:
        description: "Source Container ArmIds\r\nThis needs to be populated only if DataMoveLevel is set to container"
        type: array
        items:
          type: string
      ignoreMoved:
        description: Ignore the artifacts which are already moved.
        type: boolean
parameters:
  ResourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group where the recovery services vault is present.
    required: true
    type: string
    x-ms-parameter-location: method
  VaultName:
    name: vaultName
    in: path
    description: The name of the recovery services vault.
    required: true
    type: string
    x-ms-parameter-location: method
  ApiVersion:
    name: api-version
    in: query
    description: Client Api Version.
    required: true
    type: string
  SubscriptionId:
    name: subscriptionId
    in: path
    description: The subscription Id.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'