swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MoveResources API
schemes:
- https
tags:
- name: MoveResources
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources/{moveResourceName}
  : put:
      tags:
      - MoveResources
      operationId: microsoftAzureMoveresourcesCreate
      description: Creates or updates a Move Resource in the move collection.
      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: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/moveCollectionName'
      - $ref: '#/parameters/moveResourceName'
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        schema:
          $ref: '#/definitions/MoveResource'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/MoveResource'
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        MoveResources_Create:
          $ref: ./examples/MoveResources_Create.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Movecollections Movecollectionname Moveresources Moveresourcename
    delete:
      tags:
      - MoveResources
      operationId: microsoftAzureMoveresourcesDelete
      description: Deletes a Move Resource from the move collection.
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/moveCollectionName'
      - $ref: '#/parameters/moveResourceName'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/OperationStatus'
        '202':
          description: Accepted
        '204':
          description: NoContent
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        MoveResources_Delete:
          $ref: ./examples/MoveResources_Delete.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Movecollections Movecollectionname Moveresources Moveresourcename
    get:
      tags:
      - MoveResources
      operationId: microsoftAzureMoveresourcesGet
      description: Gets the Move Resource.
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/moveCollectionName'
      - $ref: '#/parameters/moveResourceName'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/MoveResource'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        MoveResources_Get:
          $ref: ./examples/MoveResources_Get.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Migrate Movecollections Movecollectionname Moveresources Moveresourcename
