swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector WorkloadInstance API
  description: Workload instance controller.
schemes:
- https
tags:
- name: WorkloadInstance
  description: Workload instance controller.
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}
  : get:
      tags:
      - WorkloadInstance
      summary: Microsoft Azure Gets The Workload Instance
      description: Gets the details of the workload instance.
      operationId: microsoftAzureWorkloadinstanceGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - in: path
        name: modernizeProjectName
        pattern: ^[a-z][a-z0-9]*$
        description: ModernizeProject name.
        required: true
        type: string
      - in: path
        name: workloadInstanceName
        pattern: ^[a-z][a-z0-9]*$
        description: Workload instance name.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/WorkloadInstanceModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-examples:
        WorkloadInstance_Get_MaximumSet_Gen:
          $ref: ./examples/WorkloadInstance_Get_MaximumSet_Gen.json
        WorkloadInstance_Get_MinimumSet_Gen:
          $ref: ./examples/WorkloadInstance_Get_MinimumSet_Gen.json
    put:
      tags:
      - WorkloadInstance
      summary: Microsoft Azure Puts The Workload Instance
      description: Creates the workload instance in the given modernizeProject.
      operationId: microsoftAzureWorkloadinstanceCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - in: path
        name: modernizeProjectName
        pattern: ^[a-z][a-z0-9]*$
        description: ModernizeProject name.
        required: true
        type: string
      - in: path
        name: workloadInstanceName
        pattern: ^[a-z][a-z0-9]*$
        description: Workload instance name.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        description: Workload instance model.
        schema:
          $ref: '#/definitions/WorkloadInstanceModel'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/WorkloadInstanceModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-examples:
        WorkloadInstance_Create_MaximumSet_Gen:
          $ref: ./examples/WorkloadInstance_Create_MaximumSet_Gen.json
        WorkloadInstance_Create_MinimumSet_Gen:
          $ref: ./examples/WorkloadInstance_Create_MinimumSet_Gen.json
    delete:
      tags:
      - WorkloadInstance
      summary: Microsoft Azure Deletes The Workload Instance
      description: Deletes the workload instance in the given modernizeProject.
      operationId: microsoftAzureWorkloadinstanceDelete
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - in: path
        name: modernizeProjectName
        pattern: ^[a-z][a-z0-9]*$
        description: ModernizeProject Name.
        required: true
        type: string
      - in: path
        name: workloadInstanceName
        pattern: ^[a-z][a-z0-9]*$
        description: Workload instance name.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '202':
          description: Accepted
          headers:
            Azure-AsyncOperation:
              description: Tracking URL for long running operation.
              type: string
            Location:
              type: string
        '204':
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        WorkloadInstance_Delete_MaximumSet_Gen:
          $ref: ./examples/WorkloadInstance_Delete_MaximumSet_Gen.json
        WorkloadInstance_Delete_MinimumSet_Gen:
          $ref: ./examples/WorkloadInstance_Delete_MinimumSet_Gen.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances
  : get:
      tags:
      - WorkloadInstance
      summary: Microsoft Azure Lists The Workload Instances
      description: Gets the list of workload instances in the given modernizeProject.
      operationId: microsoftAzureWorkloadinstanceList
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - in: path
        name: modernizeProjectName
        pattern: ^[a-z][a-z0-9]*$
        description: ModernizeProject name.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/WorkloadInstanceModelCollection'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        WorkloadInstance_List_MaximumSet_Gen:
          $ref: ./examples/WorkloadInstance_List_MaximumSet_Gen.json
        WorkloadInstance_List_MinimumSet_Gen:
          $ref: ./examples/WorkloadInstance_List_MinimumSet_Gen.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/operations/{operationId}
  : get:
      tags:
      - WorkloadInstance
      summary: Microsoft Azure Gets The Workload Instance Operation Status
      description: Tracks the results of an asynchronous operation on the workload instance.
      operationId: microsoftAzureWorkloadinstanceoperationstatusGet
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - in: path
        name: modernizeProjectName
        pattern: ^[a-z][a-z0-9]*$
        description: ModernizeProject name.
        required: true
        type: string
      - in: path
        name: workloadInstanceName
        pattern: ^[a-z][a-z0-9]*$
        description: Workload instance name.
        required: true
        type: string
      - in: path
        name: operationId
        description: Operation Id.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/OperationStatus'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-examples:
        WorkloadInstanceOperationStatus_Get_MaximumSet_Gen:
          $ref: ./examples/WorkloadInstanceOperationStatus_Get_MaximumSet_Gen.json
        WorkloadInstanceOperationStatus_Get_MinimumSet_Gen:
          $ref: ./examples/WorkloadInstanceOperationStatus_Get_MinimumSet_Gen.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/completeMigration
  : post:
      tags:
      - WorkloadInstance
      summary: Microsoft Azure Performs Complete Migrate
      description: Performs the complete migrate on the workload instance.
      operationId: microsoftAzureWorkloadinstanceMigratecomplete
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - in: path
        name: modernizeProjectName
        pattern: ^[a-z][a-z0-9]*$
        description: ModernizeProject name.
        required: true
        type: string
      - in: path
        name: workloadInstanceName
        pattern: ^[a-z][a-z0-9]*$
        description: Workload instance name.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '202':
          description: Accepted
          headers:
            Azure-AsyncOperation:
              description: Tracking URL for long running operation.
              type: string
            Location:
              type: string
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        WorkloadInstance_MigrateComplete_MaximumSet_Gen:
          $ref: ./examples/WorkloadInstance_MigrateComplete_MaximumSet_Gen.json
        WorkloadInstance_MigrateComplete_MinimumSet_Gen:
          $ref: ./examples/WorkloadInstance_MigrateComplete_MinimumSet_Gen.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/disableReplication
  : post:
      tags:
      - WorkloadInstance
      summary: Microsoft Azure Performs Disable Replicate
      description: Performs the disable replicate on the workload instance.
      operationId: microsoftAzureWorkloadinstanceStopreplicate
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - in: path
        name: modernizeProjectName
        pattern: ^[a-z][a-z0-9]*$
        description: ModernizeProject name.
        required: true
        type: string
      - in: path
        name: workloadInstanceName
        pattern: ^[a-z][a-z0-9]*$
        description: Workload instance name.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '202':
          description: Accepted
          headers:
            Azure-AsyncOperation:
              description: Tracking URL for long running operation.
              type: string
            Location:
              type: string
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-examples:
        WorkloadInstance_StopReplicate_MaximumSet_Gen:
          $ref: ./examples/WorkloadInstance_StopReplicate_MaximumSet_Gen.json
        WorkloadInstance_StopReplicate_MinimumSet_Gen:
          $ref: ./examples/WorkloadInstance_StopReplicate_MinimumSet_Gen.json
