# 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 Instance API
  version: 1.0.0
extends: openapi/microsoft-azure-workloadinstance-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: 7
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workload instance
      effect: read
      questions:
      - How do I see the details of a workload instance in a modernize project?
      - What state is a workload instance in within my Azure Migrate modernization project?
      instructions:
      - text: Get workload instance {instance} in modernize project {project}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
      - text: Show workload instance {instance} of project {project} in resource group {rg}, subscription {subscription}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
          subscription: path.subscriptionId
          rg: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create a workload instance
      effect: write
      questions:
      - How do I add a workload instance to a modernize project?
      - Can I set properties and tags when creating a workload instance?
      instructions:
      - text: Create workload instance {instance} in modernize project {project}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
      - text: Create workload instance {instance} in project {project}, group {rg}, subscription {subscription} with properties {properties}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
          subscription: 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}/workloadInstances/{workloadInstanceName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workload instance
      effect: destructive
      questions:
      - Can I remove a workload instance from a modernize project?
      - How do I delete a workload instance I no longer want to migrate?
      instructions:
      - text: Delete workload instance {instance} from modernize project {project}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
      - text: Remove workload instance {instance} of project {project} in resource group {rg}, subscription {subscription}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
          subscription: path.subscriptionId
          rg: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances'].get
  update:
    x-apievangelist-phrasing:
      intent: List workload instances in a modernize project
      effect: read
      questions:
      - Which workload instances are in my modernize project?
      - What workloads have I added to an Azure Migrate modernization project?
      instructions:
      - text: List workload instances in modernize project {project}.
        slots:
          project: path.modernizeProjectName
      - text: List every workload instance of project {project} in resource group {rg}, subscription {subscription}.
        slots:
          project: path.modernizeProjectName
          subscription: path.subscriptionId
          rg: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Track an async operation on a workload instance
      effect: read
      questions:
      - How do I check the result of a long-running operation on a workload instance?
      - Did the asynchronous operation I started on my workload instance finish?
      instructions:
      - text: Get the status of operation {operation} on workload instance {instance} in project {project}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
          operation: path.operationId
      - text: Track operation {operation} for instance {instance}, project {project}, group {rg}, subscription {subscription}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
          subscription: path.subscriptionId
          rg: path.resourceGroupName
          operation: path.operationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/completeMigration'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete migration of a workload instance
      effect: write
      questions:
      - How do I finish the migration of a workload instance?
      - Can I mark a workload instance's migration as complete?
      instructions:
      - text: Complete the migration of workload instance {instance} in project {project}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
      - text: Finalize migration for instance {instance} of project {project}, resource group {rg}, subscription {subscription}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
          subscription: path.subscriptionId
          rg: path.resourceGroupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadInstances/{workloadInstanceName}/disableReplication'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable replication for a workload instance
      effect: destructive
      questions:
      - How do I turn off replication for a workload instance?
      - Can I stop replicating a workload before migrating it?
      instructions:
      - text: Disable replication for workload instance {instance} in project {project}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
      - text: Stop replicating instance {instance} of project {project} in resource group {rg}, subscription {subscription}.
        slots:
          project: path.modernizeProjectName
          instance: path.workloadInstanceName
          subscription: path.subscriptionId
          rg: path.resourceGroupName
      method: generated
      generated: '2026-09-26'