definitions:
  MoveResourceErrorBody:
    properties:
      code:
        type: string
        readOnly: true
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        readOnly: true
        description: A message describing the error, intended to be suitable for display in a user interface.
      target:
        type: string
        readOnly: true
        description: The target of the particular error. For example, the name of the property in error.
      details:
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/MoveResourceErrorBody'
        description: A list of additional details about the error.
    description: An error response from the Azure Migrate service.
  MoveResourceProperties:
    description: Defines the move resource properties.
    type: object
    required:
    - sourceId
    properties:
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
      sourceId:
        description: Gets or sets the Source ARM Id of the resource.
        type: string
      targetId:
        description: Gets or sets the Target ARM Id of the resource.
        type: string
        readOnly: true
      existingTargetId:
        description: Gets or sets the existing target ARM Id of the resource.
        type: string
      resourceSettings:
        description: Gets or sets the resource settings.
        $ref: '#/definitions/ResourceSettings'
      sourceResourceSettings:
        description: Gets or sets the source resource settings.
        $ref: '#/definitions/ResourceSettings'
        readOnly: true
      moveStatus:
        description: Defines the move resource status.
        allOf:
        - $ref: '#/definitions/MoveResourceStatus'
        readOnly: true
      dependsOn:
        description: Gets or sets the move resource dependencies.
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/MoveResourceDependency'
      dependsOnOverrides:
        description: Gets or sets the move resource dependencies overrides.
        type: array
        items:
          $ref: '#/definitions/MoveResourceDependencyOverride'
      isResolveRequired:
        description: Gets a value indicating whether the resolve action is required over the move collection.
        type: boolean
        readOnly: true
      errors:
        description: Defines the move resource errors.
        allOf:
        - $ref: '#/definitions/MoveResourceError'
        readOnly: true
  CloudErrorBody:
    x-ms-external: true
    properties:
      code:
        type: string
        description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
      message:
        type: string
        description: A message describing the error, intended to be suitable for display in a user interface.
      target:
        type: string
        description: The target of the particular error. For example, the name of the property in error.
      details:
        type: array
        items:
          $ref: '#/definitions/CloudErrorBody'
        description: A list of additional details about the error.
    description: An error response from the service.
  MoveResourceDependencyOverride:
    description: Defines the dependency override of the move resource.
    type: object
    properties:
      id:
        description: Gets or sets the ARM ID of the dependent resource.
        type: string
      targetId:
        description: "Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of\r\nthe dependent resource."
        type: string
  MoveErrorInfo:
    description: The move custom error info.
    type: object
    properties:
      moveResources:
        readOnly: true
        type: array
        description: The affected move resources.
        items:
          $ref: '#/definitions/AffectedMoveResource'
  OperationStatus:
    description: Operation status REST resource.
    type: object
    properties:
      id:
        description: Resource Id.
        type: string
        readOnly: true
      name:
        description: Operation name.
        type: string
        readOnly: true
      status:
        description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running.
        type: string
        readOnly: true
      startTime:
        description: Start time.
        type: string
        readOnly: true
      endTime:
        description: End time.
        type: string
        readOnly: true
      error:
        $ref: '#/definitions/OperationStatusError'
        description: Error stating all error details for the operation.
        readOnly: true
      properties:
        $ref: '#/definitions/OperationStatusProperties'
        description: Custom data.
        readOnly: true
  OperationStatusProperties:
    description: Class for operation result properties.
    type: object
    properties: {}
  OperationStatusError:
    description: Class for operation status errors.
    type: object
    properties:
      code:
        readOnly: true
        type: string
        description: The error code.
      message:
        readOnly: true
        type: string
        description: The error message.
      details:
        readOnly: true
        type: array
        description: The error details.
        items:
          $ref: '#/definitions/OperationStatusError'
      additionalInfo:
        readOnly: true
        type: array
        description: The additional info.
        items:
          $ref: '#/definitions/OperationErrorAdditionalInfo'
  ResolutionType:
    description: Defines the resolution type.
    enum:
    - Manual
    - Automatic
    type: string
    x-ms-enum:
      name: ResolutionType
      modelAsString: true
  MoveResourceDependency:
    description: Defines the dependency of the move resource.
    type: object
    properties:
      id:
        description: Gets the source ARM ID of the dependent resource.
        type: string
      resolutionStatus:
        description: Gets the dependency resolution status.
        type: string
      resolutionType:
        $ref: '#/definitions/ResolutionType'
      dependencyType:
        $ref: '#/definitions/DependencyType'
      manualResolution:
        $ref: '#/definitions/ManualResolutionProperties'
      automaticResolution:
        $ref: '#/definitions/AutomaticResolutionProperties'
      isOptional:
        description: Gets or sets a value indicating whether the dependency is optional.
        type: string
  MoveResource:
    description: Defines the move resource.
    type: object
    x-ms-azure-resource: true
    properties:
      id:
        readOnly: true
        type: string
        description: Fully qualified resource Id for the resource.
      name:
        readOnly: true
        type: string
        description: The name of the resource
      type:
        readOnly: true
        type: string
        description: The type of the resource.
      properties:
        $ref: '#/definitions/MoveResourceProperties'
  MoveState:
    description: Defines the MoveResource states.
    enum:
    - AssignmentPending
    - PreparePending
    - PrepareInProgress
    - PrepareFailed
    - MovePending
    - MoveInProgress
    - MoveFailed
    - DiscardInProgress
    - DiscardFailed
    - CommitPending
    - CommitInProgress
    - CommitFailed
    - Committed
    - DeleteSourcePending
    - ResourceMoveCompleted
    type: string
    readOnly: true
    x-ms-enum:
      name: MoveState
      modelAsString: true
  ManualResolutionProperties:
    description: Defines the properties for manual resolution.
    type: object
    properties:
      targetId:
        description: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual.
        type: string
  DependencyType:
    description: Defines the dependency type.
    enum:
    - RequiredForPrepare
    - RequiredForMove
    type: string
    x-ms-enum:
      name: DependencyType
      modelAsString: true
  JobStatus:
    description: Defines the job status.
    type: object
    properties:
      jobName:
        $ref: '#/definitions/JobName'
      jobProgress:
        description: Gets or sets the monitoring job percentage.
        type: string
        readOnly: true
  MoveResourceError:
    properties:
      properties:
        type: object
        description: The move resource error body.
        $ref: '#/definitions/MoveResourceErrorBody'
    description: An error response from the azure resource mover service.
  AutomaticResolutionProperties:
    description: Defines the properties for automatic resolution.
    type: object
    properties:
      moveResourceId:
        description: "Gets the MoveResource ARM ID of\r\nthe dependent resource if the resolution type is Automatic."
        type: string
  OperationErrorAdditionalInfo:
    description: The operation error info.
    type: object
    properties:
      type:
        readOnly: true
        type: string
        description: The error type.
      info:
        readOnly: true
        $ref: '#/definitions/MoveErrorInfo'
        description: The operation error info.
  JobName:
    description: Defines the job name.
    enum:
    - InitialSync
    type: string
    readOnly: true
    x-ms-enum:
      name: JobName
      modelAsString: true
  CloudError:
    x-ms-external: true
    properties:
      error:
        $ref: '#/definitions/CloudErrorBody'
        description: Cloud error body.
    description: An error response from the service.
  ProvisioningState:
    description: Defines the provisioning states.
    enum:
    - Succeeded
    - Updating
    - Creating
    - Failed
    type: string
    readOnly: true
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
  MoveResourceStatus:
    description: Defines the move resource status.
    type: object
    properties:
      moveState:
        $ref: '#/definitions/MoveState'
      jobStatus:
        $ref: '#/definitions/JobStatus'
      errors:
        $ref: '#/definitions/MoveResourceError'
  ResourceSettings:
    description: Gets or sets the resource settings.
    type: object
    required:
    - resourceType
    - targetResourceName
    properties:
      resourceType:
        description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines.
        type: string
        x-ms-mutability:
        - create
        - read
      targetResourceName:
        description: Gets or sets the target Resource name.
        type: string
    discriminator: resourceType
  AffectedMoveResource:
    description: The RP custom operation error info.
    type: object
    properties:
      id:
        readOnly: true
        type: string
        description: The affected move resource id.
      sourceId:
        readOnly: true
        type: string
        description: The affected move resource source id.
      moveResources:
        readOnly: true
        type: array
        description: The affected move resources.
        items:
          $ref: '#/definitions/AffectedMoveResource'
parameters:
  resourceGroupName:
    in: path
    name: resourceGroupName
    description: The Resource Group Name.
    required: true
    type: string
    x-ms-parameter-location: method
  api-version:
    in: query
    name: api-version
    description: Client Api Version.
    required: true
    type: string
  moveCollectionName:
    in: path
    name: moveCollectionName
    description: The Move Collection Name.
    required: true
    type: string
    x-ms-parameter-location: method
  moveResourceName:
    in: path
    name: moveResourceName
    description: The Move Resource Name.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionId:
    in: path
    name: subscriptionId
    description: The Subscription ID.
    required: true
    type: string
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'