# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Azure Migrate Engine Workload Deployment API
  version: 1.0.0
extends: openapi/microsoft-azure-workloaddeployment-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workload deployment
      effect: read
      questions:
      - What is the current state of a workload deployment in my Azure Migrate modernize project?
      - How do I see the target settings of one workload deployment?
      instructions:
      - text: Get workload deployment {deployment} in modernize project {project}, resource group {rg}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Show details for workload deployment {deployment} in subscription {sub}, group {rg}, project {project}.
        slots:
          deployment: path.workloadDeploymentName
          sub: path.subscriptionId
          rg: path.resourceGroupName
          project: path.modernizeProjectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a workload deployment
      effect: write
      questions:
      - How do I set up a workload deployment to modernize an app into containers?
      - Can I tag a workload deployment when I create it?
      instructions:
      - text: Create workload deployment {deployment} in modernize project {project}, resource group {rg}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Add a workload deployment {deployment} to project {project} in subscription {sub}, group {rg} with {properties}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          sub: path.subscriptionId
          rg: path.resourceGroupName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a workload deployment
      effect: destructive
      questions:
      - How do I delete a workload deployment from my modernize project?
      - Can I force-delete a workload deployment that is stuck?
      instructions:
      - text: Delete workload deployment {deployment} from modernize project {project}, resource group {rg}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Force-remove workload deployment {deployment} in project {project}, subscription {sub}, group {rg} with forceDelete {force}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          sub: path.subscriptionId
          rg: path.resourceGroupName
          force: query.forceDelete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List workload deployments in a modernize project
      effect: read
      questions:
      - Which workload deployments exist in my modernize project?
      - Can I list all apps queued for modernization in one project?
      instructions:
      - text: List workload deployments in modernize project {project}, resource group {rg}.
        slots:
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Show every workload deployment under project {project} in subscription {sub}, group {rg}.
        slots:
          project: path.modernizeProjectName
          sub: path.subscriptionId
          rg: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/getSecrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a workload deployment's secrets
      effect: read
      questions:
      - How do I retrieve the secret configuration stored for a workload deployment?
      - Where can I read the secrets a modernized workload will use?
      instructions:
      - text: Get the secrets of workload deployment {deployment} in project {project}, resource group {rg}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Fetch secret configurations for deployment {deployment} in subscription {sub}, group {rg}, project {project}.
        slots:
          deployment: path.workloadDeploymentName
          sub: path.subscriptionId
          rg: path.resourceGroupName
          project: path.modernizeProjectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/buildContainerImage'].post
  update:
    x-apievangelist-phrasing:
      intent: Build a container image for a workload
      effect: write
      questions:
      - How do I build a container image from a workload I am modernizing?
      - Can Azure Migrate containerize my app as part of a workload deployment?
      instructions:
      - text: Build the container image for workload deployment {deployment} in project {project}, resource group {rg}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Run the container image build on deployment {deployment} in subscription {sub}, group {rg}, project {project} with {properties}.
        slots:
          deployment: path.workloadDeploymentName
          sub: path.subscriptionId
          rg: path.resourceGroupName
          project: path.modernizeProjectName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/testMigrate'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a test migration of a workload
      effect: write
      questions:
      - How do I trial a migration of a workload before cutting over?
      - Can I test-migrate a workload deployment without affecting production?
      instructions:
      - text: Start a test migrate of workload deployment {deployment} in project {project}, resource group {rg}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Trial-migrate deployment {deployment} in subscription {sub}, group {rg}, project {project} using {properties}.
        slots:
          deployment: path.workloadDeploymentName
          sub: path.subscriptionId
          rg: path.resourceGroupName
          project: path.modernizeProjectName
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/testMigrateCleanup'].post
  update:
    x-apievangelist-phrasing:
      intent: Clean up after a test migration
      effect: destructive
      questions:
      - How do I tear down the resources left by a test migration?
      - What should I run once I am done validating a test-migrated workload?
      instructions:
      - text: Clean up the test migration of workload deployment {deployment} in project {project}, resource group {rg}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Remove test-migrate resources for deployment {deployment} in subscription {sub}, group {rg}, project {project}.
        slots:
          deployment: path.workloadDeploymentName
          sub: path.subscriptionId
          rg: path.resourceGroupName
          project: path.modernizeProjectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/migrate'].post
  update:
    x-apievangelist-phrasing:
      intent: Migrate a workload for real
      effect: write
      questions:
      - How do I perform the final migration of a modernized workload?
      - Can I cut over a workload deployment once the test migrate passed?
      instructions:
      - text: Migrate workload deployment {deployment} in project {project}, resource group {rg}.
        slots:
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Perform the production cutover for deployment {deployment} in subscription {sub}, group {rg}, project {project}.
        slots:
          deployment: path.workloadDeploymentName
          sub: path.subscriptionId
          rg: path.resourceGroupName
          project: path.modernizeProjectName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Track a workload deployment operation
      effect: read
      questions:
      - Did my async migrate or build operation on a workload deployment succeed?
      - How do I poll a long-running workload deployment operation?
      instructions:
      - text: Get the status of operation {operation} on workload deployment {deployment} in project {project}, resource group {rg}.
        slots:
          operation: path.operationId
          deployment: path.workloadDeploymentName
          project: path.modernizeProjectName
          rg: path.resourceGroupName
      - text: Poll async operation {operation} for deployment {deployment} in subscription {sub}, group {rg}, project {project}.
        slots:
          operation: path.operationId
          deployment: path.workloadDeploymentName
          sub: path.subscriptionId
          rg: path.resourceGroupName
          project: path.modernizeProjectName
      method: generated
      generated: '2026-09-26'