Microsoft Azure Migrate Engine APIs offer a range of functionalities to assist users in migrating their on-premises infrastructure to the cloud with ease. These APIs enable seamless connection and communication with the Azure Migrate service, allowing users to assess their workloads, discover dependencies, and generate migration plans.
swagger: '2.0'
info:
title: Microsoft Azure Azure Migrate Engine APIs
description: A first party Azure service for modernizing workloads.
version: 2022-05-01-preview
paths:
/providers/Microsoft.Migrate/operations:
get:
tags:
- Operations
description: Lists all the available API operations under this PR
operationId: microsoftAzureOperationsList
produces:
- application/json
parameters:
- $ref: >-
../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Success
schema:
$ref: >-
../../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult
default:
description: Resource provider error response about the failure.
schema:
$ref: >-
../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Operations_List_MaximumSet_Gen:
$ref: ./examples/Operations_List_MaximumSet_Gen.json
Operations_List_MinimumSet_Gen:
$ref: ./examples/Operations_List_MinimumSet_Gen.json
summary: Microsoft Azure Get Providers Microsoft Migrate Operations
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/deployedResources/{deployedResourceName}
: get:
tags:
- DeployedResource
summary: 'Microsoft Azure Gets The Deployed Resource'
description: Gets the details of the deployed resource.
operationId: microsoftAzureDeployedresourceGet
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: deployedResourceName
pattern: ^[a-z][a-z0-9]*$
description: Workload deployment name.
required: true
type: string
- $ref: '#/parameters/api-version'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/DeployedResourceModel'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-examples:
DeployedResource_Get_MaximumSet_Gen:
$ref: ./examples/DeployedResource_Get_MaximumSet_Gen.json
DeployedResource_Get_MinimumSet_Gen:
$ref: ./examples/DeployedResource_Get_MinimumSet_Gen.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/deployedResources
: get:
tags:
- DeployedResource
summary: 'Microsoft Azure Lists The Deployed Resources'
description: Gets the list of deployed resources in the given modernizeProject.
operationId: microsoftAzureDeployedresourceList
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/DeployedResourceModelCollection'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
DeployedResource_List_MaximumSet_Gen:
$ref: ./examples/DeployedResource_List_MaximumSet_Gen.json
DeployedResource_List_MinimumSet_Gen:
$ref: ./examples/DeployedResource_List_MinimumSet_Gen.json
? /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
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}
: get:
tags:
- ModernizeProject
summary: 'Microsoft Azure Gets The Modernize Project'
description: Gets the details of the modernize project.
operationId: microsoftAzureModernizeprojectGet
produces:
- application/json
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- in: path
name: modernizeProjectName
pattern: ^[a-z][a-z0-9]*$
description: Modernize project name.
required: true
type: string
- $ref: '#/parameters/api-version'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ModernizeProjectModel'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-examples:
ModernizeProject_Get_MaximumSet_Gen:
$ref: ./examples/ModernizeProject_Get_MaximumSet_Gen.json
ModernizeProject_Get_MinimumSet_Gen:
$ref: ./examples/ModernizeProject_Get_MinimumSet_Gen.json
put:
tags:
- ModernizeProject
summary: 'Microsoft Azure Puts The Modernizeproject'
description: Creates the modernizeProject.
operationId: microsoftAzureModernizeprojectCreate
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
- $ref: '#/parameters/api-version'
- in: body
name: body
description: ModernizeProject properties.
schema:
$ref: '#/definitions/ModernizeProjectModel'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/ModernizeProjectModel'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-examples:
ModernizeProject_Create_MaximumSet_Gen:
$ref: ./examples/ModernizeProject_Create_MaximumSet_Gen.json
ModernizeProject_Create_MinimumSet_Gen:
$ref: ./examples/ModernizeProject_Create_MinimumSet_Gen.json
patch:
tags:
- ModernizeProject
summary: 'Microsoft Azure Updates The Modernizeproject'
description: Performs update on the modernizeProject.
operationId: microsoftAzureModernizeprojectUpdate
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
- $ref: '#/parameters/api-version'
- in: body
name: body
description: ModernizeProject properties.
schema:
$ref: '#/definitions/UpdateModernizeProjectModel'
responses:
'202':
description: Accepted
schema:
$ref: '#/definitions/ModernizeProjectModel'
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:
ModernizeProject_Update_MaximumSet_Gen:
$ref: ./examples/ModernizeProject_Update_MaximumSet_Gen.json
ModernizeProject_Update_MinimumSet_Gen:
$ref: ./examples/ModernizeProject_Update_MinimumSet_Gen.json
delete:
tags:
- ModernizeProject
summary: 'Microsoft Azure Deletes The Modernizeproject'
description: Removes the modernizeProject.
operationId: microsoftAzureModernizeprojectDelete
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:
'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:
ModernizeProject_Delete_MaximumSet_Gen:
$ref: ./examples/ModernizeProject_Delete_MaximumSet_Gen.json
ModernizeProject_Delete_MinimumSet_Gen:
$ref: ./examples/ModernizeProject_Delete_MinimumSet_Gen.json
/subscriptions/{subscriptionId}/providers/Microsoft.Migrate/modernizeProjects:
get:
tags:
- ModernizeProject
summary: 'Microsoft Azure Lists The Modernizeprojects'
description: Gets the list of modernizeProjects in the given subscription.
operationId: microsoftAzureModernizeprojectListbysubscription
produces:
- application/json
parameters:
- $ref: '#/parameters/subscriptionId'
- in: query
name: continuationToken
description: Continuation token from the previous call.
type: string
- $ref: '#/parameters/api-version'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ModernizeProjectModelCollection'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
ModernizeProject_ListBySubscription_MaximumSet_Gen:
$ref: ./examples/ModernizeProject_ListBySubscription_MaximumSet_Gen.json
ModernizeProject_ListBySubscription_MinimumSet_Gen:
$ref: ./examples/ModernizeProject_ListBySubscription_MinimumSet_Gen.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects:
get:
tags:
- ModernizeProject
summary: 'Microsoft Azure Lists The Modernizeprojects'
description: >-
Gets the list of modernizeProjects in the given subscription and
resource group.
operationId: microsoftAzureModernizeprojectList
produces:
- application/json
parameters:
- $ref: '#/parameters/subscriptionId'
- $ref: '#/parameters/resourceGroupName'
- in: query
name: continuationToken
description: Continuation token from the previous call.
type: string
- $ref: '#/parameters/api-version'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/ModernizeProjectModelCollection'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
ModernizeProject_List_MaximumSet_Gen:
$ref: ./examples/ModernizeProject_List_MaximumSet_Gen.json
ModernizeProject_List_MinimumSet_Gen:
$ref: ./examples/ModernizeProject_List_MinimumSet_Gen.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/statistics
: get:
tags:
- ModernizeProject
summary: 'Microsoft Azure Gets The Modernizeproject Statistics'
description: Gets the statistics for the modernizeProject.
operationId: microsoftAzureModernizeprojectstatisticsGet
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/ModernizeProjectStatisticsModel'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-examples:
ModernizeProjectStatistics_Get_MaximumSet_Gen:
$ref: ./examples/ModernizeProjectStatistics_Get_MaximumSet_Gen.json
ModernizeProjectStatistics_Get_MinimumSet_Gen:
$ref: ./examples/ModernizeProjectStatistics_Get_MinimumSet_Gen.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/operations/{operationId}
: get:
tags:
- ModernizeProject
summary: 'Microsoft Azure Gets The Modernizeproject Operation Status'
description: Tracks the results of an asynchronous operation on the modernizeProject.
operationId: microsoftAzureModernizeprojectoperationstatusGet
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: operationId
description: Operation Id.
required: true
type: string
- in: query
name: OperationType
description: The operation type.
type: string
- $ref: '#/parameters/api-version'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/OperationStatus'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-examples:
ModernizeProjectOperationStatus_Get_MaximumSet_Gen:
$ref: ./examples/ModernizeProjectOperationStatus_Get_MaximumSet_Gen.json
ModernizeProjectOperationStatus_Get_MinimumSet_Gen:
$ref: ./examples/ModernizeProjectOperationStatus_Get_MinimumSet_Gen.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs/{workflowName}
: get:
tags:
- Workflow
summary: 'Microsoft Azure Gets The Workflow'
description: Gets the details of the job.
operationId: microsoftAzureWorkflowGet
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: workflowName
pattern: ^[a-z][a-z0-9]*$
description: Workflow name.
required: true
type: string
- $ref: '#/parameters/api-version'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/WorkflowModel'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-examples:
Workflow_Get_MaximumSet_Gen:
$ref: ./examples/Workflow_Get_MaximumSet_Gen.json
Workflow_Get_MinimumSet_Gen:
$ref: ./examples/Workflow_Get_MinimumSet_Gen.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs
: get:
tags:
- Workflow
summary: 'Microsoft Azure Lists The Workflows'
description: Gets the list of jobs in the given modernizeProject.
operationId: microsoftAzureWorkflowList
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: query
name: $filter
description: Filter string.
type: string
- in: query
name: continuationToken
description: Continuation token.
type: string
- $ref: '#/parameters/api-version'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/WorkflowModelCollection'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-pageable:
nextLinkName: nextLink
x-ms-examples:
Workflow_List_MaximumSet_Gen:
$ref: ./examples/Workflow_List_MaximumSet_Gen.json
Workflow_List_MinimumSet_Gen:
$ref: ./examples/Workflow_List_MinimumSet_Gen.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/jobs/{workflowName}/operations/{operationId}
: get:
tags:
- Workflow
summary: 'Microsoft Azure Gets The Workflow Operation Status'
description: Tracks the results of an asynchronous operation on the job.
operationId: microsoftAzureWorkflowoperationstatusGet
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: workflowName
pattern: ^[a-z][a-z0-9]*$
description: Workflow 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:
WorkflowOperationStatus_Get_MaximumSet_Gen:
$ref: ./examples/WorkflowOperationStatus_Get_MaximumSet_Gen.json
WorkflowOperationStatus_Get_MinimumSet_Gen:
$ref: ./examples/WorkflowOperationStatus_Get_MinimumSet_Gen.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/modernizeProjects/{modernizeProjectName}/workloadDeployments/{workloadDeploymentName}
: get:
tags:
- WorkloadDeployment
summary: 'Microsoft Azure Gets The Workload Deployment'
description: Gets the details of the workload deployment.
operationId: microsoftAzureWorkloaddeploymentGet
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: workloadDeploymentName
pattern: ^[a-z][a-z0-9]*$
description: Workload deployment name.
required: true
type: string
- $ref: '#/parameters/api-version'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/WorkloadDeploymentModel'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-examples:
WorkloadDeployment_Get_MaximumSet_Gen:
$ref: ./examples/WorkloadDeployment_Get_MaximumSet_Gen.json
WorkloadDeployment_Get_MinimumSet_Gen:
$ref: ./examples/WorkloadDeployment_Get_MinimumSet_Gen.json
put:
tags:
- WorkloadDeployment
summary: 'Microsoft Azure Puts The Workload Deployment'
description: Creates the workload deployment.
operationId: microsoftAzureWorkloaddeploymentCreate
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: workloadDeploymentName
pattern: ^[a-z][a-z0-9]*$
description: Workload deployment name.
required: true
type: string
- $ref: '#/parameters/api-version'
- in: body
name: body
description: Workload deployment model.
schema:
$ref: '#/definitions/WorkloadDeploymentModel'
responses:
'201':
description: Created
schema:
$ref: '#/definitions/WorkloadDeploymentModel'
default:
description: Error
schema:
$ref: '#/definitions/ArmError'
x-ms-examples:
WorkloadDeployment_Create_MaximumSet_Gen:
$ref: ./examples/WorkloadDeployment_Create_MaximumSet_Gen.json
WorkloadDeployment_Create_MinimumSet_Gen:
$ref: ./examples/WorkloadDeployment_Create_MinimumSet_Gen.json
delete:
tags:
- WorkloadDeployment
summary: 'Microsoft Azure Deletes The Workload Deployment'
description: Removes the workload deployment.
operationId: microsoftAzureWorkloaddeploymentDelete
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: workloadDeploymentName
pattern: ^[a-z][a-z0-9]*$
description: Workload deployment name.
required: true
type: string
- in: query
name: forceDelete
description: A flag indicating whether to do force delete or not.
type: boolean
- $ref: '#/parameters/api-version'
responses:
# --- truncated at 32 KB (125 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azure-migrate-engine-apis-openapi-original.yml