Microsoft Azure Azure Migrate Engine APIs — WorkloadDeployment

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Azure Azure Migrate Engine APIs — WorkloadDeployment
  description: 'Microsoft Azure Azure Migrate Engine APIs — WorkloadDeployment. 10 operations. Lead operation: Microsoft Azure
    Lists The Workload Deployments. Self-contained Naftiko capability covering one Microsoft Azure business surface.'
  tags:
  - Microsoft Azure
  - WorkloadDeployment
  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-workloaddeployment
    baseUri: ''
    description: Microsoft Azure Azure Migrate Engine APIs — WorkloadDeployment 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}/workloadDeployments
      operations:
      - name: microsoftazureworkloaddeploymentlist
        method: GET
        description: Microsoft Azure Lists The Workload Deployments
        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}/workloadDeployments/{workloadDeploymentName}
      operations:
      - name: microsoftazureworkloaddeploymentget
        method: GET
        description: Microsoft Azure Gets The Workload Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadDeploymentName
          in: path
          type: string
          description: Workload deployment name.
          required: true
      - name: microsoftazureworkloaddeploymentcreate
        method: PUT
        description: Microsoft Azure Puts The Workload Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadDeploymentName
          in: path
          type: string
          description: Workload deployment name.
          required: true
        - name: body
          in: body
          type: string
          description: Workload deployment model.
      - name: microsoftazureworkloaddeploymentdelete
        method: DELETE
        description: Microsoft Azure Deletes The Workload Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadDeploymentName
          in: path
          type: string
          description: Workload deployment name.
          required: true
        - name: forceDelete
          in: query
          type: boolean
          description: A flag indicating whether to do force delete or not.
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/buildContainerImage
      operations:
      - name: microsoftazureworkloaddeploymentbuildcontainerimage
        method: POST
        description: Microsoft Azure Build Container Image
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadDeploymentName
          in: path
          type: string
          description: Workload deployment name.
          required: true
        - name: body
          in: body
          type: string
          description: Build container image model.
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/getSecrets
      operations:
      - name: microsoftazureworkloaddeploymentgetsecretconfigurations
        method: POST
        description: Microsoft Azure Gets The Workload Deployment Secrets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadDeploymentName
          in: path
          type: string
          description: Workload deployment name.
          required: true
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/migrate
      operations:
      - name: microsoftazureworkloaddeploymentmigrate
        method: POST
        description: Microsoft Azure Performs Migrate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadDeploymentName
          in: path
          type: string
          description: Workload deployment name.
          required: true
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/operations/{operationId}
      operations:
      - name: microsoftazureworkloaddeploymentoperationstatusget
        method: GET
        description: Microsoft Azure Gets The Workload Deployment Operation Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadDeploymentName
          in: path
          type: string
          description: Protected Item name.
          required: true
        - name: operationId
          in: path
          type: string
          description: Operation Id.
          required: true
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/testMigrate
      operations:
      - name: microsoftazureworkloaddeploymenttestmigrate
        method: POST
        description: Microsoft Azure Performs Test Migrate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadDeploymentName
          in: path
          type: string
          description: Workload deployment name.
          required: true
        - name: body
          in: body
          type: string
          description: Test migrate model.
    - name: subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof
      path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/testMigrateCleanup
      operations:
      - name: microsoftazureworkloaddeploymenttestmigratecleanup
        method: POST
        description: Microsoft Azure Performs Test Migrate Cleanup
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: modernizeProjectName
          in: path
          type: string
          description: ModernizeProject name.
          required: true
        - name: workloadDeploymentName
          in: path
          type: string
          description: Workload deployment name.
          required: true
  exposes:
  - type: rest
    namespace: azure-migrate-engine-apis-workloaddeployment-rest
    port: 8080
    description: REST adapter for Microsoft Azure Azure Migrate Engine APIs — WorkloadDeployment. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloaddeployments
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: GET
        name: microsoftazureworkloaddeploymentlist
        description: Microsoft Azure Lists The Workload Deployments
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentlist
        with:
          modernizeProjectName: rest.modernizeProjectName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloaddeployments/{workloaddeploymentname}
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: GET
        name: microsoftazureworkloaddeploymentget
        description: Microsoft Azure Gets The Workload Deployment
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentget
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadDeploymentName: rest.workloadDeploymentName
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: microsoftazureworkloaddeploymentcreate
        description: Microsoft Azure Puts The Workload Deployment
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentcreate
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadDeploymentName: rest.workloadDeploymentName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: microsoftazureworkloaddeploymentdelete
        description: Microsoft Azure Deletes The Workload Deployment
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentdelete
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadDeploymentName: rest.workloadDeploymentName
          forceDelete: rest.forceDelete
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloaddeployments/{workloaddeploymentname}/buildcontainerimage
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: POST
        name: microsoftazureworkloaddeploymentbuildcontainerimage
        description: Microsoft Azure Build Container Image
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentbuildcontainerimage
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadDeploymentName: rest.workloadDeploymentName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloaddeployments/{workloaddeploymentname}/getsecrets
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: POST
        name: microsoftazureworkloaddeploymentgetsecretconfigurations
        description: Microsoft Azure Gets The Workload Deployment Secrets
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentgetsecretconfigurations
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadDeploymentName: rest.workloadDeploymentName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloaddeployments/{workloaddeploymentname}/migrate
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: POST
        name: microsoftazureworkloaddeploymentmigrate
        description: Microsoft Azure Performs Migrate
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentmigrate
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadDeploymentName: rest.workloadDeploymentName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloaddeployments/{workloaddeploymentname}/operations/{operationid}
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: GET
        name: microsoftazureworkloaddeploymentoperationstatusget
        description: Microsoft Azure Gets The Workload Deployment Operation Status
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentoperationstatusget
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadDeploymentName: rest.workloadDeploymentName
          operationId: rest.operationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloaddeployments/{workloaddeploymentname}/testmigrate
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: POST
        name: microsoftazureworkloaddeploymenttestmigrate
        description: Microsoft Azure Performs Test Migrate
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymenttestmigrate
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadDeploymentName: rest.workloadDeploymentName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}/resourcegroups/{resourcegroupname}/providers/microsoft-migrate/modernizeprojects/{modernizeprojectname}/workloaddeployments/{workloaddeploymentname}/testmigratecleanup
      name: subscriptions-subscriptionid-resourcegroups-resourcegroupname-providers-microsof
      description: REST surface for subscriptions-subscriptionId-resourceGroups-resourceGroupName-providers-Microsof.
      operations:
      - method: POST
        name: microsoftazureworkloaddeploymenttestmigratecleanup
        description: Microsoft Azure Performs Test Migrate Cleanup
        call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymenttestmigratecleanup
        with:
          modernizeProjectName: rest.modernizeProjectName
          workloadDeploymentName: rest.workloadDeploymentName
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: azure-migrate-engine-apis-workloaddeployment-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Azure Azure Migrate Engine APIs — WorkloadDeployment. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: microsoft-azure-lists-workload-deployments
      description: Microsoft Azure Lists The Workload Deployments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentlist
      with:
        modernizeProjectName: tools.modernizeProjectName
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-gets-workload-deployment
      description: Microsoft Azure Gets The Workload Deployment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentget
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadDeploymentName: tools.workloadDeploymentName
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-puts-workload-deployment
      description: Microsoft Azure Puts The Workload Deployment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentcreate
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadDeploymentName: tools.workloadDeploymentName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-deletes-workload-deployment
      description: Microsoft Azure Deletes The Workload Deployment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentdelete
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadDeploymentName: tools.workloadDeploymentName
        forceDelete: tools.forceDelete
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-build-container-image
      description: Microsoft Azure Build Container Image
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentbuildcontainerimage
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadDeploymentName: tools.workloadDeploymentName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-gets-workload-deployment-2
      description: Microsoft Azure Gets The Workload Deployment Secrets
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentgetsecretconfigurations
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadDeploymentName: tools.workloadDeploymentName
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-performs-migrate
      description: Microsoft Azure Performs Migrate
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentmigrate
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadDeploymentName: tools.workloadDeploymentName
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-gets-workload-deployment-3
      description: Microsoft Azure Gets The Workload Deployment Operation Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymentoperationstatusget
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadDeploymentName: tools.workloadDeploymentName
        operationId: tools.operationId
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-performs-test-migrate
      description: Microsoft Azure Performs Test Migrate
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymenttestmigrate
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadDeploymentName: tools.workloadDeploymentName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-azure-performs-test-migrate-2
      description: Microsoft Azure Performs Test Migrate Cleanup
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: azure-migrate-engine-apis-workloaddeployment.microsoftazureworkloaddeploymenttestmigratecleanup
      with:
        modernizeProjectName: tools.modernizeProjectName
        workloadDeploymentName: tools.workloadDeploymentName
      outputParameters:
      - type: object
        mapping: $.