replication_migration_items

Creates, updates, deletes, gets or lists a replication_migration_items resource.

Overview

Name	replication_migration_items
Type	Resource
Id	azure.recovery_services_site_recovery.replication_migration_items

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedOperations	array	The allowed operations on the migration item based on the current migration state of the item.
criticalJobHistory	array	The critical past job details.
currentJob	object	The current job details.
eventCorrelationId	string	The correlation Id for events associated with this migration item.
health	string	The consolidated health. Known values are: "None", "Normal", "Warning", and "Critical". (None, Normal, Warning, Critical)
healthErrors	array	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.
location	string	Resource Location.
machineName	string	The on-premise virtual machine name.
migrationState	string	The migration status. Known values are: "None", "EnableMigrationInProgress", "EnableMigrationFailed", "DisableMigrationInProgress", "DisableMigrationFailed", "InitialSeedingInProgress", "InitialSeedingFailed", "Replicating", "MigrationInProgress", "MigrationSucceeded", "MigrationFailed", "ResumeInProgress", "ResumeInitiated", "SuspendingProtection", "ProtectionSuspended", "MigrationCompletedWithInformation", and "MigrationPartiallySucceeded". (None, EnableMigrationInProgress, EnableMigrationFailed, DisableMigrationInProgress, DisableMigrationFailed, InitialSeedingInProgress, InitialSeedingFailed, Replicating, MigrationInProgress, MigrationSucceeded, MigrationFailed, ResumeInProgress, ResumeInitiated, SuspendingProtection, ProtectionSuspended, MigrationCompletedWithInformation, MigrationPartiallySucceeded)
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	object	The migration provider custom settings.
recoveryServicesProviderId	string	The recovery services provider ARM Id.
replicationStatus	string	The replication status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
testMigrateState	string	The test migrate state. Known values are: "None", "TestMigrationInProgress", "TestMigrationSucceeded", "TestMigrationFailed", "TestMigrationCleanupInProgress", "TestMigrationCompletedWithInformation", and "TestMigrationPartiallySucceeded". (None, TestMigrationInProgress, TestMigrationSucceeded, TestMigrationFailed, TestMigrationCleanupInProgress, TestMigrationCompletedWithInformation, TestMigrationPartiallySucceeded)
testMigrateStateDescription	string	The test migrate state description.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_replication_protection_containers

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedOperations	array	The allowed operations on the migration item based on the current migration state of the item.
criticalJobHistory	array	The critical past job details.
currentJob	object	The current job details.
eventCorrelationId	string	The correlation Id for events associated with this migration item.
health	string	The consolidated health. Known values are: "None", "Normal", "Warning", and "Critical". (None, Normal, Warning, Critical)
healthErrors	array	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.
location	string	Resource Location.
machineName	string	The on-premise virtual machine name.
migrationState	string	The migration status. Known values are: "None", "EnableMigrationInProgress", "EnableMigrationFailed", "DisableMigrationInProgress", "DisableMigrationFailed", "InitialSeedingInProgress", "InitialSeedingFailed", "Replicating", "MigrationInProgress", "MigrationSucceeded", "MigrationFailed", "ResumeInProgress", "ResumeInitiated", "SuspendingProtection", "ProtectionSuspended", "MigrationCompletedWithInformation", and "MigrationPartiallySucceeded". (None, EnableMigrationInProgress, EnableMigrationFailed, DisableMigrationInProgress, DisableMigrationFailed, InitialSeedingInProgress, InitialSeedingFailed, Replicating, MigrationInProgress, MigrationSucceeded, MigrationFailed, ResumeInProgress, ResumeInitiated, SuspendingProtection, ProtectionSuspended, MigrationCompletedWithInformation, MigrationPartiallySucceeded)
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	object	The migration provider custom settings.
recoveryServicesProviderId	string	The recovery services provider ARM Id.
replicationStatus	string	The replication status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
testMigrateState	string	The test migrate state. Known values are: "None", "TestMigrationInProgress", "TestMigrationSucceeded", "TestMigrationFailed", "TestMigrationCleanupInProgress", "TestMigrationCompletedWithInformation", and "TestMigrationPartiallySucceeded". (None, TestMigrationInProgress, TestMigrationSucceeded, TestMigrationFailed, TestMigrationCleanupInProgress, TestMigrationCompletedWithInformation, TestMigrationPartiallySucceeded)
testMigrateStateDescription	string	The test migrate state description.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedOperations	array	The allowed operations on the migration item based on the current migration state of the item.
criticalJobHistory	array	The critical past job details.
currentJob	object	The current job details.
eventCorrelationId	string	The correlation Id for events associated with this migration item.
health	string	The consolidated health. Known values are: "None", "Normal", "Warning", and "Critical". (None, Normal, Warning, Critical)
healthErrors	array	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.
location	string	Resource Location.
machineName	string	The on-premise virtual machine name.
migrationState	string	The migration status. Known values are: "None", "EnableMigrationInProgress", "EnableMigrationFailed", "DisableMigrationInProgress", "DisableMigrationFailed", "InitialSeedingInProgress", "InitialSeedingFailed", "Replicating", "MigrationInProgress", "MigrationSucceeded", "MigrationFailed", "ResumeInProgress", "ResumeInitiated", "SuspendingProtection", "ProtectionSuspended", "MigrationCompletedWithInformation", and "MigrationPartiallySucceeded". (None, EnableMigrationInProgress, EnableMigrationFailed, DisableMigrationInProgress, DisableMigrationFailed, InitialSeedingInProgress, InitialSeedingFailed, Replicating, MigrationInProgress, MigrationSucceeded, MigrationFailed, ResumeInProgress, ResumeInitiated, SuspendingProtection, ProtectionSuspended, MigrationCompletedWithInformation, MigrationPartiallySucceeded)
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	object	The migration provider custom settings.
recoveryServicesProviderId	string	The recovery services provider ARM Id.
replicationStatus	string	The replication status.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
testMigrateState	string	The test migrate state. Known values are: "None", "TestMigrationInProgress", "TestMigrationSucceeded", "TestMigrationFailed", "TestMigrationCleanupInProgress", "TestMigrationCompletedWithInformation", and "TestMigrationPartiallySucceeded". (None, TestMigrationInProgress, TestMigrationSucceeded, TestMigrationFailed, TestMigrationCleanupInProgress, TestMigrationCompletedWithInformation, TestMigrationPartiallySucceeded)
testMigrateStateDescription	string	The test migrate state description.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id		Gets the details of a migration item. Gets the details of a migration item.
list_by_replication_protection_containers	select	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id	skipToken, takeToken, $filter	Gets the list of migration items in the protection container. Gets the list of ASR migration items in the protection container.
list	select	resource_group_name, resource_name, subscription_id	skipToken, takeToken, $filter	Gets the list of migration items in the vault. Gets the list of migration items in the vault.
create	insert	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id, properties		Enables migration. The operation to create an ASR migration item (enable migration).
update	update	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id		Updates migration item. The operation to update the recovery settings of an ASR migration item.
delete	delete	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id	deleteOption	Delete the migration item. The operation to delete an ASR migration item.
migrate	exec	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id, properties		Migrate item. The operation to initiate migration of the item.
pause_replication	exec	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id, properties		Pause replication. The operation to initiate pause replication of the item.
resume_replication	exec	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id, properties		Resume replication. The operation to initiate resume replication of the item.
resync	exec	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id, properties		Resynchronizes replication. The operation to resynchronize replication of an ASR migration item.
test_migrate	exec	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id, properties		Test migrate item. The operation to initiate test migration of the item.
test_migrate_cleanup	exec	resource_group_name, resource_name, fabric_name, protection_container_name, migration_item_name, subscription_id, properties		Test migrate cleanup. The operation to initiate test migrate cleanup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
fabric_name	string	Fabric name. Required.
migration_item_name	string	Migration item name. Required.
protection_container_name	string	Protection container name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Vault. Required.
subscription_id	string
$filter	string	OData filter options. Default value is None.
deleteOption	string	The delete option. Default value is None.
skipToken	string	The pagination token. Default value is None.
takeToken	string	The page size. Default value is None.

SELECT examples

get

Gets the details of a migration item. Gets the details of a migration item.

SELECT
id,
name,
allowedOperations,
criticalJobHistory,
currentJob,
eventCorrelationId,
health,
healthErrors,
lastMigrationStatus,
lastMigrationTime,
lastTestMigrationStatus,
lastTestMigrationTime,
location,
machineName,
migrationState,
migrationStateDescription,
policyFriendlyName,
policyId,
providerSpecificDetails,
recoveryServicesProviderId,
replicationStatus,
systemData,
testMigrateState,
testMigrateStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_migration_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND protection_container_name = '{{ protection_container_name }}' -- required
AND migration_item_name = '{{ migration_item_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_replication_protection_containers

Gets the list of migration items in the protection container. Gets the list of ASR migration items in the protection container.

SELECT
id,
name,
allowedOperations,
criticalJobHistory,
currentJob,
eventCorrelationId,
health,
healthErrors,
lastMigrationStatus,
lastMigrationTime,
lastTestMigrationStatus,
lastTestMigrationTime,
location,
machineName,
migrationState,
migrationStateDescription,
policyFriendlyName,
policyId,
providerSpecificDetails,
recoveryServicesProviderId,
replicationStatus,
systemData,
testMigrateState,
testMigrateStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_migration_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND fabric_name = '{{ fabric_name }}' -- required
AND protection_container_name = '{{ protection_container_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND skipToken = '{{ skipToken }}'
AND takeToken = '{{ takeToken }}'
AND $filter = '{{ $filter }}'
;

