Move Collections - Get

Gets the move collection.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/moveCollections/{moveCollectionName}?api-version=2019-10-01-preview

URI Parameters

Name In Required Type Description
moveCollectionName
path True
  • string

The Move Collection Name.

resourceGroupName
path True
  • string

The Resource Group Name.

subscriptionId
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

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Migrate/moveCollections/movecollection1?api-version=2019-10-01-preview

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"
  }
}

Definitions

CloudError

An error response from the service.

CloudErrorBody

An error response from the service.

Errors

Defines the move resource errors.

Identity

Defines the MSI properties of the Move Collection.

MoveCollection

Define the move collection.

MoveCollectionProperties

Defines the move collection properties.

MoveResourceErrorBody

An error response from the Azure Migrate service.

ProvisioningState

Defines the provisioning states.

ResourceIdentityType

The type of identity used for the resource mover service.

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.

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.

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.

provisioningState

Defines the provisioning states.

sourceRegion
  • string

Gets or sets the source region.

targetRegion
  • string

Gets or sets the target region.

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.

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