Microsoft.Migrate (stable:2021-08-01)

2025/09/26 • 19 new, 19 deleted methods

MoveCollections_Create (new)
Description :  Creates or updates a move collection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Update (new)
Description :  Updates a move collection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
tags:
{
Description: Gets or sets the Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Delete (new)
Description :  Deletes a move collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Get (new)
Description :  Gets the move collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Prepare (new)
Description :  Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/prepare
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: True ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_InitiateMove (new)
Description :  Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/initiateMove
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: True ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Commit (new)
Description :  Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/commit
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: True ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Discard (new)
Description :  Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/discard
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: True ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_ResolveDependencies (new)
Description :  Computes, resolves and validate the dependencies of the moveResources in the move collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/resolveDependencies
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveResources_List (new)
Description :  Lists the Move Resources in the move collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of move resources. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Defines the move resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Gets or sets the Source ARM Id of the resource. ,
Required: True ,
}
string ,
targetId:
{
Description: Gets or sets the Target ARM Id of the resource. ,
Required: False ,
}
string ,
existingTargetId:
{
Description: Gets or sets the existing target ARM Id of the resource. ,
Required: False ,
}
string ,
resourceSettings:
{
Description: Gets or sets the resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
sourceResourceSettings:
{
Description: Gets or sets the source resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
moveStatus:
{
Description: Defines the move resource status. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the move resource dependencies. ,
Required: False ,
}
[
{
id:
{
Description: Gets the source ARM ID of the dependent resource. ,
Required: False ,
}
string ,
resolutionStatus:
{
Description: Gets the dependency resolution status. ,
Required: False ,
}
string ,
resolutionType:
{
Description: Defines the resolution type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: False ,
}
enum ,
dependencyType:
{
Description: Defines the dependency type. ,
Enum:
{
RequiredForPrepare: No description available. ,
RequiredForMove: No description available. ,
}
,
Required: False ,
}
enum ,
manualResolution:
{
Description: Defines the properties for manual resolution. ,
Required: False ,
}
{
targetId:
{
Description: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. ,
Required: False ,
}
string ,
}
,
automaticResolution:
{
Description: Defines the properties for automatic resolution. ,
Required: False ,
}
{
moveResourceId:
{
Description: Gets the MoveResource ARM ID of the dependent resource if the resolution type is Automatic. ,
Required: False ,
}
string ,
}
,
isOptional:
{
Description: Gets or sets a value indicating whether the dependency is optional. ,
Required: False ,
}
string ,
}
,
]
,
dependsOnOverrides:
{
Description: Gets or sets the move resource dependencies overrides. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ARM ID of the dependent resource. ,
Required: False ,
}
string ,
targetId:
{
Description: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. ,
Required: False ,
}
string ,
}
,
]
,
isResolveRequired:
{
Description: Gets a value indicating whether the resolve action is required over the move collection. ,
Required: False ,
}
boolean ,
errors:
{
Description: Defines the move resource errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets the value of next link. ,
Required: False ,
}
string ,
summaryCollection:
{
Description: Gets or sets the list of summary items and the field on which summary is done. ,
Required: False ,
}
{
fieldName:
{
Description: Gets or sets the field name on which summary is done. ,
Required: False ,
}
string ,
summary:
{
Description: Gets or sets the list of summary items. ,
Required: False ,
}
[
{
count:
{
Description: Gets the count. ,
Format: int32 ,
Required: False ,
}
integer ,
item:
{
Description: Gets the item. ,
Required: False ,
}
string ,
}
,
]
,
}
,
totalCount:
{
Description: Gets the total count. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
UnresolvedDependencies_Get (new)
Description :  Gets a list of unresolved dependencies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/unresolvedDependencies
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
dependencyLevel:
{
Description: Defines the dependency level. ,
Required: False ,
}
string ,
$orderby:
{
Description: OData order by query option. For example, you can use $orderby=Count desc. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For example, $apply=filter(count eq 2). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of unresolved dependencies. ,
Required: False ,
}
[
{
count:
{
Description: Gets or sets the count. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Gets or sets the arm id of the dependency. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
summaryCollection:
{
Description: Gets or sets the list of summary items and the field on which summary is done. ,
Required: False ,
}
{
fieldName:
{
Description: Gets or sets the field name on which summary is done. ,
Required: False ,
}
string ,
summary:
{
Description: Gets or sets the list of summary items. ,
Required: False ,
}
[
{
count:
{
Description: Gets the count. ,
Format: int32 ,
Required: False ,
}
integer ,
item:
{
Description: Gets the item. ,
Required: False ,
}
string ,
}
,
]
,
}
,
totalCount:
{
Description: Gets the total count. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_BulkRemove (new)
Description :  Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/bulkRemove
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Required: True ,
}
string ,
moveCollectionName:
{
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: False ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveResources_Create (new)
Description :  Creates or updates a Move Resource in the move collection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources/{moveResourceName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
moveResourceName:
{
Description: The Move Resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Defines the move resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Gets or sets the Source ARM Id of the resource. ,
Required: True ,
}
string ,
targetId:
{
Description: Gets or sets the Target ARM Id of the resource. ,
Required: False ,
}
string ,
existingTargetId:
{
Description: Gets or sets the existing target ARM Id of the resource. ,
Required: False ,
}
string ,
resourceSettings:
{
Description: Gets or sets the resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
sourceResourceSettings:
{
Description: Gets or sets the source resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
moveStatus:
{
Description: Defines the move resource status. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the move resource dependencies. ,
Required: False ,
}
[
{
id:
{
Description: Gets the source ARM ID of the dependent resource. ,
Required: False ,
}
string ,
resolutionStatus:
{
Description: Gets the dependency resolution status. ,
Required: False ,
}
string ,
resolutionType:
{
Description: Defines the resolution type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: False ,
}
enum ,
dependencyType:
{
Description: Defines the dependency type. ,
Enum:
{
RequiredForPrepare: No description available. ,
RequiredForMove: No description available. ,
}
,
Required: False ,
}
enum ,
manualResolution:
{
Description: Defines the properties for manual resolution. ,
Required: False ,
}
{
targetId:
{
Description: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. ,
Required: False ,
}
string ,
}
,
automaticResolution:
{
Description: Defines the properties for automatic resolution. ,
Required: False ,
}
{
moveResourceId:
{
Description: Gets the MoveResource ARM ID of the dependent resource if the resolution type is Automatic. ,
Required: False ,
}
string ,
}
,
isOptional:
{
Description: Gets or sets a value indicating whether the dependency is optional. ,
Required: False ,
}
string ,
}
,
]
,
dependsOnOverrides:
{
Description: Gets or sets the move resource dependencies overrides. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ARM ID of the dependent resource. ,
Required: False ,
}
string ,
targetId:
{
Description: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. ,
Required: False ,
}
string ,
}
,
]
,
isResolveRequired:
{
Description: Gets a value indicating whether the resolve action is required over the move collection. ,
Required: False ,
}
boolean ,
errors:
{
Description: Defines the move resource errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Defines the move resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Gets or sets the Source ARM Id of the resource. ,
Required: True ,
}
string ,
targetId:
{
Description: Gets or sets the Target ARM Id of the resource. ,
Required: False ,
}
string ,
existingTargetId:
{
Description: Gets or sets the existing target ARM Id of the resource. ,
Required: False ,
}
string ,
resourceSettings:
{
Description: Gets or sets the resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
sourceResourceSettings:
{
Description: Gets or sets the source resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
moveStatus:
{
Description: Defines the move resource status. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the move resource dependencies. ,
Required: False ,
}
[
{
id:
{
Description: Gets the source ARM ID of the dependent resource. ,
Required: False ,
}
string ,
resolutionStatus:
{
Description: Gets the dependency resolution status. ,
Required: False ,
}
string ,
resolutionType:
{
Description: Defines the resolution type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: False ,
}
enum ,
dependencyType:
{
Description: Defines the dependency type. ,
Enum:
{
RequiredForPrepare: No description available. ,
RequiredForMove: No description available. ,
}
,
Required: False ,
}
enum ,
manualResolution:
{
Description: Defines the properties for manual resolution. ,
Required: False ,
}
{
targetId:
{
Description: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. ,
Required: False ,
}
string ,
}
,
automaticResolution:
{
Description: Defines the properties for automatic resolution. ,
Required: False ,
}
{
moveResourceId:
{
Description: Gets the MoveResource ARM ID of the dependent resource if the resolution type is Automatic. ,
Required: False ,
}
string ,
}
,
isOptional:
{
Description: Gets or sets a value indicating whether the dependency is optional. ,
Required: False ,
}
string ,
}
,
]
,
dependsOnOverrides:
{
Description: Gets or sets the move resource dependencies overrides. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ARM ID of the dependent resource. ,
Required: False ,
}
string ,
targetId:
{
Description: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. ,
Required: False ,
}
string ,
}
,
]
,
isResolveRequired:
{
Description: Gets a value indicating whether the resolve action is required over the move collection. ,
Required: False ,
}
boolean ,
errors:
{
Description: Defines the move resource errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveResources_Delete (new)
Description :  Deletes a Move Resource from the move collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources/{moveResourceName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
moveResourceName:
{
Description: The Move Resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveResources_Get (new)
Description :  Gets the Move Resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources/{moveResourceName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
moveResourceName:
{
Description: The Move Resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Defines the move resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Gets or sets the Source ARM Id of the resource. ,
Required: True ,
}
string ,
targetId:
{
Description: Gets or sets the Target ARM Id of the resource. ,
Required: False ,
}
string ,
existingTargetId:
{
Description: Gets or sets the existing target ARM Id of the resource. ,
Required: False ,
}
string ,
resourceSettings:
{
Description: Gets or sets the resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
sourceResourceSettings:
{
Description: Gets or sets the source resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
moveStatus:
{
Description: Defines the move resource status. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the move resource dependencies. ,
Required: False ,
}
[
{
id:
{
Description: Gets the source ARM ID of the dependent resource. ,
Required: False ,
}
string ,
resolutionStatus:
{
Description: Gets the dependency resolution status. ,
Required: False ,
}
string ,
resolutionType:
{
Description: Defines the resolution type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: False ,
}
enum ,
dependencyType:
{
Description: Defines the dependency type. ,
Enum:
{
RequiredForPrepare: No description available. ,
RequiredForMove: No description available. ,
}
,
Required: False ,
}
enum ,
manualResolution:
{
Description: Defines the properties for manual resolution. ,
Required: False ,
}
{
targetId:
{
Description: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. ,
Required: False ,
}
string ,
}
,
automaticResolution:
{
Description: Defines the properties for automatic resolution. ,
Required: False ,
}
{
moveResourceId:
{
Description: Gets the MoveResource ARM ID of the dependent resource if the resolution type is Automatic. ,
Required: False ,
}
string ,
}
,
isOptional:
{
Description: Gets or sets a value indicating whether the dependency is optional. ,
Required: False ,
}
string ,
}
,
]
,
dependsOnOverrides:
{
Description: Gets or sets the move resource dependencies overrides. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ARM ID of the dependent resource. ,
Required: False ,
}
string ,
targetId:
{
Description: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. ,
Required: False ,
}
string ,
}
,
]
,
isResolveRequired:
{
Description: Gets a value indicating whether the resolve action is required over the move collection. ,
Required: False ,
}
boolean ,
errors:
{
Description: Defines the move resource errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OperationsDiscovery_Get (new)
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the ClientDiscovery details. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the "{Resource Provider Namespace}/register/action" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release). ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations. ,
Required: False ,
}
{
provider:
{
Description: Gets or sets the provider. The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with "Microsoft" for 1st party services. e.g. "Microsoft Monitoring Insights" or "Microsoft Compute.". ,
Required: False ,
}
string ,
resource:
{
Description: Gets or sets the resource. The localized friendly form of the resource related to this action/operation – it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent’s display.resource field) e.g. "Virtual Machines" or "Scheduler Job Collections", or "Virtual Machine VM Sizes" or "Scheduler Jobs". ,
Required: False ,
}
string ,
operation:
{
Description: Gets or sets the operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views. Prescriptive guidance for namespace: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespace: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Gets or sets Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is "user,system". ,
Required: False ,
}
string ,
properties:
{
Description: ClientDiscovery properties. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_ListMoveCollectionsBySubscription (new)
Description :  Get all the Move Collections in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Migrate/moveCollections
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of move collections. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_ListMoveCollectionsByResourceGroup (new)
Description :  Get all the Move Collections in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of move collections. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_ListRequiredFor (new)
Description :  List of the move resources for which an arm resource is required for.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/requiredFor
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
sourceId:
{
Description: The sourceId for which the api is invoked. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sourceIds:
{
Description: Gets or sets the list of source Ids for which the input resource is required. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Create (removed)
Description :  Creates or updates a move collection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Update (removed)
Description :  Updates a move collection.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
tags:
{
Description: Gets or sets the Resource tags. ,
Required: False ,
}
object ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Delete (removed)
Description :  Deletes a move collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Get (removed)
Description :  Gets the move collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Prepare (removed)
Description :  Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/prepare
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: True ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_InitiateMove (removed)
Description :  Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/initiateMove
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: True ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Commit (removed)
Description :  Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/commit
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: True ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_Discard (removed)
Description :  Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/discard
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: True ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_ResolveDependencies (removed)
Description :  Computes, resolves and validate the dependencies of the moveResources in the move collection.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/resolveDependencies
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveResources_List (removed)
Description :  Lists the Move Resources in the move collection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For example, you can use $filter=Properties/ProvisioningState eq 'Succeeded'. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of move resources. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Defines the move resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Gets or sets the Source ARM Id of the resource. ,
Required: True ,
}
string ,
targetId:
{
Description: Gets or sets the Target ARM Id of the resource. ,
Required: False ,
}
string ,
existingTargetId:
{
Description: Gets or sets the existing target ARM Id of the resource. ,
Required: False ,
}
string ,
resourceSettings:
{
Description: Gets or sets the resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
sourceResourceSettings:
{
Description: Gets or sets the source resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
moveStatus:
{
Description: Defines the move resource status. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the move resource dependencies. ,
Required: False ,
}
[
{
id:
{
Description: Gets the source ARM ID of the dependent resource. ,
Required: False ,
}
string ,
resolutionStatus:
{
Description: Gets the dependency resolution status. ,
Required: False ,
}
string ,
resolutionType:
{
Description: Defines the resolution type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: False ,
}
enum ,
dependencyType:
{
Description: Defines the dependency type. ,
Enum:
{
RequiredForPrepare: No description available. ,
RequiredForMove: No description available. ,
}
,
Required: False ,
}
enum ,
manualResolution:
{
Description: Defines the properties for manual resolution. ,
Required: False ,
}
{
targetId:
{
Description: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. ,
Required: False ,
}
string ,
}
,
automaticResolution:
{
Description: Defines the properties for automatic resolution. ,
Required: False ,
}
{
moveResourceId:
{
Description: Gets the MoveResource ARM ID of the dependent resource if the resolution type is Automatic. ,
Required: False ,
}
string ,
}
,
isOptional:
{
Description: Gets or sets a value indicating whether the dependency is optional. ,
Required: False ,
}
string ,
}
,
]
,
dependsOnOverrides:
{
Description: Gets or sets the move resource dependencies overrides. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ARM ID of the dependent resource. ,
Required: False ,
}
string ,
targetId:
{
Description: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. ,
Required: False ,
}
string ,
}
,
]
,
isResolveRequired:
{
Description: Gets a value indicating whether the resolve action is required over the move collection. ,
Required: False ,
}
boolean ,
errors:
{
Description: Defines the move resource errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets the value of next link. ,
Required: False ,
}
string ,
summaryCollection:
{
Description: Gets or sets the list of summary items and the field on which summary is done. ,
Required: False ,
}
{
fieldName:
{
Description: Gets or sets the field name on which summary is done. ,
Required: False ,
}
string ,
summary:
{
Description: Gets or sets the list of summary items. ,
Required: False ,
}
[
{
count:
{
Description: Gets the count. ,
Format: int32 ,
Required: False ,
}
integer ,
item:
{
Description: Gets the item. ,
Required: False ,
}
string ,
}
,
]
,
}
,
totalCount:
{
Description: Gets the total count. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
UnresolvedDependencies_Get (removed)
Description :  Gets a list of unresolved dependencies.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/unresolvedDependencies
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
dependencyLevel:
{
Description: Defines the dependency level. ,
Required: False ,
}
string ,
$orderby:
{
Description: OData order by query option. For example, you can use $orderby=Count desc. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
$filter:
{
Description: The filter to apply on the operation. For example, $apply=filter(count eq 2). ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the list of unresolved dependencies. ,
Required: False ,
}
[
{
count:
{
Description: Gets or sets the count. ,
Format: int32 ,
Required: False ,
}
integer ,
id:
{
Description: Gets or sets the arm id of the dependency. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
summaryCollection:
{
Description: Gets or sets the list of summary items and the field on which summary is done. ,
Required: False ,
}
{
fieldName:
{
Description: Gets or sets the field name on which summary is done. ,
Required: False ,
}
string ,
summary:
{
Description: Gets or sets the list of summary items. ,
Required: False ,
}
[
{
count:
{
Description: Gets the count. ,
Format: int32 ,
Required: False ,
}
integer ,
item:
{
Description: Gets the item. ,
Required: False ,
}
string ,
}
,
]
,
}
,
totalCount:
{
Description: Gets the total count. ,
Format: int64 ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_BulkRemove (removed)
Description :  Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/bulkRemove
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Required: True ,
}
string ,
moveCollectionName:
{
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
validateOnly:
{
Description: Gets or sets a value indicating whether the operation needs to only run pre-requisite. ,
Required: False ,
}
boolean ,
moveResources:
{
Description: Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. ,
Required: False ,
}
[
string ,
]
,
moveResourceInputType:
{
Description: Defines the move resource input type. ,
Enum:
{
MoveResourceId: No description available. ,
MoveResourceSourceId: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveResources_Create (removed)
Description :  Creates or updates a Move Resource in the move collection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources/{moveResourceName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
moveResourceName:
{
Description: The Move Resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
body:
{
Required: False ,
}
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Defines the move resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Gets or sets the Source ARM Id of the resource. ,
Required: True ,
}
string ,
targetId:
{
Description: Gets or sets the Target ARM Id of the resource. ,
Required: False ,
}
string ,
existingTargetId:
{
Description: Gets or sets the existing target ARM Id of the resource. ,
Required: False ,
}
string ,
resourceSettings:
{
Description: Gets or sets the resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
sourceResourceSettings:
{
Description: Gets or sets the source resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
moveStatus:
{
Description: Defines the move resource status. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the move resource dependencies. ,
Required: False ,
}
[
{
id:
{
Description: Gets the source ARM ID of the dependent resource. ,
Required: False ,
}
string ,
resolutionStatus:
{
Description: Gets the dependency resolution status. ,
Required: False ,
}
string ,
resolutionType:
{
Description: Defines the resolution type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: False ,
}
enum ,
dependencyType:
{
Description: Defines the dependency type. ,
Enum:
{
RequiredForPrepare: No description available. ,
RequiredForMove: No description available. ,
}
,
Required: False ,
}
enum ,
manualResolution:
{
Description: Defines the properties for manual resolution. ,
Required: False ,
}
{
targetId:
{
Description: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. ,
Required: False ,
}
string ,
}
,
automaticResolution:
{
Description: Defines the properties for automatic resolution. ,
Required: False ,
}
{
moveResourceId:
{
Description: Gets the MoveResource ARM ID of the dependent resource if the resolution type is Automatic. ,
Required: False ,
}
string ,
}
,
isOptional:
{
Description: Gets or sets a value indicating whether the dependency is optional. ,
Required: False ,
}
string ,
}
,
]
,
dependsOnOverrides:
{
Description: Gets or sets the move resource dependencies overrides. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ARM ID of the dependent resource. ,
Required: False ,
}
string ,
targetId:
{
Description: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. ,
Required: False ,
}
string ,
}
,
]
,
isResolveRequired:
{
Description: Gets a value indicating whether the resolve action is required over the move collection. ,
Required: False ,
}
boolean ,
errors:
{
Description: Defines the move resource errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Defines the move resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Gets or sets the Source ARM Id of the resource. ,
Required: True ,
}
string ,
targetId:
{
Description: Gets or sets the Target ARM Id of the resource. ,
Required: False ,
}
string ,
existingTargetId:
{
Description: Gets or sets the existing target ARM Id of the resource. ,
Required: False ,
}
string ,
resourceSettings:
{
Description: Gets or sets the resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
sourceResourceSettings:
{
Description: Gets or sets the source resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
moveStatus:
{
Description: Defines the move resource status. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the move resource dependencies. ,
Required: False ,
}
[
{
id:
{
Description: Gets the source ARM ID of the dependent resource. ,
Required: False ,
}
string ,
resolutionStatus:
{
Description: Gets the dependency resolution status. ,
Required: False ,
}
string ,
resolutionType:
{
Description: Defines the resolution type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: False ,
}
enum ,
dependencyType:
{
Description: Defines the dependency type. ,
Enum:
{
RequiredForPrepare: No description available. ,
RequiredForMove: No description available. ,
}
,
Required: False ,
}
enum ,
manualResolution:
{
Description: Defines the properties for manual resolution. ,
Required: False ,
}
{
targetId:
{
Description: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. ,
Required: False ,
}
string ,
}
,
automaticResolution:
{
Description: Defines the properties for automatic resolution. ,
Required: False ,
}
{
moveResourceId:
{
Description: Gets the MoveResource ARM ID of the dependent resource if the resolution type is Automatic. ,
Required: False ,
}
string ,
}
,
isOptional:
{
Description: Gets or sets a value indicating whether the dependency is optional. ,
Required: False ,
}
string ,
}
,
]
,
dependsOnOverrides:
{
Description: Gets or sets the move resource dependencies overrides. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ARM ID of the dependent resource. ,
Required: False ,
}
string ,
targetId:
{
Description: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. ,
Required: False ,
}
string ,
}
,
]
,
isResolveRequired:
{
Description: Gets a value indicating whether the resolve action is required over the move collection. ,
Required: False ,
}
boolean ,
errors:
{
Description: Defines the move resource errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveResources_Delete (removed)
Description :  Deletes a Move Resource from the move collection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources/{moveResourceName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
moveResourceName:
{
Description: The Move Resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Operation name. ,
Required: False ,
}
string ,
status:
{
Description: Status of the operation. ARM expects the terminal status to be one of Succeeded/ Failed/ Canceled. All other values imply that the operation is still running. ,
Required: False ,
}
string ,
startTime:
{
Description: Start time. ,
Required: False ,
}
string ,
endTime:
{
Description: End time. ,
Required: False ,
}
string ,
error:
{
Description: Error stating all error details for the operation. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The additional info. ,
Required: False ,
}
[
{
type:
{
Description: The error type. ,
Required: False ,
}
string ,
info:
{
Description: The operation error info. ,
Required: False ,
}
{
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
{
id:
{
Description: The affected move resource id. ,
Required: False ,
}
string ,
sourceId:
{
Description: The affected move resource source id. ,
Required: False ,
}
string ,
moveResources:
{
Description: The affected move resources. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
]
,
}
,
properties:
{
Description: Custom data. ,
Required: False ,
}
object ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveResources_Get (removed)
Description :  Gets the Move Resource.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/moveResources/{moveResourceName}
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
moveResourceName:
{
Description: The Move Resource Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
properties:
{
Description: Defines the move resource properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
sourceId:
{
Description: Gets or sets the Source ARM Id of the resource. ,
Required: True ,
}
string ,
targetId:
{
Description: Gets or sets the Target ARM Id of the resource. ,
Required: False ,
}
string ,
existingTargetId:
{
Description: Gets or sets the existing target ARM Id of the resource. ,
Required: False ,
}
string ,
resourceSettings:
{
Description: Gets or sets the resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
sourceResourceSettings:
{
Description: Gets or sets the source resource settings. ,
Required: False ,
}
{
resourceType:
{
Description: The resource type. For example, the value can be Microsoft.Compute/virtualMachines. ,
Required: True ,
}
string ,
targetResourceName:
{
Description: Gets or sets the target Resource name. ,
Required: True ,
}
string ,
}
,
moveStatus:
{
Description: Defines the move resource status. ,
Required: False ,
}
string ,
dependsOn:
{
Description: Gets or sets the move resource dependencies. ,
Required: False ,
}
[
{
id:
{
Description: Gets the source ARM ID of the dependent resource. ,
Required: False ,
}
string ,
resolutionStatus:
{
Description: Gets the dependency resolution status. ,
Required: False ,
}
string ,
resolutionType:
{
Description: Defines the resolution type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
}
,
Required: False ,
}
enum ,
dependencyType:
{
Description: Defines the dependency type. ,
Enum:
{
RequiredForPrepare: No description available. ,
RequiredForMove: No description available. ,
}
,
Required: False ,
}
enum ,
manualResolution:
{
Description: Defines the properties for manual resolution. ,
Required: False ,
}
{
targetId:
{
Description: Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. ,
Required: False ,
}
string ,
}
,
automaticResolution:
{
Description: Defines the properties for automatic resolution. ,
Required: False ,
}
{
moveResourceId:
{
Description: Gets the MoveResource ARM ID of the dependent resource if the resolution type is Automatic. ,
Required: False ,
}
string ,
}
,
isOptional:
{
Description: Gets or sets a value indicating whether the dependency is optional. ,
Required: False ,
}
string ,
}
,
]
,
dependsOnOverrides:
{
Description: Gets or sets the move resource dependencies overrides. ,
Required: False ,
}
[
{
id:
{
Description: Gets or sets the ARM ID of the dependent resource. ,
Required: False ,
}
string ,
targetId:
{
Description: Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of the dependent resource. ,
Required: False ,
}
string ,
}
,
]
,
isResolveRequired:
{
Description: Gets a value indicating whether the resolve action is required over the move collection. ,
Required: False ,
}
boolean ,
errors:
{
Description: Defines the move resource errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
OperationsDiscovery_Get (removed)
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Migrate/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets or sets the ClientDiscovery details. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets Name of the API. The name of the operation being performed on this particular object. It should match the action name that appears in RBAC / the event service. Examples of operations include: * Microsoft.Compute/virtualMachine/capture/action * Microsoft.Compute/virtualMachine/restart/action * Microsoft.Compute/virtualMachine/write * Microsoft.Compute/virtualMachine/read * Microsoft.Compute/virtualMachine/delete Each action should include, in order: (1) Resource Provider Namespace (2) Type hierarchy for which the action applies (e.g. server/databases for a SQL Azure database) (3) Read, Write, Action or Delete indicating which type applies. If it is a PUT/PATCH on a collection or named value, Write should be used. If it is a GET, Read should be used. If it is a DELETE, Delete should be used. If it is a POST, Action should be used. As a note: all resource providers would need to include the "{Resource Provider Namespace}/register/action" operation in their response. This API is used to register for their service, and should include details about the operation (e.g. a localized name for the resource provider + any special considerations like PII release). ,
Required: False ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation is a data action ,
Required: False ,
}
boolean ,
display:
{
Description: Contains the localized display information for this particular operation / action. These value will be used by several clients for (1) custom role definitions for RBAC; (2) complex query filters for the event service; and (3) audit history / records for management operations. ,
Required: False ,
}
{
provider:
{
Description: Gets or sets the provider. The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with "Microsoft" for 1st party services. e.g. "Microsoft Monitoring Insights" or "Microsoft Compute.". ,
Required: False ,
}
string ,
resource:
{
Description: Gets or sets the resource. The localized friendly form of the resource related to this action/operation – it should match the public documentation for the resource provider. It should use Title Casing. This value should be unique for a particular URL type (e.g. nested types should *not* reuse their parent’s display.resource field) e.g. "Virtual Machines" or "Scheduler Job Collections", or "Virtual Machine VM Sizes" or "Scheduler Jobs". ,
Required: False ,
}
string ,
operation:
{
Description: Gets or sets the operation. The localized friendly name for the operation, as it should be shown to the user. It should be concise (to fit in drop downs) but clear (i.e. self-documenting). It should use Title Casing. Prescriptive guidance: Read Create or Update Delete 'ActionName'. ,
Required: False ,
}
string ,
description:
{
Description: Gets or sets the description. The localized friendly description for the operation, as it should be shown to the user. It should be thorough, yet concise – it will be used in tool tips and detailed views. Prescriptive guidance for namespace: Read any 'display.provider' resource Create or Update any 'display.provider' resource Delete any 'display.provider' resource Perform any other action on any 'display.provider' resource Prescriptive guidance for namespace: Read any 'display.resource' Create or Update any 'display.resource' Delete any 'display.resource' 'ActionName' any 'display.resources'. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Gets or sets Origin. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX. Default value is "user,system". ,
Required: False ,
}
string ,
properties:
{
Description: ClientDiscovery properties. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: Gets or sets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_ListMoveCollectionsBySubscription (removed)
Description :  Get all the Move Collections in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Migrate/moveCollections
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of move collections. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_ListMoveCollectionsByResourceGroup (removed)
Description :  Get all the Move Collections in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the list of move collections. ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified resource Id for the resource. ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: False ,
}
string ,
type:
{
Description: The type of the resource. ,
Required: False ,
}
string ,
etag:
{
Description: The etag of the resource. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives. ,
Required: False ,
}
string ,
identity:
{
Description: Defines the MSI properties of the Move Collection. ,
Required: False ,
}
{
type:
{
Description: The type of identity used for the resource mover service. ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
}
,
Required: False ,
}
enum ,
principalId:
{
Description: Gets or sets the principal id. ,
Required: False ,
}
string ,
tenantId:
{
Description: Gets or sets the tenant id. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Defines the move collection properties. ,
Required: False ,
}
{
sourceRegion:
{
Description: Gets or sets the source region. ,
Required: True ,
}
string ,
targetRegion:
{
Description: Gets or sets the target region. ,
Required: True ,
}
string ,
provisioningState:
{
Description: Defines the provisioning states. ,
Enum:
{
Succeeded: No description available. ,
Updating: No description available. ,
Creating: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errors:
{
Description: Defines the move collection errors. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: Gets the value of next link. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
MoveCollections_ListRequiredFor (removed)
Description :  List of the move resources for which an arm resource is required for.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}/requiredFor
{
subscriptionId:
{
Description: The Subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The Resource Group Name. ,
Required: True ,
}
string ,
moveCollectionName:
{
Description: The Move Collection Name. ,
Required: True ,
}
string ,
sourceId:
{
Description: The sourceId for which the api is invoked. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
sourceIds:
{
Description: Gets or sets the list of source Ids for which the input resource is required. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: Cloud error body. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}