replication_protected_items

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

Overview

Name	replication_protected_items
Type	Resource
Id	azure.recovery_services_site_recovery.replication_protected_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 custom data.
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 custom data.
type	string	Resource Type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name
location	string	Resource Location
properties	object	The custom data.
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, replicatedProtectedItemName	api-version	Gets the details of an ASR replication protected item.
list_by_replication_protection_containers	select	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version	Gets the list of ASR replication protected items in the protection container.
list	select	resourceName, resourceGroupName, subscriptionId	api-version, skipToken, $filter	Gets the list of ASR replication protected items in the vault.
create	insert	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	The operation to create an ASR replication protected item (Enable replication).
update	update	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	The operation to update the recovery settings of an ASR replication protected item.
purge	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.
add_disks	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	Operation to add disks(s) to the replication protected item.
apply_recovery_point	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName, properties	api-version	The operation to change the recovery point of a failed over replication protected item.
failover_cancel	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	Operation to cancel the failover of the replication protected item.
failover_commit	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	Operation to commit the failover of the replication protected item.
planned_failover	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	Operation to initiate a planned failover of the replication protected item.
delete	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName, properties	api-version	The operation to disable replication on a replication protected item. This will also remove the item.
remove_disks	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	Operation to remove disk(s) from the replication protected item.
repair_replication	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.
reprotect	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	Operation to reprotect or reverse replicate a failed over replication protected item.
resolve_health_errors	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	Operation to resolve health issues of the replication protected item.
switch_provider	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName	api-version	Operation to initiate a switch provider of the replication protected item.
test_failover	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName, properties	api-version	Operation to perform a test failover of the replication protected item.
test_failover_cleanup	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName, properties	api-version	Operation to clean up the test failover of a replication protected item.
unplanned_failover	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicatedProtectedItemName, properties	api-version	Operation to initiate a failover of the replication protected item.

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	Unique fabric name.
protectionContainerName	string	Protection container name.
replicatedProtectedItemName	string	Replication protected item 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.
skipToken	string	The pagination token. Possible values: "FabricId" or "FabricId_CloudId" or null.

SELECT examples

get

Gets the details of an ASR replication protected item.

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

list_by_replication_protection_containers

Gets the list of ASR replication protected items in the protection container.

SELECT
id,
name,
location,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protected_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 }}'
;

list

Gets the list of ASR replication protected items in the vault.

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

INSERT examples

create

The operation to create an ASR replication protected item (Enable replication).

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

Manifest

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

UPDATE examples

update

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

UPDATE azure.recovery_services_site_recovery.replication_protected_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 replicatedProtectedItemName = '{{ replicatedProtectedItemName }}' --required
AND api-version = '{{ api-version}}'
RETURNING
id,
name,
location,
properties,
type;

Lifecycle Methods

purge

The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.

EXEC azure.recovery_services_site_recovery.replication_protected_items.purge 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@replicatedProtectedItemName='{{ replicatedProtectedItemName }}' --required, 
@api-version='{{ api-version }}'
;

add_disks

Operation to add disks(s) to the replication protected item.

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

apply_recovery_point

The operation to change the recovery point of a failed over replication protected item.

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

failover_cancel

Operation to cancel the failover of the replication protected item.

EXEC azure.recovery_services_site_recovery.replication_protected_items.failover_cancel 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@replicatedProtectedItemName='{{ replicatedProtectedItemName }}' --required, 
@api-version='{{ api-version }}'
;

failover_commit

Operation to commit the failover of the replication protected item.

EXEC azure.recovery_services_site_recovery.replication_protected_items.failover_commit 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@replicatedProtectedItemName='{{ replicatedProtectedItemName }}' --required, 
@api-version='{{ api-version }}'
;

planned_failover

Operation to initiate a planned failover of the replication protected item.

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

delete

The operation to disable replication on a replication protected item. This will also remove the item.

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

remove_disks

Operation to remove disk(s) from the replication protected item.

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

repair_replication

The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.

EXEC azure.recovery_services_site_recovery.replication_protected_items.repair_replication 
@resourceName='{{ resourceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@protectionContainerName='{{ protectionContainerName }}' --required, 
@replicatedProtectedItemName='{{ replicatedProtectedItemName }}' --required, 
@api-version='{{ api-version }}'
;

reprotect

Operation to reprotect or reverse replicate a failed over replication protected item.

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

resolve_health_errors

Operation to resolve health issues of the replication protected item.

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

switch_provider

Operation to initiate a switch provider of the replication protected item.

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

test_failover

Operation to perform a test failover of the replication protected item.

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

test_failover_cleanup

Operation to clean up the test failover of a replication protected item.

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

unplanned_failover

Operation to initiate a failover of the replication protected item.

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