Share via


Migration - Get

Gets migration mapping details.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/migrations/default?api-version=2024-08-01-preview

URI Parameters

Name In Required Type Description
billingAccountName
path True

string

pattern: ^([0-9]+|([Pp][Cc][Nn]\.[A-Za-z0-9]+)|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$

The ID that uniquely identifies a billing account.

api-version
query True

string

The version of the API to be used with the client request. The current version is 2024-04-01.

Responses

Name Type Description
200 OK

MigrationDetails

Migration mapping details.

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Examples

Get migration mapping details

Sample request

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/57151837/migrations/default?api-version=2024-08-01-preview

Sample response

{
  "id": "/providers/Microsoft.Billing/billingAccounts/57151837/migrations/default",
  "name": "default",
  "type": "Microsoft.Billing/billingAccounts/migrations",
  "properties": {
    "destinationBillingScope": "/providers/Microsoft.Billing/billingAccounts/8a1d33b5-73a1-5e7f-4b29-5afaebaba7e4:03059466-caec-4aa5-b458-2071484f7d32_2019-05-31/billingProfiles/APS5-RFWH-BG7-PGB",
    "status": "Completed",
    "transferId": "4a74dc9e-a863-4c88-b11e-e76aa2f4a05d"
  }
}

Definitions

Name Description
createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

Migration

Migration Details.

MigrationDetails

Migration details.

MigrationStatus

Migration Status

systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

Migration

Migration Details.

Name Type Description
destinationBillingScope

string

Destination billing scope to be mapped.

status

MigrationStatus

Migration Status

transferId

string

Transfer Id

MigrationDetails

Migration details.

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

The name of the resource

properties

Migration

Migration Details.

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

object

Dictionary of metadata associated with the resource. It may not be populated for all resource types. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? /

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

MigrationStatus

Migration Status

Value Description
Draft
InProgress
Completed
Failed
CompletedWithErrors

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).

createdBy

string

The identity that created the resource.

createdByType

createdByType

The type of identity that created the resource.

lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)

lastModifiedBy

string

The identity that last modified the resource.

lastModifiedByType

createdByType

The type of identity that last modified the resource.