Microsoft.Migrate (preview:2025-03-30)

2025/11/05 • 19 new methods

Operations_List (new)
Description :  List the operations for the provider
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of operations supported by the resource provider ,
Required: False ,
}
[
{
name:
{
Description: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: "Microsoft.Compute/virtualMachines/write", "Microsoft.Compute/virtualMachines/capture/action" ,
Required: False ,
}
string ,
isDataAction:
{
Description: Whether the operation applies to data-plane. This is "true" for data-plane operations and "false" for ARM/control-plane operations. ,
Required: False ,
}
boolean ,
display:
{
Description: Localized display information for this particular operation. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name, e.g. "Microsoft Monitoring Insights" or "Microsoft Compute". ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly name of the resource type related to this operation. E.g. "Virtual Machines" or "Job Schedule Collections". ,
Required: False ,
}
string ,
operation:
{
Description: The concise, localized friendly name for the operation; suitable for dropdowns. E.g. "Create or Update Virtual Machine", "Restart Virtual Machine". ,
Required: False ,
}
string ,
description:
{
Description: The short, localized friendly description of the operation; suitable for tool tips and detailed views. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" ,
Enum:
{
user: No description available. ,
system: No description available. ,
user,system: No description available. ,
}
,
Required: False ,
}
enum ,
actionType:
{
Description: Enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. ,
Enum:
{
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results (if there are any). ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationEntities_ListByParent (new)
Description :  List MigrationEntity resources by MigrateProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntities
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MigrationEntity items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
partnerResourceArmId:
{
Description: ARM Resource Identifier for the partner resource. ,
Required: False ,
}
string ,
targetAzureResourceArmId:
{
Description: target Azure Resource ARM Id. ,
Required: False ,
}
string ,
associatedInventoryResourceId:
{
Description: inventory resource id ,
Required: True ,
}
string ,
inventoryDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedMigrationEntityGroupIds:
{
Description: associated Migration Entity Group Id ,
Required: False ,
}
[
string ,
]
,
executionStartDate:
{
Description: Execution start date for Migration Entity. ,
Format: date-time ,
Required: False ,
}
string ,
target:
{
Description: Target of the Migration Entity. ,
Required: False ,
}
string ,
migrationStrategy:
{
Description: Strategy of Migration Entity. ,
Enum:
{
None: No specific strategy defined. ,
Rehost: Rehost: Also known as 'lift and shift', this strategy involves moving existing applications to Azure without modification. ,
Refactor: Refactor: Often referred to as 'lift, tinker, and shift', this involves making minor modifications to the application to take advantage of Azure's cloud capabilities. ,
Rearchitect: Rearchitect: This approach involves significant changes to the application's architecture to fully utilize cloud-native features and scalability of Azure. ,
Rebuild: Rebuild: Involves completely redesigning and rewriting the application from scratch to be cloud-native, leveraging Azure's advanced services. ,
Replace: Replace: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retire: Retire: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retain: Retain: Keeping certain applications in the current environment when they are not suitable for cloud migration or when the timing is not right. ,
Replatform: Replatform: This strategy involves making more substantial changes to the application. ,
}
,
Required: False ,
}
enum ,
executionStage:
{
Description: Execution Stage of Migration Entity. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Execution Status of Migration Entity. ,
Required: False ,
}
string ,
executionReadiness:
{
Description: Execution Readiness of Migration Entity. ,
Required: False ,
}
string ,
migrationSpecificProperties:
{
Description: Migration specific properties for the entity. ,
Required: False ,
}
{
instanceType:
{
Description: Discriminator for migration specific properties. ,
Enum:
{
ServerMigration: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
migrationTool:
{
Description: Migration Tool of the Migration Entity. ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
assessedEntityArmId:
{
Description: Assessed Entity ARM Id ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationEntities_Get (new)
Description :  Get a MigrationEntity
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntities/{migrationEntityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
migrationEntityName:
{
Description: Migration Entity ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
partnerResourceArmId:
{
Description: ARM Resource Identifier for the partner resource. ,
Required: False ,
}
string ,
targetAzureResourceArmId:
{
Description: target Azure Resource ARM Id. ,
Required: False ,
}
string ,
associatedInventoryResourceId:
{
Description: inventory resource id ,
Required: True ,
}
string ,
inventoryDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedMigrationEntityGroupIds:
{
Description: associated Migration Entity Group Id ,
Required: False ,
}
[
string ,
]
,
executionStartDate:
{
Description: Execution start date for Migration Entity. ,
Format: date-time ,
Required: False ,
}
string ,
target:
{
Description: Target of the Migration Entity. ,
Required: False ,
}
string ,
migrationStrategy:
{
Description: Strategy of Migration Entity. ,
Enum:
{
None: No specific strategy defined. ,
Rehost: Rehost: Also known as 'lift and shift', this strategy involves moving existing applications to Azure without modification. ,
Refactor: Refactor: Often referred to as 'lift, tinker, and shift', this involves making minor modifications to the application to take advantage of Azure's cloud capabilities. ,
Rearchitect: Rearchitect: This approach involves significant changes to the application's architecture to fully utilize cloud-native features and scalability of Azure. ,
Rebuild: Rebuild: Involves completely redesigning and rewriting the application from scratch to be cloud-native, leveraging Azure's advanced services. ,
Replace: Replace: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retire: Retire: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retain: Retain: Keeping certain applications in the current environment when they are not suitable for cloud migration or when the timing is not right. ,
Replatform: Replatform: This strategy involves making more substantial changes to the application. ,
}
,
Required: False ,
}
enum ,
executionStage:
{
Description: Execution Stage of Migration Entity. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Execution Status of Migration Entity. ,
Required: False ,
}
string ,
executionReadiness:
{
Description: Execution Readiness of Migration Entity. ,
Required: False ,
}
string ,
migrationSpecificProperties:
{
Description: Migration specific properties for the entity. ,
Required: False ,
}
{
instanceType:
{
Description: Discriminator for migration specific properties. ,
Enum:
{
ServerMigration: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
migrationTool:
{
Description: Migration Tool of the Migration Entity. ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
assessedEntityArmId:
{
Description: Assessed Entity ARM Id ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationEntities_Create (new)
Description :  Create a MigrationEntity
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntities/{migrationEntityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
migrationEntityName:
{
Description: Migration Entity ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
partnerResourceArmId:
{
Description: ARM Resource Identifier for the partner resource. ,
Required: False ,
}
string ,
targetAzureResourceArmId:
{
Description: target Azure Resource ARM Id. ,
Required: False ,
}
string ,
associatedInventoryResourceId:
{
Description: inventory resource id ,
Required: True ,
}
string ,
inventoryDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedMigrationEntityGroupIds:
{
Description: associated Migration Entity Group Id ,
Required: False ,
}
[
string ,
]
,
executionStartDate:
{
Description: Execution start date for Migration Entity. ,
Format: date-time ,
Required: False ,
}
string ,
target:
{
Description: Target of the Migration Entity. ,
Required: False ,
}
string ,
migrationStrategy:
{
Description: Strategy of Migration Entity. ,
Enum:
{
None: No specific strategy defined. ,
Rehost: Rehost: Also known as 'lift and shift', this strategy involves moving existing applications to Azure without modification. ,
Refactor: Refactor: Often referred to as 'lift, tinker, and shift', this involves making minor modifications to the application to take advantage of Azure's cloud capabilities. ,
Rearchitect: Rearchitect: This approach involves significant changes to the application's architecture to fully utilize cloud-native features and scalability of Azure. ,
Rebuild: Rebuild: Involves completely redesigning and rewriting the application from scratch to be cloud-native, leveraging Azure's advanced services. ,
Replace: Replace: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retire: Retire: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retain: Retain: Keeping certain applications in the current environment when they are not suitable for cloud migration or when the timing is not right. ,
Replatform: Replatform: This strategy involves making more substantial changes to the application. ,
}
,
Required: False ,
}
enum ,
executionStage:
{
Description: Execution Stage of Migration Entity. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Execution Status of Migration Entity. ,
Required: False ,
}
string ,
executionReadiness:
{
Description: Execution Readiness of Migration Entity. ,
Required: False ,
}
string ,
migrationSpecificProperties:
{
Description: Migration specific properties for the entity. ,
Required: False ,
}
{
instanceType:
{
Description: Discriminator for migration specific properties. ,
Enum:
{
ServerMigration: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
migrationTool:
{
Description: Migration Tool of the Migration Entity. ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
assessedEntityArmId:
{
Description: Assessed Entity ARM Id ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
partnerResourceArmId:
{
Description: ARM Resource Identifier for the partner resource. ,
Required: False ,
}
string ,
targetAzureResourceArmId:
{
Description: target Azure Resource ARM Id. ,
Required: False ,
}
string ,
associatedInventoryResourceId:
{
Description: inventory resource id ,
Required: True ,
}
string ,
inventoryDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedMigrationEntityGroupIds:
{
Description: associated Migration Entity Group Id ,
Required: False ,
}
[
string ,
]
,
executionStartDate:
{
Description: Execution start date for Migration Entity. ,
Format: date-time ,
Required: False ,
}
string ,
target:
{
Description: Target of the Migration Entity. ,
Required: False ,
}
string ,
migrationStrategy:
{
Description: Strategy of Migration Entity. ,
Enum:
{
None: No specific strategy defined. ,
Rehost: Rehost: Also known as 'lift and shift', this strategy involves moving existing applications to Azure without modification. ,
Refactor: Refactor: Often referred to as 'lift, tinker, and shift', this involves making minor modifications to the application to take advantage of Azure's cloud capabilities. ,
Rearchitect: Rearchitect: This approach involves significant changes to the application's architecture to fully utilize cloud-native features and scalability of Azure. ,
Rebuild: Rebuild: Involves completely redesigning and rewriting the application from scratch to be cloud-native, leveraging Azure's advanced services. ,
Replace: Replace: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retire: Retire: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retain: Retain: Keeping certain applications in the current environment when they are not suitable for cloud migration or when the timing is not right. ,
Replatform: Replatform: This strategy involves making more substantial changes to the application. ,
}
,
Required: False ,
}
enum ,
executionStage:
{
Description: Execution Stage of Migration Entity. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Execution Status of Migration Entity. ,
Required: False ,
}
string ,
executionReadiness:
{
Description: Execution Readiness of Migration Entity. ,
Required: False ,
}
string ,
migrationSpecificProperties:
{
Description: Migration specific properties for the entity. ,
Required: False ,
}
{
instanceType:
{
Description: Discriminator for migration specific properties. ,
Enum:
{
ServerMigration: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
migrationTool:
{
Description: Migration Tool of the Migration Entity. ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
assessedEntityArmId:
{
Description: Assessed Entity ARM Id ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Migration Entity resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
partnerResourceArmId:
{
Description: ARM Resource Identifier for the partner resource. ,
Required: False ,
}
string ,
targetAzureResourceArmId:
{
Description: target Azure Resource ARM Id. ,
Required: False ,
}
string ,
associatedInventoryResourceId:
{
Description: inventory resource id ,
Required: True ,
}
string ,
inventoryDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedMigrationEntityGroupIds:
{
Description: associated Migration Entity Group Id ,
Required: False ,
}
[
string ,
]
,
executionStartDate:
{
Description: Execution start date for Migration Entity. ,
Format: date-time ,
Required: False ,
}
string ,
target:
{
Description: Target of the Migration Entity. ,
Required: False ,
}
string ,
migrationStrategy:
{
Description: Strategy of Migration Entity. ,
Enum:
{
None: No specific strategy defined. ,
Rehost: Rehost: Also known as 'lift and shift', this strategy involves moving existing applications to Azure without modification. ,
Refactor: Refactor: Often referred to as 'lift, tinker, and shift', this involves making minor modifications to the application to take advantage of Azure's cloud capabilities. ,
Rearchitect: Rearchitect: This approach involves significant changes to the application's architecture to fully utilize cloud-native features and scalability of Azure. ,
Rebuild: Rebuild: Involves completely redesigning and rewriting the application from scratch to be cloud-native, leveraging Azure's advanced services. ,
Replace: Replace: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retire: Retire: This strategy involves discarding the existing application and replacing it with a new Azure solution or a SaaS platform. ,
Retain: Retain: Keeping certain applications in the current environment when they are not suitable for cloud migration or when the timing is not right. ,
Replatform: Replatform: This strategy involves making more substantial changes to the application. ,
}
,
Required: False ,
}
enum ,
executionStage:
{
Description: Execution Stage of Migration Entity. ,
Required: False ,
}
string ,
executionStatus:
{
Description: Execution Status of Migration Entity. ,
Required: False ,
}
string ,
executionReadiness:
{
Description: Execution Readiness of Migration Entity. ,
Required: False ,
}
string ,
migrationSpecificProperties:
{
Description: Migration specific properties for the entity. ,
Required: False ,
}
{
instanceType:
{
Description: Discriminator for migration specific properties. ,
Enum:
{
ServerMigration: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
migrationTool:
{
Description: Migration Tool of the Migration Entity. ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
assessedEntityArmId:
{
Description: Assessed Entity ARM Id ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationEntities_Delete (new)
Description :  Delete a MigrationEntity
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntities/{migrationEntityName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
migrationEntityName:
{
Description: Migration Entity ARM name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationEntityGroups_ListByParent (new)
Description :  List MigrationEntityGroup resources by MigrateProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntityGroups
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The MigrationEntityGroup items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
applicationId:
{
Description: Application id ,
Required: True ,
}
string ,
applicationDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveIds:
{
Description: associated Wave Id ,
Required: False ,
}
[
string ,
]
,
executionStatus:
{
Description: Migration Entity Group Status ,
Required: False ,
}
string ,
executionStartDate:
{
Description: Execution Start Date ,
Format: date-time ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationEntityGroups_Get (new)
Description :  Get a MigrationEntityGroup
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntityGroups/{migrationEntityGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
migrationEntityGroupName:
{
Description: Migration Entity Group ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
applicationId:
{
Description: Application id ,
Required: True ,
}
string ,
applicationDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveIds:
{
Description: associated Wave Id ,
Required: False ,
}
[
string ,
]
,
executionStatus:
{
Description: Migration Entity Group Status ,
Required: False ,
}
string ,
executionStartDate:
{
Description: Execution Start Date ,
Format: date-time ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationEntityGroups_Create (new)
Description :  Create a MigrationEntityGroup
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntityGroups/{migrationEntityGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
migrationEntityGroupName:
{
Description: Migration Entity Group ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
applicationId:
{
Description: Application id ,
Required: True ,
}
string ,
applicationDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveIds:
{
Description: associated Wave Id ,
Required: False ,
}
[
string ,
]
,
executionStatus:
{
Description: Migration Entity Group Status ,
Required: False ,
}
string ,
executionStartDate:
{
Description: Execution Start Date ,
Format: date-time ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
applicationId:
{
Description: Application id ,
Required: True ,
}
string ,
applicationDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveIds:
{
Description: associated Wave Id ,
Required: False ,
}
[
string ,
]
,
executionStatus:
{
Description: Migration Entity Group Status ,
Required: False ,
}
string ,
executionStartDate:
{
Description: Execution Start Date ,
Format: date-time ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Migration Entity Group resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
applicationId:
{
Description: Application id ,
Required: True ,
}
string ,
applicationDisplayName:
{
Description: Display Name of the Workload. ,
Required: True ,
}
string ,
associatedAssessmentId:
{
Description: Associated Assessment Id ,
Format: arm-id ,
Required: False ,
}
string ,
associatedWaveIds:
{
Description: associated Wave Id ,
Required: False ,
}
[
string ,
]
,
executionStatus:
{
Description: Migration Entity Group Status ,
Required: False ,
}
string ,
executionStartDate:
{
Description: Execution Start Date ,
Format: date-time ,
Required: False ,
}
string ,
migrationPath:
{
Description: Migration path ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MigrationEntityGroups_Delete (new)
Description :  Delete a MigrationEntityGroup
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/migrationEntityGroups/{migrationEntityGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
migrationEntityGroupName:
{
Description: Migration Entity Group ARM name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tasks_GetSummary (new)
Description :  Retrieves task summary across all tasks in the project.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/taskSummary
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
body:
{
Description: The content of the action request ,
Required: True ,
}
{
scopeId:
{
Description: Task Scope ARM Id ,
Format: arm-id ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
items:
{
Description: List of Task Summary Items ,
Required: True ,
}
[
{
stage:
{
Description: Task Stage ,
Required: True ,
}
string ,
aggregatedStatus:
{
Description: Aggregated status of tasks in this stage. ,
Required: True ,
}
string ,
statusCounts:
{
Description: Counts of tasks in this stage by status. ,
Required: True ,
}
{
statusCounts:
{
Description: Status counts dictionary mapping TaskStatus to the count of tasks with that status. ,
Required: True ,
}
[
{
status:
{
Description: The task status. ,
Required: True ,
}
string ,
count:
{
Description: The count of tasks with this status. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
tasks:
{
Description: List of tasks in this stage. ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scopeId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: True ,
}
string ,
stage:
{
Description: Task Stage ,
Required: False ,
}
string ,
taskType:
{
Description: Task Type ,
Enum:
{
UserDefined: UserDefined task - typically initiated by a user ,
SystemDefined: SystemDefined task - typically initiated by the system ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Task Dislay Name ,
Required: True ,
}
string ,
isEditable:
{
Description: Indicates whether the task is editable. ,
Required: True ,
}
boolean ,
status:
{
Description: Task Status ,
Required: True ,
}
string ,
scope:
{
Description: Task Scope ,
Enum:
{
Wave: Wave task - typically related to a specific wave of migration ,
MigrationEntity: Migration Entity task - typically related to a specific migration entity ,
MigrationEntityGroup: Migration Entity Group task - typically related to a specific migration entity group ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Task Description ,
Required: False ,
}
string ,
completionDate:
{
Description: Task completion Date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tasks_ListByParent (new)
Description :  List Task resources by MigrateProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/tasks
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Task items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scopeId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: True ,
}
string ,
stage:
{
Description: Task Stage ,
Required: False ,
}
string ,
taskType:
{
Description: Task Type ,
Enum:
{
UserDefined: UserDefined task - typically initiated by a user ,
SystemDefined: SystemDefined task - typically initiated by the system ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Task Dislay Name ,
Required: True ,
}
string ,
isEditable:
{
Description: Indicates whether the task is editable. ,
Required: True ,
}
boolean ,
status:
{
Description: Task Status ,
Required: True ,
}
string ,
scope:
{
Description: Task Scope ,
Enum:
{
Wave: Wave task - typically related to a specific wave of migration ,
MigrationEntity: Migration Entity task - typically related to a specific migration entity ,
MigrationEntityGroup: Migration Entity Group task - typically related to a specific migration entity group ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Task Description ,
Required: False ,
}
string ,
completionDate:
{
Description: Task completion Date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tasks_Get (new)
Description :  Get a Task
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/tasks/{taskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
taskName:
{
Description: Task ARM name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scopeId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: True ,
}
string ,
stage:
{
Description: Task Stage ,
Required: False ,
}
string ,
taskType:
{
Description: Task Type ,
Enum:
{
UserDefined: UserDefined task - typically initiated by a user ,
SystemDefined: SystemDefined task - typically initiated by the system ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Task Dislay Name ,
Required: True ,
}
string ,
isEditable:
{
Description: Indicates whether the task is editable. ,
Required: True ,
}
boolean ,
status:
{
Description: Task Status ,
Required: True ,
}
string ,
scope:
{
Description: Task Scope ,
Enum:
{
Wave: Wave task - typically related to a specific wave of migration ,
MigrationEntity: Migration Entity task - typically related to a specific migration entity ,
MigrationEntityGroup: Migration Entity Group task - typically related to a specific migration entity group ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Task Description ,
Required: False ,
}
string ,
completionDate:
{
Description: Task completion Date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tasks_Create (new)
Description :  Create a Task
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/tasks/{taskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
taskName:
{
Description: Task ARM name ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scopeId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: True ,
}
string ,
stage:
{
Description: Task Stage ,
Required: False ,
}
string ,
taskType:
{
Description: Task Type ,
Enum:
{
UserDefined: UserDefined task - typically initiated by a user ,
SystemDefined: SystemDefined task - typically initiated by the system ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Task Dislay Name ,
Required: True ,
}
string ,
isEditable:
{
Description: Indicates whether the task is editable. ,
Required: True ,
}
boolean ,
status:
{
Description: Task Status ,
Required: True ,
}
string ,
scope:
{
Description: Task Scope ,
Enum:
{
Wave: Wave task - typically related to a specific wave of migration ,
MigrationEntity: Migration Entity task - typically related to a specific migration entity ,
MigrationEntityGroup: Migration Entity Group task - typically related to a specific migration entity group ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Task Description ,
Required: False ,
}
string ,
completionDate:
{
Description: Task completion Date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scopeId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: True ,
}
string ,
stage:
{
Description: Task Stage ,
Required: False ,
}
string ,
taskType:
{
Description: Task Type ,
Enum:
{
UserDefined: UserDefined task - typically initiated by a user ,
SystemDefined: SystemDefined task - typically initiated by the system ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Task Dislay Name ,
Required: True ,
}
string ,
isEditable:
{
Description: Indicates whether the task is editable. ,
Required: True ,
}
boolean ,
status:
{
Description: Task Status ,
Required: True ,
}
string ,
scope:
{
Description: Task Scope ,
Enum:
{
Wave: Wave task - typically related to a specific wave of migration ,
MigrationEntity: Migration Entity task - typically related to a specific migration entity ,
MigrationEntityGroup: Migration Entity Group task - typically related to a specific migration entity group ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Task Description ,
Required: False ,
}
string ,
completionDate:
{
Description: Task completion Date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Tasks resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
scopeId:
{
Description: associated Wave Id ,
Format: arm-id ,
Required: True ,
}
string ,
stage:
{
Description: Task Stage ,
Required: False ,
}
string ,
taskType:
{
Description: Task Type ,
Enum:
{
UserDefined: UserDefined task - typically initiated by a user ,
SystemDefined: SystemDefined task - typically initiated by the system ,
}
,
Required: True ,
}
enum ,
displayName:
{
Description: Task Dislay Name ,
Required: True ,
}
string ,
isEditable:
{
Description: Indicates whether the task is editable. ,
Required: True ,
}
boolean ,
status:
{
Description: Task Status ,
Required: True ,
}
string ,
scope:
{
Description: Task Scope ,
Enum:
{
Wave: Wave task - typically related to a specific wave of migration ,
MigrationEntity: Migration Entity task - typically related to a specific migration entity ,
MigrationEntityGroup: Migration Entity Group task - typically related to a specific migration entity group ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Task Description ,
Required: False ,
}
string ,
completionDate:
{
Description: Task completion Date ,
Format: date-time ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Tasks_Delete (new)
Description :  Delete a Task
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/tasks/{taskName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
taskName:
{
Description: Task ARM name ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Waves_ListByParent (new)
Description :  List Wave resources by MigrateProject
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/waves
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Wave items on this page ,
Required: True ,
}
[
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the wave. ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the wave. ,
Required: True ,
}
string ,
arg:
{
Description: ARG query and other details to create workloads within a wave ,
Required: True ,
}
{
query:
{
Description: The query to create workloads within the wave. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the wave. ,
Required: False ,
}
string ,
plannedStartDate:
{
Description: Planned start date of the wave. ,
Format: date-time ,
Required: True ,
}
string ,
plannedCompletionDate:
{
Description: Planned completion date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
actualStartDate:
{
Description: Actual start date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
stage:
{
Description: The current stage of the wave. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Waves_Get (new)
Description :  Get a Wave
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/waves/{waveName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
waveName:
{
Description: Migration Wave Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the wave. ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the wave. ,
Required: True ,
}
string ,
arg:
{
Description: ARG query and other details to create workloads within a wave ,
Required: True ,
}
{
query:
{
Description: The query to create workloads within the wave. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the wave. ,
Required: False ,
}
string ,
plannedStartDate:
{
Description: Planned start date of the wave. ,
Format: date-time ,
Required: True ,
}
string ,
plannedCompletionDate:
{
Description: Planned completion date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
actualStartDate:
{
Description: Actual start date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
stage:
{
Description: The current stage of the wave. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Waves_Create (new)
Description :  Create a Wave
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/waves/{waveName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
waveName:
{
Description: Migration Wave Resource ,
Required: True ,
}
string ,
resource:
{
Description: Resource create parameters. ,
Required: True ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the wave. ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the wave. ,
Required: True ,
}
string ,
arg:
{
Description: ARG query and other details to create workloads within a wave ,
Required: True ,
}
{
query:
{
Description: The query to create workloads within the wave. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the wave. ,
Required: False ,
}
string ,
plannedStartDate:
{
Description: Planned start date of the wave. ,
Format: date-time ,
Required: True ,
}
string ,
plannedCompletionDate:
{
Description: Planned completion date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
actualStartDate:
{
Description: Actual start date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
stage:
{
Description: The current stage of the wave. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the wave. ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the wave. ,
Required: True ,
}
string ,
arg:
{
Description: ARG query and other details to create workloads within a wave ,
Required: True ,
}
{
query:
{
Description: The query to create workloads within the wave. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the wave. ,
Required: False ,
}
string ,
plannedStartDate:
{
Description: Planned start date of the wave. ,
Format: date-time ,
Required: True ,
}
string ,
plannedCompletionDate:
{
Description: Planned completion date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
actualStartDate:
{
Description: Actual start date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
stage:
{
Description: The current stage of the wave. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Migration Wave resource. ,
}
{
properties:
{
Description: The resource-specific properties for this resource. ,
Required: False ,
}
{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the wave. ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the wave. ,
Required: True ,
}
string ,
arg:
{
Description: ARG query and other details to create workloads within a wave ,
Required: True ,
}
{
query:
{
Description: The query to create workloads within the wave. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the wave. ,
Required: False ,
}
string ,
plannedStartDate:
{
Description: Planned start date of the wave. ,
Format: date-time ,
Required: True ,
}
string ,
plannedCompletionDate:
{
Description: Planned completion date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
actualStartDate:
{
Description: Actual start date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
stage:
{
Description: The current stage of the wave. ,
Required: False ,
}
string ,
}
,
eTag:
{
Description: If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Waves_Delete (new)
Description :  Delete a Wave
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/waves/{waveName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
waveName:
{
Description: Migration Wave Resource ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Waves_Refresh (new)
Description :  Refresh operation to update wave
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{projectName}/waves/{waveName}/refresh
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
projectName:
{
Description: Migrate Project Name ,
Required: True ,
}
string ,
waveName:
{
Description: Migration Wave Resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
provisioningState:
{
Description: The status of the last operation. ,
Enum:
{
Succeeded: Resource provisioning Successful. ,
Failed: Resource provisioning Failed. ,
Canceled: Resource provisioning Canceled. ,
Provisioning: Resource is being Provisioned. ,
Updating: Resource is being Updated. ,
Deleting: Resource is being Deleted. ,
Accepted: Resource is being Accepted. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the wave. ,
Required: False ,
}
string ,
displayName:
{
Description: Display Name of the wave. ,
Required: True ,
}
string ,
arg:
{
Description: ARG query and other details to create workloads within a wave ,
Required: True ,
}
{
query:
{
Description: The query to create workloads within the wave. ,
Required: True ,
}
string ,
}
,
status:
{
Description: The status of the wave. ,
Required: False ,
}
string ,
plannedStartDate:
{
Description: Planned start date of the wave. ,
Format: date-time ,
Required: True ,
}
string ,
plannedCompletionDate:
{
Description: Planned completion date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
actualStartDate:
{
Description: Actual start date of the wave. ,
Format: date-time ,
Required: False ,
}
string ,
stage:
{
Description: The current stage of the wave. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}