definitions:
  OperationStatus:
    description: Defines the operation status.
    type: object
    properties:
      id:
        description: Gets the Id.
        type: string
        readOnly: true
      name:
        description: Gets the operation name.
        type: string
        readOnly: true
      status:
        description: "Gets the status of the operation. ARM expects the terminal status to be one of\r\nSucceeded/ Failed/ Canceled. All other values imply that the operation is still running."
        type: string
        readOnly: true
      startTime:
        description: Gets the start time.
        type: string
        readOnly: true
      endTime:
        description: Gets the end time.
        type: string
        readOnly: true
  InnerHealthErrorModel:
    description: Inner health error model.
    type: object
    properties:
      id:
        description: Gets the ID.
        type: string
        readOnly: true
      code:
        description: Gets or sets the error code.
        type: string
        readOnly: true
      healthCategory:
        description: Gets or sets the health category.
        type: string
        readOnly: true
      category:
        description: Gets or sets the error category.
        type: string
        readOnly: true
      severity:
        description: Gets or sets the error severity.
        type: string
        readOnly: true
      source:
        description: Gets or sets the error source.
        type: string
        readOnly: true
      creationTime:
        format: date-time
        description: Gets or sets the error creation time.
        type: string
        readOnly: true
      isCustomerResolvable:
        description: Gets or sets a value indicating whether the error is customer resolvable.
        type: boolean
        readOnly: true
      summary:
        description: Gets or sets the error summary.
        type: string
        readOnly: true
      message:
        description: Gets or sets the error message.
        type: string
        readOnly: true
      causes:
        description: Gets or sets possible causes of the error.
        type: string
        readOnly: true
      recommendation:
        description: Gets or sets recommended action to resolve the error.
        type: string
        readOnly: true
  WorkloadJobProperties:
    description: Workload job properties.
    type: object
    properties:
      scenarioName:
        description: Gets or sets workload scenario name.
        type: string
        readOnly: true
      id:
        description: Gets or sets workflow Id.
        type: string
        readOnly: true
      name:
        description: Gets or sets workflow name.
        type: string
        readOnly: true
      displayName:
        description: Gets or sets the workflow friendly display name.
        type: string
        readOnly: true
      state:
        description: Gets or sets workflow state.
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: Gets or sets start time of the workflow.
        type: string
        readOnly: true
      endTime:
        format: date-time
        description: Gets or sets end time of the workflow.
        type: string
        readOnly: true
  SystemDataModel:
    description: System data required to be defined for Azure resources.
    type: object
    properties:
      createdBy:
        description: Gets or sets identity that created the resource.
        type: string
      createdByType:
        description: "Gets or sets the type of identity that created the resource: user, application,\r\nmanagedIdentity."
        type: string
      createdAt:
        format: date-time
        description: Gets or sets the timestamp of resource creation (UTC).
        type: string
      lastModifiedBy:
        description: Gets or sets the identity that last modified the resource.
        type: string
      lastModifiedByType:
        description: "Gets or sets the type of identity that last modified the resource: user, application,\r\nmanagedIdentity."
        type: string
      lastModifiedAt:
        format: date-time
        description: Gets or sets the timestamp of resource last modification (UTC).
        type: string
  WorkloadInstanceModelCustomProperties:
    description: Workload instance model custom properties.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets or sets the instance type.
        enum:
        - IISWorkload
        - ApacheTomcatWorkload
        type: string
        x-ms-enum:
          name: WorkloadType
          modelAsString: true
      webAppArmId:
        description: Gets or sets the Web application ARM id.
        type: string
      webAppSiteName:
        description: Gets or sets the Web application site name.
        type: string
    x-ms-discriminator-value: IISWorkload
    discriminator: instanceType
  HealthErrorModel:
    description: Health error model.
    type: object
    properties:
      affectedResourceType:
        description: Gets or sets the type of affected resource type.
        type: string
      affectedResourceCorrelationIds:
        description: "Gets or sets the list of affected resource correlation Ids. This can be used to\r\nuniquely identify the count of items affected by a specific category and severity\r\nas well as count of item affected by an specific issue."
        type: array
        items:
          type: string
      childErrors:
        description: Gets or sets a list of child health errors associated with this error.
        type: array
        items:
          $ref: '#/definitions/InnerHealthErrorModel'
      id:
        description: Gets the ID.
        type: string
        readOnly: true
      code:
        description: Gets or sets the error code.
        type: string
        readOnly: true
      healthCategory:
        description: Gets or sets the health category.
        type: string
        readOnly: true
      category:
        description: Gets or sets the error category.
        type: string
        readOnly: true
      severity:
        description: Gets or sets the error severity.
        type: string
        readOnly: true
      source:
        description: Gets or sets the error source.
        type: string
        readOnly: true
      creationTime:
        format: date-time
        description: Gets or sets the error creation time.
        type: string
        readOnly: true
      isCustomerResolvable:
        description: Gets or sets a value indicating whether the error is customer resolvable.
        type: boolean
        readOnly: true
      summary:
        description: Gets or sets the error summary.
        type: string
        readOnly: true
      message:
        description: Gets or sets the error message.
        type: string
        readOnly: true
      causes:
        description: Gets or sets possible causes of the error.
        type: string
        readOnly: true
      recommendation:
        description: Gets or sets recommended action to resolve the error.
        type: string
        readOnly: true
  WorkloadInstanceModel:
    description: Workload instance model.
    type: object
    properties:
      properties:
        $ref: '#/definitions/WorkloadInstanceModelProperties'
      id:
        description: Gets or sets the Id of the resource.
        type: string
        readOnly: true
      name:
        description: Gets or sets the name of the resource.
        type: string
        readOnly: true
      type:
        description: Gets or sets the type of the resource.
        type: string
        readOnly: true
      systemData:
        allOf:
        - $ref: '#/definitions/SystemDataModel'
        readOnly: true
      tags:
        description: Gets or sets the resource tags.
        type: object
        additionalProperties:
          type: string
    x-ms-azure-resource: true
  ArmErrorInfo:
    description: Arm error information.
    type: object
    properties:
      code:
        description: Gets or sets the error code returned by the service.
        type: string
      message:
        description: Gets or sets error Message returned by the service.
        type: string
  ArmError:
    description: ARM error.
    type: object
    properties:
      error:
        $ref: '#/definitions/ArmErrorInfo'
  WorkloadInstanceModelCollection:
    description: Workload instance model collection.
    type: object
    properties:
      value:
        description: Gets or sets the list of workload instances.
        type: array
        items:
          $ref: '#/definitions/WorkloadInstanceModel'
      nextLink:
        description: Gets or sets the value of next link.
        type: string
  WorkloadInstanceModelProperties:
    description: Workload instance model properties.
    type: object
    properties:
      name:
        description: Gets or sets the workload instance name.
        type: string
      provisioningState:
        description: Gets or sets the provisioning state of the workload instance.
        enum:
        - Canceled
        - Creating
        - Deleting
        - Deleted
        - Failed
        - Succeeded
        - Updating
        type: string
        readOnly: true
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
      migrateAgentId:
        description: Gets or sets the migrate agent id associated with the workload instance.
        type: string
      displayName:
        description: Gets or sets the display name.
        type: string
      sourcePlatform:
        description: Gets or sets the source platform.
        type: string
      sourceName:
        description: Gets or sets the source name.
        type: string
      replicationHealth:
        description: Gets or sets the replication health of the workload instance.
        enum:
        - Normal
        - Warning
        - Critical
        type: string
        readOnly: true
        x-ms-enum:
          name: HealthStatus
          modelAsString: true
      replicationStatus:
        description: Gets or sets the replication state of the workload instance.
        enum:
        - None
        - Scheduled
        - InitialSync
        - Completed
        - Failed
        type: string
        readOnly: true
        x-ms-enum:
          name: ClientFacingReplicationStatus
          modelAsString: true
      replicationStatusDescription:
        description: Gets or sets the workload replication state description.
        type: string
        readOnly: true
      lastSuccessfulReplicationCycleTime:
        format: date-time
        description: Gets or sets the Last successful replication cycle time.
        type: string
        readOnly: true
      healthErrors:
        description: Gets or sets the list of health errors.
        type: array
        items:
          $ref: '#/definitions/HealthErrorModel'
        readOnly: true
      currentJob:
        allOf:
        - $ref: '#/definitions/WorkloadJobProperties'
        readOnly: true
      allowedOperations:
        description: Gets or sets the allowed scenarios on the workload instance.
        type: array
        items:
          type: string
        readOnly: true
      masterSiteName:
        description: Gets or Sets the master site name.
        type: string
      customProperties:
        $ref: '#/definitions/WorkloadInstanceModelCustomProperties'
parameters:
  resourceGroupName:
    in: path
    name: resourceGroupName
    description: Name of the Azure Resource Group that project is part of.
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionId:
    in: path
    name: subscriptionId
    description: Azure Subscription Id in which project was created.
    required: true
    type: string
    x-ms-parameter-location: method
  api-version:
    in: query
    name: api-version
    description: Client Api Version.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'