list

Gets the list of migration items in the vault. Gets the list of migration items in the vault.

SELECT
id,
name,
allowedOperations,
criticalJobHistory,
currentJob,
eventCorrelationId,
health,
healthErrors,
lastMigrationStatus,
lastMigrationTime,
lastTestMigrationStatus,
lastTestMigrationTime,
location,
machineName,
migrationState,
migrationStateDescription,
policyFriendlyName,
policyId,
providerSpecificDetails,
recoveryServicesProviderId,
replicationStatus,
systemData,
testMigrateState,
testMigrateStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_migration_items
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND skipToken = '{{ skipToken }}'
AND takeToken = '{{ takeToken }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Enables migration. The operation to create an ASR migration item (enable migration).

INSERT INTO azure.recovery_services_site_recovery.replication_migration_items (
properties,
resource_group_name,
resource_name,
fabric_name,
protection_container_name,
migration_item_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ fabric_name }}',
'{{ protection_container_name }}',
'{{ migration_item_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_migration_items
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_migration_items resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_migration_items resource.
  - name: fabric_name
    value: "{{ fabric_name }}"
    description: Required parameter for the replication_migration_items resource.
  - name: protection_container_name
    value: "{{ protection_container_name }}"
    description: Required parameter for the replication_migration_items resource.
  - name: migration_item_name
    value: "{{ migration_item_name }}"
    description: Required parameter for the replication_migration_items resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_migration_items resource.
  - name: properties
    description: |
      Enable migration input properties. Required.
    value:
      policyId: "{{ policyId }}"
      providerSpecificDetails:
        instanceType: "{{ instanceType }}"

UPDATE examples

update

Updates migration item. The operation to update the recovery settings of an ASR migration item.

UPDATE azure.recovery_services_site_recovery.replication_migration_items
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND protection_container_name = '{{ protection_container_name }}' --required
AND migration_item_name = '{{ migration_item_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Delete the migration item. The operation to delete an ASR migration item.

DELETE FROM azure.recovery_services_site_recovery.replication_migration_items
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND fabric_name = '{{ fabric_name }}' --required
AND protection_container_name = '{{ protection_container_name }}' --required
AND migration_item_name = '{{ migration_item_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND deleteOption = '{{ deleteOption }}'
;

Lifecycle Methods

migrate

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

EXEC azure.recovery_services_site_recovery.replication_migration_items.migrate 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@migration_item_name='{{ migration_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

pause_replication

Pause replication. The operation to initiate pause replication of the item.

EXEC azure.recovery_services_site_recovery.replication_migration_items.pause_replication 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@migration_item_name='{{ migration_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

resume_replication

Resume replication. The operation to initiate resume replication of the item.

EXEC azure.recovery_services_site_recovery.replication_migration_items.resume_replication 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@migration_item_name='{{ migration_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

resync

Resynchronizes replication. The operation to resynchronize replication of an ASR migration item.

EXEC azure.recovery_services_site_recovery.replication_migration_items.resync 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@migration_item_name='{{ migration_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

test_migrate

Test migrate item. The operation to initiate test migration of the item.

EXEC azure.recovery_services_site_recovery.replication_migration_items.test_migrate 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@migration_item_name='{{ migration_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

test_migrate_cleanup

Test migrate cleanup. The operation to initiate test migrate cleanup.

EXEC azure.recovery_services_site_recovery.replication_migration_items.test_migrate_cleanup 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@migration_item_name='{{ migration_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;