Move Collections - Get
Gets the move collection.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}?api-version=2023-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
move
|
path | True |
string |
The Move Collection Name. |
resource
|
path | True |
string |
The Resource Group Name. |
subscription
|
path | True |
string |
The Subscription ID. |
api-version
|
query | True |
string |
Client Api Version. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
MoveCollections_Get
Sample Request
Sample Response
{
"name": "movecollection1",
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/MoveCollections/movecollection1",
"type": "Microsoft.Migrate/MoveCollections",
"location": "United States",
"identity": {
"type": "SystemAssigned",
"principalId": "7488fa50-1c8e-42c4-a117-38c8d05d8b72",
"tenantId": "cc7e5736-dbba-4059-a621-664eab9c1d80"
},
"properties": {
"sourceRegion": "eastus",
"targetRegion": "westus",
"provisioningState": "Succeeded",
"version": "V1",
"moveType": "RegionToRegion"
},
"systemData": {
"createdBy": "user@microsoft.com",
"createdByType": "User",
"createdAt": "2021-08-01T15:06:54.2757906Z",
"lastModifiedBy": "user@microsoft.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2021-08-27T17:16:24.3644126Z"
}
}
Definitions
Name | Description |
---|---|
Cloud |
An error response from the service. |
Cloud |
An error response from the service. |
created |
The type of identity that created the resource. |
Errors |
Defines the move resource errors. |
Identity |
Defines the MSI properties of the Move Collection. |
Move |
Define the move collection. |
Move |
Defines the move collection properties. |
Move |
An error response from the Azure Migrate service. |
Move |
Defines the MoveType. |
Provisioning |
Defines the provisioning states. |
Resource |
The type of identity used for the resource mover service. |
system |
Metadata pertaining to creation and last modification of the resource. |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
Cloud error body. |
CloudErrorBody
An error response from the service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
Errors
Defines the move resource errors.
Name | Type | Description |
---|---|---|
properties |
The move resource error body. |
Identity
Defines the MSI properties of the Move Collection.
Name | Type | Description |
---|---|---|
principalId |
string |
Gets or sets the principal id. |
tenantId |
string |
Gets or sets the tenant id. |
type |
The type of identity used for the resource mover service. |
MoveCollection
Define the move collection.
Name | Type | Description |
---|---|---|
etag |
string |
The etag of the resource. |
id |
string |
Fully qualified resource Id for the resource. |
identity |
Defines the MSI properties of the Move Collection. |
|
location |
string |
The geo-location where the resource lives. |
name |
string |
The name of the resource |
properties |
Defines the move collection properties. |
|
systemData |
Metadata pertaining to creation and last modification of the resource. |
|
tags |
object |
Resource tags. |
type |
string |
The type of the resource. |
MoveCollectionProperties
Defines the move collection properties.
Name | Type | Description |
---|---|---|
errors |
Defines the move collection errors. |
|
moveRegion |
string |
Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. |
moveType |
Defines the MoveType. |
|
provisioningState |
Defines the provisioning states. |
|
sourceRegion |
string |
Gets or sets the source region. |
targetRegion |
string |
Gets or sets the target region. |
version |
string |
Gets or sets the version of move collection. |
MoveResourceErrorBody
An error response from the Azure Migrate service.
Name | Type | Description |
---|---|---|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
MoveType
Defines the MoveType.
Name | Type | Description |
---|---|---|
RegionToRegion |
string |
|
RegionToZone |
string |
ProvisioningState
Defines the provisioning states.
Name | Type | Description |
---|---|---|
Creating |
string |
|
Failed |
string |
|
Succeeded |
string |
|
Updating |
string |
ResourceIdentityType
The type of identity used for the resource mover service.
Name | Type | Description |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
UserAssigned |
string |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |