Replication Migration Items - Migrate

Service:: Recovery Services - Site Recovery

API Version:: 2024-10-01

Migrate item.
The operation to initiate migration of the item.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
fabricName	path	True	string	Fabric name.
migrationItemName	path	True	string	Migration item name.
protectionContainerName	path	True	string	Protection container name.
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
resourceName	path	True	string	The name of the recovery services vault.
subscriptionId	path	True	string	The subscription Id.
api-version	query	True	string	Client Api Version.

Request Body

Name	Required	Type	Description
properties	True	MigrateInputProperties	Migrate input properties.

Responses

Name	Type	Description
200 OK	MigrationItem	OK
202 Accepted		Accepted

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

Migrate item.

Sample request

HTTP

POST https://management.azure.com/subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrate?api-version=2024-10-01

{
  "properties": {
    "providerSpecificDetails": {
      "instanceType": "VMwareCbt",
      "performShutdown": "true"
    }
  }
}

Sample response

Status code:: 200

Azure-AsyncOperation: https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-10-01

{
  "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1",
  "name": "virtualmachine1",
  "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems",
  "properties": {
    "machineName": "vm-0520-2",
    "migrationState": "Replicating",
    "migrationStateDescription": "Ready to migrate",
    "testMigrateState": "None",
    "testMigrateStateDescription": "None",
    "policyFriendlyName": "vmwarepolicy1",
    "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1",
    "allowedOperations": [
      "Migrate",
      "DisableMigration",
      "TestMigrate",
      "TestMigrateCleanup"
    ],
    "currentJob": {
      "jobName": "None",
      "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None",
      "startTime": "2017-04-26T06:37:50.8082715Z"
    },
    "providerSpecificDetails": {
      "instanceType": "VMwareCbt"
    }
  }
}

Status code:: 202

Azure-AsyncOperation: https://management.azure.com/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationOperationStatus/a93f3cd5-9035-4b1e-a2c9-b16df6d5d34b?api-version=2024-10-01
Retry-After: 30

Definitions

Name	Description
ApplianceMonitoringDetails	Appliance details of the migration item.
ApplianceResourceDetails	Details of the appliance resource.
CriticalJobHistoryDetails	Critical past job details of the migration item.
CurrentJobDetails	Current job details of the migration item.
DataStoreUtilizationDetails	Details of the appliance resource.
DiskAccountType	The disk type.
EthernetAddressType	The source IP address type.
GatewayOperationDetails	Details of the gateway operation.
HealthError	Health Error.
HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
InnerHealthError	Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
LinuxLicenseType	The license type for Linux VM's.
ManagedRunCommandScriptInput	Managed RunCommand script input
MigrateInput	Input for migrate.
MigrateInputProperties	Migrate input properties.
MigrationItem	Migration item.
MigrationItemOperation	The allowed operations on the migration item based on the current migration state of the item.
MigrationItemProperties	Migration item properties.
MigrationState	The migration status.
ProtectionHealth	The health.
ResyncState	The resync state.
SecurityType	The target VM security type.
TestMigrationState	The test migrate state.
VMwareCbtMigrateInput	VMwareCbt specific migrate input.
VMwareCbtMigrationDetails	VMwareCbt provider specific settings.
VMwareCbtNicDetails	VMwareCbt NIC details.
VMwareCbtProtectedDiskDetails	VMwareCbt protected disk details.
VMwareCbtSecurityProfileProperties	VMwareCbt security profile input.

ApplianceMonitoringDetails

Object

Appliance details of the migration item.

Name	Type	Description
cpuDetails	ApplianceResourceDetails	The appliance CPU details.
datastoreSnapshot	DataStoreUtilizationDetails[]	The appliance datastore snapshot details.
disksReplicationDetails	ApplianceResourceDetails	The disk replication details.
esxiNfcBuffer	ApplianceResourceDetails	The ESXi NFC buffer details.
networkBandwidth	ApplianceResourceDetails	The appliance network bandwidth details.
ramDetails	ApplianceResourceDetails	The appliance RAM details.

ApplianceResourceDetails

Object

Details of the appliance resource.

Name	Type	Description
capacity	integer (int64)	A value indicating the total capacity of appliance resource.
processUtilization	number (double)	A value indicating the utilization percentage by gateway agent on appliance.
status	string	A value indicating the status of appliance resource.
totalUtilization	number (double)	A value indicating the total utilization percentage for all processes on the appliance.

CriticalJobHistoryDetails

Object

Critical past job details of the migration item.

