swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MigrateAgent API
  description: MigrateAgent Controller.
schemes:
- https
tags:
- name: MigrateAgent
  description: MigrateAgent Controller.
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/migrateAgents/{agentName}
  : get:
      tags:
      - MigrateAgent
      summary: Microsoft Azure Gets The Migrateagent
      description: Gets the details of the modernizeProject agent.
      operationId: microsoftAzureMigrateagentGet
      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: agentName
        pattern: ^[a-z][a-z0-9]*$
        description: MigrateAgent name.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/MigrateAgentModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-examples:
        MigrateAgent_Get_MaximumSet_Gen:
          $ref: ./examples/MigrateAgent_Get_MaximumSet_Gen.json
        MigrateAgent_Get_MinimumSet_Gen:
          $ref: ./examples/MigrateAgent_Get_MinimumSet_Gen.json
    put:
      tags:
      - MigrateAgent
      summary: Microsoft Azure Puts The Migrateagent
      description: Creates the modernizeProject agent.
      operationId: microsoftAzureMigrateagentCreate
      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: agentName
        pattern: ^[a-z][a-z0-9]*$
        description: MigrateAgent name.
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        description: MigrateAgent model.
        schema:
          $ref: '#/definitions/MigrateAgentModel'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/MigrateAgentModel'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-examples:
        MigrateAgent_Create_MaximumSet_Gen:
          $ref: ./examples/MigrateAgent_Create_MaximumSet_Gen.json
        MigrateAgent_Create_MinimumSet_Gen:
          $ref: ./examples/MigrateAgent_Create_MinimumSet_Gen.json
    delete:
      tags:
      - MigrateAgent
      summary: Microsoft Azure Deletes The Migrateagent
      description: Deletes the modernizeProject agent.
      operationId: microsoftAzureMigrateagentDelete
      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: agentName
        pattern: ^[a-z][a-z0-9]*$
        description: MigrateAgent 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:
        MigrateAgent_Delete_MaximumSet_Gen:
          $ref: ./examples/MigrateAgent_Delete_MaximumSet_Gen.json
        MigrateAgent_Delete_MinimumSet_Gen:
          $ref: ./examples/MigrateAgent_Delete_MinimumSet_Gen.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/migrateAgents
  : get:
      tags:
      - MigrateAgent
      summary: Microsoft Azure Lists The Migrateagents
      description: Gets the list of modernizeProject agents in the given modernizeProject.
      operationId: microsoftAzureMigrateagentList
      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/MigrateAgentModelCollection'
        default:
          description: Error
          schema:
            $ref: '#/definitions/ArmError'
      x-ms-examples:
        MigrateAgent_List_MaximumSet_Gen:
          $ref: ./examples/MigrateAgent_List_MaximumSet_Gen.json
        MigrateAgent_List_MinimumSet_Gen:
          $ref: ./examples/MigrateAgent_List_MinimumSet_Gen.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/migrateAgents/{agentName}/refresh
  : post:
      tags:
      - MigrateAgent
      summary: Microsoft Azure Refreshes The Migrateagent
      description: Refreshes the modernizeProject agent.
      operationId: microsoftAzureMigrateagentRefresh
      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: agentName
        pattern: ^[a-z][a-z0-9]*$
        description: MigrateAgent 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:
        MigrateAgent_Refresh_MaximumSet_Gen:
          $ref: ./examples/MigrateAgent_Refresh_MaximumSet_Gen.json
        MigrateAgent_Refresh_MinimumSet_Gen:
          $ref: ./examples/MigrateAgent_Refresh_MinimumSet_Gen.json
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/migrateAgents/{agentName}/operations/{operationId}
  : get:
      tags:
      - MigrateAgent
      summary: Microsoft Azure Gets The Migrateagent Operation Status
      description: Tracks the results of an asynchronous operation on the modernizeProject agent.
      operationId: microsoftAzureMigrateagentoperationstatusGet
      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: agentName
        pattern: ^[a-z][a-z0-9]*$
        description: MigrateAgent 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:
        MigrateAgentOperationStatus_Get_MaximumSet_Gen:
          $ref: ./examples/MigrateAgentOperationStatus_Get_MaximumSet_Gen.json
        MigrateAgentOperationStatus_Get_MinimumSet_Gen:
          $ref: ./examples/MigrateAgentOperationStatus_Get_MinimumSet_Gen.json
definitions:
  MigrateAgentModelCustomProperties:
    description: MigrateAgent model custom properties.
    required:
    - instanceType
    type: object
    properties:
      instanceType:
        description: Gets or sets the instance type.
        type: string
    x-ms-discriminator-value: IISWorkload
    discriminator: instanceType
  MigrateAgentModel:
    description: MigrateAgent model.
    type: object
    properties:
      properties:
        $ref: '#/definitions/MigrateAgentModelProperties'
      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
  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
  MigrateAgentModelProperties:
    description: MigrateAgent model properties.
    type: object
    properties:
      correlationId:
        description: Gets or sets the MigrateAgent correlation Id.
        type: string
        readOnly: true
      machineId:
        description: Gets or sets the machine Id where MigrateAgent is running.
        type: string
      machineName:
        description: Gets or sets the machine name where MigrateAgent is running.
        type: string
      authenticationIdentity:
        $ref: '#/definitions/IdentityModel'
      isResponsive:
        description: Gets or sets a value indicating whether MigrateAgent is responsive.
        type: boolean
        readOnly: true
      lastHeartbeat:
        format: date-time
        description: Gets or sets the time when last heartbeat was sent by the MigrateAgent.
        type: string
        readOnly: true
      versionNumber:
        description: Gets or sets the MigrateAgent version.
        type: string
        readOnly: true
      provisioningState:
        description: Gets or sets the provisioning state of the MigrateAgent.
        enum:
        - Canceled
        - Creating
        - Deleting
        - Deleted
        - Failed
        - Succeeded
        - Updating
        type: string
        readOnly: true
        x-ms-enum:
          name: ProvisioningState
          modelAsString: true
      healthErrors:
        description: Gets or sets the list of health errors.
        type: array
        items:
          $ref: '#/definitions/HealthErrorModel'
        readOnly: true
      customProperties:
        $ref: '#/definitions/MigrateAgentModelCustomProperties'
  MigrateAgentModelCollection:
    description: MigrateAgent model collection.
    type: object
    properties:
      value:
        description: Gets or sets the list of agents.
        type: array
        items:
          $ref: '#/definitions/MigrateAgentModel'
      nextLink:
        description: Gets or sets the value of next link.
        type: string
  IdentityModel:
    description: Identity model.
    type: object
    properties:
      tenantId:
        description: Gets or sets the tenant Id of the SPN with which MigrateAgent communicates to service.
        type: string
      applicationId:
        description: "Gets or sets the client/application Id of the SPN with which MigrateAgent communicates to\r\nservice."
        type: string
      objectId:
        description: Gets or sets the object Id of the SPN with which MigrateAgent communicates to service.
        type: string
      audience:
        description: Gets or sets the audience of the SPN with which MigrateAgent communicates to service.
        type: string
      aadAuthority:
        description: Gets or sets the authority of the SPN with which MigrateAgent communicates to service.
        type: string
  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
  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
  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'
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'