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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
activeLocation	string	The Current active location of the PE.
allowedOperations	array	The allowed operations on the Replication protected item.
currentScenario	object	The current scenario.
eventCorrelationId	string	The correlation Id for events associated with this protected item.
failoverHealth	string	The consolidated failover health for the VM.
failoverRecoveryPointId	string	The recovery point ARM Id to which the Vm was failed over.
friendlyName	string	The name.
healthErrors	array	List of health errors.
lastSuccessfulFailoverTime	string (date-time)	The Last successful failover time.
lastSuccessfulTestFailoverTime	string (date-time)	The Last successful test failover time.
location	string	Resource Location.
policyFriendlyName	string	The name of Policy governing this PE.
policyId	string	The ID of Policy governing this PE.
primaryFabricFriendlyName	string	The friendly name of the primary fabric.
primaryFabricProvider	string	The fabric provider of the primary fabric.
primaryProtectionContainerFriendlyName	string	The name of primary protection container friendly name.
protectableItemId	string	The protected item ARM Id.
protectedItemType	string	The type of protected item type.
protectionState	string	The protection status.
protectionStateDescription	string	The protection state description.
providerSpecificDetails	object	The Replication provider custom settings.
recoveryContainerId	string	The recovery container Id.
recoveryFabricFriendlyName	string	The friendly name of recovery fabric.
recoveryFabricId	string	The Arm Id of recovery fabric.
recoveryProtectionContainerFriendlyName	string	The name of recovery container friendly name.
recoveryServicesProviderId	string	The recovery provider ARM Id.
replicationHealth	string	The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.
switchProviderState	string	The switch provider state.
switchProviderStateDescription	string	The switch provider state description.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
testFailoverState	string	The Test failover state.
testFailoverStateDescription	string	The Test failover 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.
activeLocation	string	The Current active location of the PE.
allowedOperations	array	The allowed operations on the Replication protected item.
currentScenario	object	The current scenario.
eventCorrelationId	string	The correlation Id for events associated with this protected item.
failoverHealth	string	The consolidated failover health for the VM.
failoverRecoveryPointId	string	The recovery point ARM Id to which the Vm was failed over.
friendlyName	string	The name.
healthErrors	array	List of health errors.
lastSuccessfulFailoverTime	string (date-time)	The Last successful failover time.
lastSuccessfulTestFailoverTime	string (date-time)	The Last successful test failover time.
location	string	Resource Location.
policyFriendlyName	string	The name of Policy governing this PE.
policyId	string	The ID of Policy governing this PE.
primaryFabricFriendlyName	string	The friendly name of the primary fabric.
primaryFabricProvider	string	The fabric provider of the primary fabric.
primaryProtectionContainerFriendlyName	string	The name of primary protection container friendly name.
protectableItemId	string	The protected item ARM Id.
protectedItemType	string	The type of protected item type.
protectionState	string	The protection status.
protectionStateDescription	string	The protection state description.
providerSpecificDetails	object	The Replication provider custom settings.
recoveryContainerId	string	The recovery container Id.
recoveryFabricFriendlyName	string	The friendly name of recovery fabric.
recoveryFabricId	string	The Arm Id of recovery fabric.
recoveryProtectionContainerFriendlyName	string	The name of recovery container friendly name.
recoveryServicesProviderId	string	The recovery provider ARM Id.
replicationHealth	string	The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.
switchProviderState	string	The switch provider state.
switchProviderStateDescription	string	The switch provider state description.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
testFailoverState	string	The Test failover state.
testFailoverStateDescription	string	The Test failover 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.
activeLocation	string	The Current active location of the PE.
allowedOperations	array	The allowed operations on the Replication protected item.
currentScenario	object	The current scenario.
eventCorrelationId	string	The correlation Id for events associated with this protected item.
failoverHealth	string	The consolidated failover health for the VM.
failoverRecoveryPointId	string	The recovery point ARM Id to which the Vm was failed over.
friendlyName	string	The name.
healthErrors	array	List of health errors.
lastSuccessfulFailoverTime	string (date-time)	The Last successful failover time.
lastSuccessfulTestFailoverTime	string (date-time)	The Last successful test failover time.
location	string	Resource Location.
policyFriendlyName	string	The name of Policy governing this PE.
policyId	string	The ID of Policy governing this PE.
primaryFabricFriendlyName	string	The friendly name of the primary fabric.
primaryFabricProvider	string	The fabric provider of the primary fabric.
primaryProtectionContainerFriendlyName	string	The name of primary protection container friendly name.
protectableItemId	string	The protected item ARM Id.
protectedItemType	string	The type of protected item type.
protectionState	string	The protection status.
protectionStateDescription	string	The protection state description.
providerSpecificDetails	object	The Replication provider custom settings.
recoveryContainerId	string	The recovery container Id.
recoveryFabricFriendlyName	string	The friendly name of recovery fabric.
recoveryFabricId	string	The Arm Id of recovery fabric.
recoveryProtectionContainerFriendlyName	string	The name of recovery container friendly name.
recoveryServicesProviderId	string	The recovery provider ARM Id.
replicationHealth	string	The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration.
switchProviderState	string	The switch provider state.
switchProviderStateDescription	string	The switch provider state description.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
testFailoverState	string	The Test failover state.
testFailoverStateDescription	string	The Test failover 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, replicated_protected_item_name, subscription_id		Gets the details of a Replication protected item. Gets the details of an ASR replication protected item.
list_by_replication_protection_containers	select	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id		Gets the list of Replication protected items. Gets the list of ASR replication protected items in the protection container.
list	select	resource_group_name, resource_name, subscription_id	skipToken, $filter	Gets the list of replication protected items. Gets the list of ASR replication protected items in the vault.
create	insert	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Enables protection. The operation to create an ASR replication protected item (Enable replication).
update	update	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Updates the replication protected item settings. The operation to update the recovery settings of an ASR replication protected item.
delete	delete	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Disables protection. The operation to disable replication on a replication protected item. This will also remove the item.
purge	delete	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Purges protection. 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	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Add disk(s) for protection. Operation to add disks(s) to the replication protected item.
apply_recovery_point	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id, properties		Change or apply recovery point. The operation to change the recovery point of a failed over replication protected item.
failover_cancel	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Execute cancel failover. Operation to cancel the failover of the replication protected item.
failover_commit	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Execute commit failover. Operation to commit the failover of the replication protected item.
planned_failover	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Execute planned failover. Operation to initiate a planned failover of the replication protected item.
remove_disks	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Removes disk(s). Operation to remove disk(s) from the replication protected item.
repair_replication	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Resynchronize or repair replication. The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.
reprotect	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Execute Reverse Replication\Reprotect. Operation to reprotect or reverse replicate a failed over replication protected item.
resolve_health_errors	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Resolve health errors. Operation to resolve health issues of the replication protected item.
switch_provider	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Execute switch provider. Operation to initiate a switch provider of the replication protected item.
test_failover	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id, properties		Execute test failover. Operation to perform a test failover of the replication protected item.
test_failover_cleanup	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id, properties		Execute test failover cleanup. Operation to clean up the test failover of a replication protected item.
unplanned_failover	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id, properties		Execute unplanned failover. Operation to initiate a failover of the replication protected item.
update_appliance	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id, properties		Updates appliance for replication protected Item. The operation to update appliance of an ASR replication protected item.
update_mobility_service	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Update the mobility service on a protected item. The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.
reinstall_mobility_service	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replicated_protected_item_name, subscription_id		Reinstall the mobility service on a protected item. The operation to reinstall the installed mobility service software on a replication protected item to the latest available version.

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.
protection_container_name	string	Protection container name. Required.
replicated_protected_item_name	string	The name of the protected item on which the agent is to be updated. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the recovery services vault. Required.
subscription_id	string
$filter	string	OData filter options. Default value is None.
skipToken	string	The pagination token. Possible values: "FabricId" or "FabricId_CloudId" or null. Default value is None.