Name	Type	Description
jobId	string	The ARM Id of the job being executed.
jobName	string	The job name.
jobStatus	string	The job state.
startTime	string (date-time)	The start time of the job.

CurrentJobDetails

Object

Current job details of the migration item.

Name	Type	Description
jobId	string	The ARM Id of the job being executed.
jobName	string	The job name.
startTime	string (date-time)	The start time of the job.

DataStoreUtilizationDetails

Object

Details of the appliance resource.

Name	Type	Description
dataStoreName	string	The datastore name.
totalSnapshotsCreated	integer (int64)	The total snapshots created for server migration in the datastore.
totalSnapshotsSupported	integer (int64)	The total count of snapshots supported by the datastore.

DiskAccountType

Enumeration

The disk type.

Value	Description
Standard_LRS
Premium_LRS
StandardSSD_LRS
PremiumV2_LRS
UltraSSD_LRS
StandardSSD_ZRS
Premium_ZRS

EthernetAddressType

Enumeration

The source IP address type.

Value	Description
Dynamic
Static

GatewayOperationDetails

Object

Details of the gateway operation.

Name	Type	Description
dataStores	string[]	A value indicating the datastore collection.
hostName	string	A value indicating the ESXi host name.
progressPercentage	integer (int32)	A value indicating the progress percentage of gateway operation.
state	string	A value indicating the state of gateway operation.
timeElapsed	integer (int64)	A value indicating the time elapsed for the operation in milliseconds.
timeRemaining	integer (int64)	A value indicating the time remaining for the operation in milliseconds.
uploadSpeed	integer (int64)	A value indicating the upload speed in bytes per second.
vmwareReadThroughput	integer (int64)	A value indicating the VMware read throughput in bytes per second.

HealthError

Object

Health Error.

Name	Type	Description
creationTimeUtc	string (date-time)	Error creation time (UTC).
customerResolvability	HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
entityId	string	ID of the entity.
errorCategory	string	Category of error.
errorCode	string	Error code.
errorId	string	The health error unique id.
errorLevel	string	Level of error.
errorMessage	string	Error message.
errorSource	string	Source of error.
errorType	string	Type of error.
innerHealthErrors	InnerHealthError[]	The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
possibleCauses	string	Possible causes of error.
recommendedAction	string	Recommended action to resolve error.
recoveryProviderErrorMessage	string	DRA error message.
summaryMessage	string	Summary message of the entity.

HealthErrorCustomerResolvability

Enumeration

Value indicating whether the health error is customer resolvable.

Value	Description
Allowed
NotAllowed

InnerHealthError

Object

Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.

Name	Type	Description
creationTimeUtc	string (date-time)	Error creation time (UTC).
customerResolvability	HealthErrorCustomerResolvability	Value indicating whether the health error is customer resolvable.
entityId	string	ID of the entity.
errorCategory	string	Category of error.
errorCode	string	Error code.
errorId	string	The health error unique id.
errorLevel	string	Level of error.
errorMessage	string	Error message.
errorSource	string	Source of error.
errorType	string	Type of error.
possibleCauses	string	Possible causes of error.
recommendedAction	string	Recommended action to resolve error.
recoveryProviderErrorMessage	string	DRA error message.
summaryMessage	string	Summary message of the entity.

LinuxLicenseType

Enumeration

The license type for Linux VM's.

Value	Description
NotSpecified
NoLicenseType
LinuxServer

ManagedRunCommandScriptInput

Object

Managed RunCommand script input

Name	Type	Description
scriptParameters	string	The script parameters.
scriptUrl	string	The script url.
stepName	string	The step name.

MigrateInput

Object

Input for migrate.

Name	Type	Description
properties	MigrateInputProperties	Migrate input properties.

MigrateInputProperties

Object

Migrate input properties.

Name	Type	Description
providerSpecificDetails	MigrateProviderSpecificInput: VMwareCbtMigrateInput	The provider specific details.

MigrationItem

Object

Migration item.

Name	Type	Description
id	string	Resource Id
location	string	Resource Location
name	string	Resource Name
properties	MigrationItemProperties	The migration item properties.
type	string	Resource Type

MigrationItemOperation

Enumeration

The allowed operations on the migration item based on the current migration state of the item.

Value	Description
DisableMigration
TestMigrate
TestMigrateCleanup
Migrate
StartResync
PauseReplication
ResumeReplication

MigrationItemProperties

Object

Migration item properties.

