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	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The migration item properties.
type	string	Resource Type

list_by_replication_protection_containers

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

list

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName	api-version
list_by_replication_protection_containers	select	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version, skipToken, takeToken, $filter	Gets the list of ASR migration items in the protection container.
list	select	resourceName, resourceGroupName, subscriptionId	api-version, skipToken, takeToken, $filter
create	insert	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName, data__properties	api-version	The operation to create an ASR migration item (enable migration).
update	update	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName	api-version	The operation to update the recovery settings of an ASR migration item.
delete	delete	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName	api-version, deleteOption	The operation to delete an ASR migration item.
migrate	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName, properties	api-version	The operation to initiate migration of the item.
pause_replication	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName, properties	api-version	The operation to initiate pause replication of the item.
resume_replication	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName, properties	api-version	The operation to initiate resume replication of the item.
resync	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName, properties	api-version	The operation to resynchronize replication of an ASR migration item.
test_migrate	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName, properties	api-version	The operation to initiate test migration of the item.
test_migrate_cleanup	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, migrationItemName, properties	api-version	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
fabricName	string	Fabric name.
migrationItemName	string	Migration item name.
protectionContainerName	string	Protection container name.
resourceGroupName	string	The name of the resource group where the recovery services vault is present.
resourceName	string	The name of the recovery services vault.
subscriptionId	string	The subscription Id.
$filter	string	OData filter options.
api-version	string	Client Api Version.
deleteOption	string	The delete option.
skipToken	string	The pagination token.
takeToken	string	The page size.

SELECT examples

get

OK

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_migration_items
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND fabricName = '{{ fabricName }}' -- required
AND protectionContainerName = '{{ protectionContainerName }}' -- required
AND migrationItemName = '{{ migrationItemName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_replication_protection_containers

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

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_migration_items
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND fabricName = '{{ fabricName }}' -- required
AND protectionContainerName = '{{ protectionContainerName }}' -- required
AND api-version = '{{ api-version }}'
AND skipToken = '{{ skipToken }}'
AND takeToken = '{{ takeToken }}'
AND $filter = '{{ $filter }}'
;

list

OK

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_migration_items
WHERE resourceName = '{{ resourceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
AND skipToken = '{{ skipToken }}'
AND takeToken = '{{ takeToken }}'
AND $filter = '{{ $filter }}'
;

INSERT examples

create

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

INSERT INTO azure.recovery_services_site_recovery.replication_migration_items (
data__properties,
resourceName,
resourceGroupName,
subscriptionId,
fabricName,
protectionContainerName,
migrationItemName,
api-version
)
SELECT 
'{{ properties }}' /* required */,
'{{ resourceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ fabricName }}',
'{{ protectionContainerName }}',
'{{ migrationItemName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: replication_migration_items
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_migration_items resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_migration_items resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_migration_items resource.
    - name: fabricName
      value: string
      description: Required parameter for the replication_migration_items resource.
    - name: protectionContainerName
      value: string
      description: Required parameter for the replication_migration_items resource.
    - name: migrationItemName
      value: string
      description: Required parameter for the replication_migration_items resource.
    - name: properties
      value: object
      description: |
        Enable migration input properties.
    - name: api-version
      value: string
      description: Client Api Version.

UPDATE examples

update

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

UPDATE azure.recovery_services_site_recovery.replication_migration_items
SET 
data__properties = '{{ properties }}'
WHERE 
resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND fabricName = '{{ fabricName }}' --required
AND protectionContainerName = '{{ protectionContainerName }}' --required
AND migrationItemName = '{{ migrationItemName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
type;

DELETE examples

delete

The operation to delete an ASR migration item.

DELETE FROM azure.recovery_services_site_recovery.replication_migration_items
WHERE resourceName = '{{ resourceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND fabricName = '{{ fabricName }}' --required
AND protectionContainerName = '{{ protectionContainerName }}' --required
AND migrationItemName = '{{ migrationItemName }}' --required
AND api-version = '{{ api-version }}'
AND deleteOption = '{{ deleteOption }}'
;

Lifecycle Methods

migrate

The operation to initiate migration of the item.

EXEC azure.recovery_services_site_recovery.replication_migration_items.migrate 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@migrationItemName='{{ migrationItemName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

pause_replication

The operation to initiate pause replication of the item.

EXEC azure.recovery_services_site_recovery.replication_migration_items.pause_replication 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@migrationItemName='{{ migrationItemName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

resume_replication

The operation to initiate resume replication of the item.

EXEC azure.recovery_services_site_recovery.replication_migration_items.resume_replication 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@migrationItemName='{{ migrationItemName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

resync

The operation to resynchronize replication of an ASR migration item.

EXEC azure.recovery_services_site_recovery.replication_migration_items.resync 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@migrationItemName='{{ migrationItemName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

test_migrate

The operation to initiate test migration of the item.

EXEC azure.recovery_services_site_recovery.replication_migration_items.test_migrate 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@migrationItemName='{{ migrationItemName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

test_migrate_cleanup

The operation to initiate test migrate cleanup.

EXEC azure.recovery_services_site_recovery.replication_migration_items.test_migrate_cleanup 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@migrationItemName='{{ migrationItemName }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;