SELECT examples

get

Gets the details of a Replication protected item. Gets the details of an ASR replication protected item.

SELECT
id,
name,
activeLocation,
allowedOperations,
currentScenario,
eventCorrelationId,
failoverHealth,
failoverRecoveryPointId,
friendlyName,
healthErrors,
lastSuccessfulFailoverTime,
lastSuccessfulTestFailoverTime,
location,
policyFriendlyName,
policyId,
primaryFabricFriendlyName,
primaryFabricProvider,
primaryProtectionContainerFriendlyName,
protectableItemId,
protectedItemType,
protectionState,
protectionStateDescription,
providerSpecificDetails,
recoveryContainerId,
recoveryFabricFriendlyName,
recoveryFabricId,
recoveryProtectionContainerFriendlyName,
recoveryServicesProviderId,
replicationHealth,
switchProviderState,
switchProviderStateDescription,
systemData,
testFailoverState,
testFailoverStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_protected_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 replicated_protected_item_name = '{{ replicated_protected_item_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_replication_protection_containers

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

SELECT
id,
name,
activeLocation,
allowedOperations,
currentScenario,
eventCorrelationId,
failoverHealth,
failoverRecoveryPointId,
friendlyName,
healthErrors,
lastSuccessfulFailoverTime,
lastSuccessfulTestFailoverTime,
location,
policyFriendlyName,
policyId,
primaryFabricFriendlyName,
primaryFabricProvider,
primaryProtectionContainerFriendlyName,
protectableItemId,
protectedItemType,
protectionState,
protectionStateDescription,
providerSpecificDetails,
recoveryContainerId,
recoveryFabricFriendlyName,
recoveryFabricId,
recoveryProtectionContainerFriendlyName,
recoveryServicesProviderId,
replicationHealth,
switchProviderState,
switchProviderStateDescription,
systemData,
testFailoverState,
testFailoverStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_protected_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
;