Name	Type	Description
allowedOperations	MigrationItemOperation[]	The allowed operations on the migration item based on the current migration state of the item.
criticalJobHistory	CriticalJobHistoryDetails[]	The critical past job details.
currentJob	CurrentJobDetails	The current job details.
eventCorrelationId	string	The correlation Id for events associated with this migration item.
health	ProtectionHealth	The consolidated health.
healthErrors	HealthError[]	The list of health errors.
lastMigrationStatus	string	The status of the last migration.
lastMigrationTime	string (date-time)	The last migration time.
lastTestMigrationStatus	string	The status of the last test migration.
lastTestMigrationTime	string (date-time)	The last test migration time.
machineName	string	The on-premise virtual machine name.
migrationState	MigrationState	The migration status.
migrationStateDescription	string	The migration state description.
policyFriendlyName	string	The name of policy governing this item.
policyId	string	The ARM Id of policy governing this item.
providerSpecificDetails	MigrationProviderSpecificSettings: VMwareCbtMigrationDetails	The migration provider custom settings.
recoveryServicesProviderId	string	The recovery services provider ARM Id.
replicationStatus	string	The replication status.
testMigrateState	TestMigrationState	The test migrate state.
testMigrateStateDescription	string	The test migrate state description.

MigrationState

Enumeration

The migration status.

Value	Description
None
EnableMigrationInProgress
EnableMigrationFailed
DisableMigrationInProgress
DisableMigrationFailed
InitialSeedingInProgress
InitialSeedingFailed
Replicating
MigrationInProgress
MigrationSucceeded
MigrationFailed
ResumeInProgress
ResumeInitiated
SuspendingProtection
ProtectionSuspended
MigrationCompletedWithInformation
MigrationPartiallySucceeded

ProtectionHealth

Enumeration

The health.

Value	Description
None
Normal
Warning
Critical

ResyncState

Enumeration

The resync state.

Value	Description
None
PreparedForResynchronization
StartedResynchronization

SecurityType

Enumeration

The target VM security type.

Value	Description
None
TrustedLaunch
ConfidentialVM

TestMigrationState

Enumeration

The test migrate state.

Value	Description
None
TestMigrationInProgress
TestMigrationSucceeded
TestMigrationFailed
TestMigrationCleanupInProgress
TestMigrationCompletedWithInformation
TestMigrationPartiallySucceeded

VMwareCbtMigrateInput

Object

VMwareCbt specific migrate input.

Name	Type	Description
instanceType	string: VMwareCbt	The class type.
osUpgradeVersion	string	A value indicating the inplace OS Upgrade version.
performShutdown	string	A value indicating whether VM is to be shutdown.
postMigrationSteps	ManagedRunCommandScriptInput[]	The managed run command script input.

VMwareCbtMigrationDetails

Object

VMwareCbt provider specific settings.

Name	Type	Description
applianceMonitoringDetails	ApplianceMonitoringDetails	A value indicating the appliance monitoring details.
confidentialVmKeyVaultId	string	The confidential VM key vault Id for ADE installation.
dataMoverRunAsAccountId	string	The data mover run as account Id.
deltaSyncProgressPercentage	integer (int32)	The delta sync progress percentage.
deltaSyncRetryCount	integer (int64)	The delta sync retry count.
firmwareType	string	The firmware type.
gatewayOperationDetails	GatewayOperationDetails	A value indicating the gateway operation details.
initialSeedingProgressPercentage	integer (int32)	The initial seeding progress percentage.
initialSeedingRetryCount	integer (int64)	The initial seeding retry count.
instanceType	string: VMwareCbt	Gets the instance type.
isCheckSumResyncCycle	string	A value indicating whether checksum resync cycle is in progress.
lastRecoveryPointId	string	The last recovery point Id.
lastRecoveryPointReceived	string (date-time)	The last recovery point received time.
licenseType	string	License Type of the VM to be used.
linuxLicenseType	LinuxLicenseType	The license type for Linux VM's.
migrationProgressPercentage	integer (int32)	The migration progress percentage.
migrationRecoveryPointId	string	The recovery point Id to which the VM was migrated.
operationName	string	A value indicating the SRS operation name.
osName	string	The name of the OS on the VM.
osType	string	The type of the OS on the VM.
performAutoResync	string	A value indicating whether auto resync is to be done.
protectedDisks	VMwareCbtProtectedDiskDetails[]	The list of protected disks.
resumeProgressPercentage	integer (int32)	The resume progress percentage.
resumeRetryCount	integer (int64)	The resume retry count.
resyncProgressPercentage	integer (int32)	The resync progress percentage.
resyncRequired	string	A value indicating whether resync is required.
resyncRetryCount	integer (int64)	The resync retry count.
resyncState	ResyncState	The resync state.
seedDiskTags	object	The tags for the seed disks.
snapshotRunAsAccountId	string	The snapshot run as account Id.
sqlServerLicenseType	string	The SQL Server license type.
storageAccountId	string	The replication storage account ARM Id. This is applicable only for the blob based replication test hook.
supportedOSVersions	string[]	A value indicating the inplace OS Upgrade version.
targetAvailabilitySetId	string	The target availability set Id.
targetAvailabilityZone	string	The target availability zone.
targetBootDiagnosticsStorageAccountId	string	The target boot diagnostics storage account ARM Id.
targetDiskTags	object	The tags for the target disks.
targetGeneration	string	The target generation.
targetLocation	string	The target location.
targetNetworkId	string	The target network Id.
targetNicTags	object	The tags for the target NICs.
targetProximityPlacementGroupId	string	The target proximity placement group Id.
targetResourceGroupId	string	The target resource group Id.
targetVmName	string	Target VM name.
targetVmSecurityProfile	VMwareCbtSecurityProfileProperties	The target VM security profile.
targetVmSize	string	The target VM size.
targetVmTags	object	The target VM tags.
testNetworkId	string	The test network Id.
vmNics	VMwareCbtNicDetails[]	The network details.
vmwareMachineId	string	The ARM Id of the VM discovered in VMware.

