Microsoft Azure Azure Migrate Engine APIs — WorkloadInstance

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Azure Migrate Engine APIs — WorkloadInstance
  description: 'Microsoft Azure Azure Migrate Engine APIs — WorkloadInstance. 7 operations. Lead operation: Microsoft Azure
    Lists The Workload Instances. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - WorkloadInstance
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_API_KEY: MICROSOFT_AZURE_API_KEY
capability:
  consumes:
  - type: http
    namespace: azure-migrate-engine-apis-workloadinstance
    baseUri: ''
    description: Microsoft Azure Azure Migrate Engine APIs — WorkloadInstance business capability. Self-contained, no shared
      references.
    resources:
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances
      operations:
      - name: microsoftazureworkloadinstancelist
        method: GET
        description: Microsoft Azure Lists The Workload Instances
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}
      operations:
      - name: microsoftazureworkloadinstanceget
        method: GET
        description: Microsoft Azure Gets The Workload Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadInstanceName
          in: path
          type: string
          description: Workload instance name.
          required: true
      - name: microsoftazureworkloadinstancecreate
        method: PUT
        description: Microsoft Azure Puts The Workload Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadInstanceName
          in: path
          type: string
          description: Workload instance name.
          required: true
        - name: body
          in: body
          type: string
          description: Workload instance model.
      - name: microsoftazureworkloadinstancedelete
        method: DELETE
        description: Microsoft Azure Deletes The Workload Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject Name.
          required: true
        - name: workloadInstanceName
          in: path
          type: string
          description: Workload instance name.
          required: true
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/completeMigration
      operations:
      - name: microsoftazureworkloadinstancemigratecomplete
        method: POST
        description: Microsoft Azure Performs Complete Migrate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadInstanceName
          in: path
          type: string
          description: Workload instance name.
          required: true
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/disableReplication
      operations:
      - name: microsoftazureworkloadinstancestopreplicate
        method: POST
        description: Microsoft Azure Performs Disable Replicate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadInstanceName
          in: path
          type: string
          description: Workload instance name.
          required: true
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/operations/{operationId}
      operations:
      - name: microsoftazureworkloadinstanceoperationstatusget
        method: GET
        description: Microsoft Azure Gets The Workload Instance Operation Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadInstanceName
          in: path
          type: string
          description: Workload instance name.
          required: true
        - name: operationId
          in: path
          type: string
          description: Operation Id.
          required: true
  exposes:
  - type: rest
    namespace: azure-migrate-engine-apis-workloadinstance-rest
    port: 8080
    description: REST adapter for Microsoft Azure Azure Migrate Engine APIs — WorkloadInstance. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloadinstances
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: GET
        name: microsoftazureworkloadinstancelist
        description: Microsoft Azure Lists The Workload Instances
        call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancelist
        with:
          modernizeProjectName: rest.modernizeProjectName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloadinstances/{workloadinstancename}
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: GET
        name: microsoftazureworkloadinstanceget
        description: Microsoft Azure Gets The Workload Instance
        call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstanceget
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadInstanceName: rest.workloadInstanceName
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: microsoftazureworkloadinstancecreate
        description: Microsoft Azure Puts The Workload Instance
        call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancecreate
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadInstanceName: rest.workloadInstanceName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: microsoftazureworkloadinstancedelete
        description: Microsoft Azure Deletes The Workload Instance
        call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancedelete
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadInstanceName: rest.workloadInstanceName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloadinstances/{workloadinstancename}/completemigration
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: POST
        name: microsoftazureworkloadinstancemigratecomplete
        description: Microsoft Azure Performs Complete Migrate
        call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancemigratecomplete
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadInstanceName: rest.workloadInstanceName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloadinstances/{workloadinstancename}/disablereplication
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: POST
        name: microsoftazureworkloadinstancestopreplicate
        description: Microsoft Azure Performs Disable Replicate
        call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancestopreplicate
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadInstanceName: rest.workloadInstanceName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloadinstances/{workloadinstancename}/operations/{operationid}
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: GET
        name: microsoftazureworkloadinstanceoperationstatusget
        description: Microsoft Azure Gets The Workload Instance Operation Status
        call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstanceoperationstatusget
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadInstanceName: rest.workloadInstanceName
          operationId: rest.operationId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: azure-migrate-engine-apis-workloadinstance-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Azure Azure Migrate Engine APIs — WorkloadInstance. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: microsoft-azure-lists-workload-instances
      description: Microsoft Azure Lists The Workload Instances
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancelist
      with:
        modernizeProjectName: tools.modernizeProjectName
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-gets-workload-instance
      description: Microsoft Azure Gets The Workload Instance
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstanceget
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadInstanceName: tools.workloadInstanceName
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-puts-workload-instance
      description: Microsoft Azure Puts The Workload Instance
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancecreate
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadInstanceName: tools.workloadInstanceName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-deletes-workload-instance
      description: Microsoft Azure Deletes The Workload Instance
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancedelete
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadInstanceName: tools.workloadInstanceName
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-performs-complete-migrate
      description: Microsoft Azure Performs Complete Migrate
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancemigratecomplete
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadInstanceName: tools.workloadInstanceName
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-performs-disable-replicate
      description: Microsoft Azure Performs Disable Replicate
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstancestopreplicate
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadInstanceName: tools.workloadInstanceName
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-gets-workload-instance-2
      description: Microsoft Azure Gets The Workload Instance Operation Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-migrate-engine-apis-workloadinstance.microsoftazureworkloadinstanceoperationstatusget
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadInstanceName: tools.workloadInstanceName
        operationId: tools.operationId
      outputParameters:
      - type: object
        mapping: $.