list

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

SELECT
id,
name,
activeLocation,
allowedOperations,
currentScenario,
eventCorrelationId,
failoverHealth,
failoverRecoveryPointId,
friendlyName,
healthErrors,
lastSuccessfulFailoverTime,
lastSuccessfulTestFailoverTime,
location,
policyFriendlyName,
policyId,
primaryFabricFriendlyName,
primaryFabricProvider,
primaryProtectionContainerFriendlyName,
protectableItemId,
protectedItemType,
protectionState,
protectionStateDescription,
providerSpecificDetails,
recoveryContainerId,
recoveryFabricFriendlyName,
recoveryFabricId,
recoveryProtectionContainerFriendlyName,
recoveryServicesProviderId,
replicationHealth,
switchProviderState,
switchProviderStateDescription,
systemData,
testFailoverState,
testFailoverStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_protected_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 $filter = '{{ $filter }}'
;

INSERT examples

create

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

INSERT INTO azure.recovery_services_site_recovery.replication_protected_items (
properties,
resource_group_name,
resource_name,
fabric_name,
protection_container_name,
replicated_protected_item_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ fabric_name }}',
'{{ protection_container_name }}',
'{{ replicated_protected_item_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

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

UPDATE examples

update

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

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

DELETE examples

delete

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

DELETE FROM azure.recovery_services_site_recovery.replication_protected_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 replicated_protected_item_name = '{{ replicated_protected_item_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

purge

Purges protection. 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.

DELETE FROM azure.recovery_services_site_recovery.replication_protected_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 replicated_protected_item_name = '{{ replicated_protected_item_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

add_disks

Add disk(s) for protection. Operation to add disks(s) to the replication protected item.

EXEC azure.recovery_services_site_recovery.replication_protected_items.add_disks 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

apply_recovery_point

Change or 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 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

failover_cancel

Execute cancel failover. Operation to cancel the failover of the replication protected item.

EXEC azure.recovery_services_site_recovery.replication_protected_items.failover_cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

failover_commit

Execute commit failover. Operation to commit the failover of the replication protected item.

EXEC azure.recovery_services_site_recovery.replication_protected_items.failover_commit 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

planned_failover

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

EXEC azure.recovery_services_site_recovery.replication_protected_items.planned_failover 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

remove_disks

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

EXEC azure.recovery_services_site_recovery.replication_protected_items.remove_disks 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

repair_replication

Resynchronize or 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 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

reprotect

Execute Reverse Replication\Reprotect. Operation to reprotect or reverse replicate a failed over replication protected item.

EXEC azure.recovery_services_site_recovery.replication_protected_items.reprotect 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

resolve_health_errors

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

switch_provider

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

EXEC azure.recovery_services_site_recovery.replication_protected_items.switch_provider 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

test_failover

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

EXEC azure.recovery_services_site_recovery.replication_protected_items.test_failover 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

test_failover_cleanup

Execute 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 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

unplanned_failover

Execute unplanned failover. Operation to initiate a failover of the replication protected item.

EXEC azure.recovery_services_site_recovery.replication_protected_items.unplanned_failover 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_appliance

Updates appliance for replication protected Item. The operation to update appliance of an ASR replication protected item.

EXEC azure.recovery_services_site_recovery.replication_protected_items.update_appliance 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

update_mobility_service

Update the mobility service on a protected item. The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.

EXEC azure.recovery_services_site_recovery.replication_protected_items.update_mobility_service 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

reinstall_mobility_service

Reinstall the mobility service on a protected item. The operation to reinstall the installed mobility service software on a replication protected item to the latest available version.

EXEC azure.recovery_services_site_recovery.replication_protected_items.reinstall_mobility_service 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@fabric_name='{{ fabric_name }}' --required, 
@protection_container_name='{{ protection_container_name }}' --required, 
@replicated_protected_item_name='{{ replicated_protected_item_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;