VMwareCbtNicDetails

Object

VMwareCbt NIC details.

Name	Type	Description
isPrimaryNic	string	A value indicating whether this is the primary NIC.
isSelectedForMigration	string	A value indicating whether this NIC is selected for migration.
nicId	string	The NIC Id.
sourceIPAddress	string	The source IP address.
sourceIPAddressType	EthernetAddressType	The source IP address type.
sourceNetworkId	string	Source network Id.
targetIPAddress	string	The target IP address.
targetIPAddressType	EthernetAddressType	The target IP address type.
targetNicName	string	Target NIC name.
targetSubnetName	string	Target subnet name.
testIPAddress	string	The test IP address.
testIPAddressType	EthernetAddressType	The test IP address type.
testNetworkId	string	Source network Id.
testSubnetName	string	Test subnet name.

VMwareCbtProtectedDiskDetails

Object

VMwareCbt protected disk details.

Name	Type	Description
capacityInBytes	integer (int64)	The disk capacity in bytes.
diskEncryptionSetId	string	The DiskEncryptionSet ARM Id.
diskId	string	The disk id.
diskName	string	The disk name.
diskPath	string	The disk path.
diskType	DiskAccountType	The disk type.
gatewayOperationDetails	GatewayOperationDetails	A value indicating the gateway operation details.
isOSDisk	string	A value indicating whether the disk is the OS disk.
logStorageAccountId	string	The log storage account ARM Id.
logStorageAccountSasSecretName	string	The key vault secret name of the log storage account.
sectorSizeInBytes	integer (int32)	The logical sector size (in bytes), 512 by default.
seedBlobUri	string	The uri of the seed blob.
seedManagedDiskId	string	The ARM Id of the seed managed disk.
targetBlobUri	string	The uri of the target blob.
targetDiskName	string	The name for the target managed disk.
targetManagedDiskId	string	The ARM Id of the target managed disk.

VMwareCbtSecurityProfileProperties

Object

VMwareCbt security profile input.

Name	Type	Description
isTargetVmConfidentialEncryptionEnabled	string	A value indicating whether confidential compute encryption to be enabled.
isTargetVmIntegrityMonitoringEnabled	string	A value indicating whether integrity monitoring to be enabled.
isTargetVmSecureBootEnabled	string	A value indicating whether secure boot to be enabled.
isTargetVmTpmEnabled	string	A value indicating whether trusted platform module to be enabled.
targetVmSecurityType	SecurityType	The target VM security type.

Share via

Replication Migration Items - Migrate

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Migrate item.

Sample request

Sample response

Definitions

ApplianceMonitoringDetails

ApplianceResourceDetails

CriticalJobHistoryDetails

CurrentJobDetails

DataStoreUtilizationDetails

DiskAccountType

EthernetAddressType

GatewayOperationDetails

HealthError

HealthErrorCustomerResolvability

InnerHealthError

LinuxLicenseType

ManagedRunCommandScriptInput

MigrateInput

MigrateInputProperties

MigrationItem

MigrationItemOperation

MigrationItemProperties

MigrationState

ProtectionHealth

ResyncState

SecurityType

TestMigrationState

VMwareCbtMigrateInput

VMwareCbtMigrationDetails

VMwareCbtNicDetails

VMwareCbtProtectedDiskDetails

VMwareCbtSecurityProfileProperties