replication_protection_clusters

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

Overview

Name	replication_protection_clusters
Type	Resource
Id	azure.recovery_services_site_recovery.replication_protection_clusters

Fields

The following fields are returned by SELECT queries:

get_operation_results

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 Protection cluster.
agentClusterId	string	The Agent cluster Id.
allowedOperations	array	The allowed operations on the Replication protection cluster.
areAllClusterNodesRegistered	boolean	A value indicating whether all nodes of the cluster are registered or not.
clusterFqdn	string	The cluster FQDN.
clusterNodeFqdns	array	The List of cluster Node FQDNs.
clusterProtectedItemIds	array	The List of Protected Item Id's.
clusterRegisteredNodes	array	The registered node details.
currentScenario	object	The current scenario.
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.
policyFriendlyName	string	The name of Policy governing this PE.
policyId	string	The Policy Id.
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.
protectionClusterType	string	The type of protection cluster type.
protectionState	string	The protection status.
protectionStateDescription	string	The protection state description.
providerSpecificDetails	object	The Replication cluster provider custom settings.
provisioningState	string	The provisioning state of the cluster.
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.
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.
sharedDiskProperties	object	The shared disk properties.
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".

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 Protection cluster.
agentClusterId	string	The Agent cluster Id.
allowedOperations	array	The allowed operations on the Replication protection cluster.
areAllClusterNodesRegistered	boolean	A value indicating whether all nodes of the cluster are registered or not.
clusterFqdn	string	The cluster FQDN.
clusterNodeFqdns	array	The List of cluster Node FQDNs.
clusterProtectedItemIds	array	The List of Protected Item Id's.
clusterRegisteredNodes	array	The registered node details.
currentScenario	object	The current scenario.
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.
policyFriendlyName	string	The name of Policy governing this PE.
policyId	string	The Policy Id.
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.
protectionClusterType	string	The type of protection cluster type.
protectionState	string	The protection status.
protectionStateDescription	string	The protection state description.
providerSpecificDetails	object	The Replication cluster provider custom settings.
provisioningState	string	The provisioning state of the cluster.
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.
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.
sharedDiskProperties	object	The shared disk properties.
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 Protection cluster.
agentClusterId	string	The Agent cluster Id.
allowedOperations	array	The allowed operations on the Replication protection cluster.
areAllClusterNodesRegistered	boolean	A value indicating whether all nodes of the cluster are registered or not.
clusterFqdn	string	The cluster FQDN.
clusterNodeFqdns	array	The List of cluster Node FQDNs.
clusterProtectedItemIds	array	The List of Protected Item Id's.
clusterRegisteredNodes	array	The registered node details.
currentScenario	object	The current scenario.
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.
policyFriendlyName	string	The name of Policy governing this PE.
policyId	string	The Policy Id.
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.
protectionClusterType	string	The type of protection cluster type.
protectionState	string	The protection status.
protectionStateDescription	string	The protection state description.
providerSpecificDetails	object	The Replication cluster provider custom settings.
provisioningState	string	The provisioning state of the cluster.
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.
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.
sharedDiskProperties	object	The shared disk properties.
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 Protection cluster.
agentClusterId	string	The Agent cluster Id.
allowedOperations	array	The allowed operations on the Replication protection cluster.
areAllClusterNodesRegistered	boolean	A value indicating whether all nodes of the cluster are registered or not.
clusterFqdn	string	The cluster FQDN.
clusterNodeFqdns	array	The List of cluster Node FQDNs.
clusterProtectedItemIds	array	The List of Protected Item Id's.
clusterRegisteredNodes	array	The registered node details.
currentScenario	object	The current scenario.
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.
policyFriendlyName	string	The name of Policy governing this PE.
policyId	string	The Policy Id.
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.
protectionClusterType	string	The type of protection cluster type.
protectionState	string	The protection status.
protectionStateDescription	string	The protection state description.
providerSpecificDetails	object	The Replication cluster provider custom settings.
provisioningState	string	The provisioning state of the cluster.
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.
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.
sharedDiskProperties	object	The shared disk properties.
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_operation_results	select	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, job_id, subscription_id		Tracks the Replication protection cluster async operation. Track the results of an asynchronous operation on the replication protection cluster.
get	select	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, subscription_id		Gets the details of a Replication protection cluster. Gets the details of an ASR replication protection cluster.
list_by_replication_protection_containers	select	resource_group_name, resource_name, fabric_name, protection_container_name, subscription_id		Gets the list of Replication protection clusters in fabric, container. Gets the list of ASR replication protected clusters in the protection container.
list	select	resource_group_name, resource_name, subscription_id	skipToken, $filter	Gets the list of Replication protection clusters in vault. Gets the list of ASR replication protected clusters in the vault.
create	insert	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, subscription_id		Create Replication protection Cluster. The operation to create an ASR replication protection cluster item.
purge	delete	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, subscription_id		Purge the replication protection cluster. The operation to purge the replication protection cluster. This operation will force delete the replication protection cluster. Use the remove operation on replication protection cluster to perform a clean disable replication protection cluster.
apply_recovery_point	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, subscription_id, properties		Execute the change recovery point operation for cluster. Operation to apply a new cluster recovery point on the Protection cluster.
failover_commit	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, subscription_id		Execute commit failover for cluster. Operation to initiate commit failover of the replication protection cluster.
repair_replication	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, subscription_id		Resynchronize or repair replication of protection cluster. The operation to repair replication protection cluster.
test_failover	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, subscription_id, properties		Execute test failover for cluster. Operation to initiate a failover of the replication protection cluster.
test_failover_cleanup	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, subscription_id, properties		Execute test failover cleanup for cluster. Operation to clean up the test failover of a replication protected cluster.
unplanned_failover	exec	resource_group_name, resource_name, fabric_name, protection_container_name, replication_protection_cluster_name, subscription_id, properties		Execute unplanned cluster failover. Operation to initiate a failover of the replication protection cluster.

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.
job_id	string	job id to track. Required.
protection_container_name	string	Protection container name. Required.
replication_protection_cluster_name	string	Replication protection cluster 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 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_operation_results

Tracks the Replication protection cluster async operation. Track the results of an asynchronous operation on the replication protection cluster.

SELECT
id,
name,
activeLocation,
agentClusterId,
allowedOperations,
areAllClusterNodesRegistered,
clusterFqdn,
clusterNodeFqdns,
clusterProtectedItemIds,
clusterRegisteredNodes,
currentScenario,
healthErrors,
lastSuccessfulFailoverTime,
lastSuccessfulTestFailoverTime,
policyFriendlyName,
policyId,
primaryFabricFriendlyName,
primaryFabricProvider,
primaryProtectionContainerFriendlyName,
protectionClusterType,
protectionState,
protectionStateDescription,
providerSpecificDetails,
provisioningState,
recoveryContainerId,
recoveryFabricFriendlyName,
recoveryFabricId,
recoveryProtectionContainerFriendlyName,
replicationHealth,
sharedDiskProperties,
systemData,
testFailoverState,
testFailoverStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_protection_clusters
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 replication_protection_cluster_name = '{{ replication_protection_cluster_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Gets the details of a Replication protection cluster. Gets the details of an ASR replication protection cluster.

SELECT
id,
name,
activeLocation,
agentClusterId,
allowedOperations,
areAllClusterNodesRegistered,
clusterFqdn,
clusterNodeFqdns,
clusterProtectedItemIds,
clusterRegisteredNodes,
currentScenario,
healthErrors,
lastSuccessfulFailoverTime,
lastSuccessfulTestFailoverTime,
policyFriendlyName,
policyId,
primaryFabricFriendlyName,
primaryFabricProvider,
primaryProtectionContainerFriendlyName,
protectionClusterType,
protectionState,
protectionStateDescription,
providerSpecificDetails,
provisioningState,
recoveryContainerId,
recoveryFabricFriendlyName,
recoveryFabricId,
recoveryProtectionContainerFriendlyName,
replicationHealth,
sharedDiskProperties,
systemData,
testFailoverState,
testFailoverStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_protection_clusters
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 replication_protection_cluster_name = '{{ replication_protection_cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_replication_protection_containers

Gets the list of Replication protection clusters in fabric, container. Gets the list of ASR replication protected clusters in the protection container.

SELECT
id,
name,
activeLocation,
agentClusterId,
allowedOperations,
areAllClusterNodesRegistered,
clusterFqdn,
clusterNodeFqdns,
clusterProtectedItemIds,
clusterRegisteredNodes,
currentScenario,
healthErrors,
lastSuccessfulFailoverTime,
lastSuccessfulTestFailoverTime,
policyFriendlyName,
policyId,
primaryFabricFriendlyName,
primaryFabricProvider,
primaryProtectionContainerFriendlyName,
protectionClusterType,
protectionState,
protectionStateDescription,
providerSpecificDetails,
provisioningState,
recoveryContainerId,
recoveryFabricFriendlyName,
recoveryFabricId,
recoveryProtectionContainerFriendlyName,
replicationHealth,
sharedDiskProperties,
systemData,
testFailoverState,
testFailoverStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_protection_clusters
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 protection clusters in vault. Gets the list of ASR replication protected clusters in the vault.

SELECT
id,
name,
activeLocation,
agentClusterId,
allowedOperations,
areAllClusterNodesRegistered,
clusterFqdn,
clusterNodeFqdns,
clusterProtectedItemIds,
clusterRegisteredNodes,
currentScenario,
healthErrors,
lastSuccessfulFailoverTime,
lastSuccessfulTestFailoverTime,
policyFriendlyName,
policyId,
primaryFabricFriendlyName,
primaryFabricProvider,
primaryProtectionContainerFriendlyName,
protectionClusterType,
protectionState,
protectionStateDescription,
providerSpecificDetails,
provisioningState,
recoveryContainerId,
recoveryFabricFriendlyName,
recoveryFabricId,
recoveryProtectionContainerFriendlyName,
replicationHealth,
sharedDiskProperties,
systemData,
testFailoverState,
testFailoverStateDescription,
type
FROM azure.recovery_services_site_recovery.replication_protection_clusters
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

Create Replication protection Cluster. The operation to create an ASR replication protection cluster item.

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

Manifest

# Description fields are for documentation purposes
- name: replication_protection_clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the replication_protection_clusters resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the replication_protection_clusters resource.
  - name: fabric_name
    value: "{{ fabric_name }}"
    description: Required parameter for the replication_protection_clusters resource.
  - name: protection_container_name
    value: "{{ protection_container_name }}"
    description: Required parameter for the replication_protection_clusters resource.
  - name: replication_protection_cluster_name
    value: "{{ replication_protection_cluster_name }}"
    description: Required parameter for the replication_protection_clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the replication_protection_clusters resource.
  - name: properties
    description: |
      The custom data.
    value:
      protectionClusterType: "{{ protectionClusterType }}"
      primaryFabricFriendlyName: "{{ primaryFabricFriendlyName }}"
      primaryFabricProvider: "{{ primaryFabricProvider }}"
      recoveryFabricFriendlyName: "{{ recoveryFabricFriendlyName }}"
      recoveryFabricId: "{{ recoveryFabricId }}"
      primaryProtectionContainerFriendlyName: "{{ primaryProtectionContainerFriendlyName }}"
      recoveryProtectionContainerFriendlyName: "{{ recoveryProtectionContainerFriendlyName }}"
      protectionState: "{{ protectionState }}"
      protectionStateDescription: "{{ protectionStateDescription }}"
      activeLocation: "{{ activeLocation }}"
      testFailoverState: "{{ testFailoverState }}"
      testFailoverStateDescription: "{{ testFailoverStateDescription }}"
      allowedOperations:
        - "{{ allowedOperations }}"
      replicationHealth: "{{ replicationHealth }}"
      healthErrors:
        - innerHealthErrors: "{{ innerHealthErrors }}"
          errorSource: "{{ errorSource }}"
          errorType: "{{ errorType }}"
          errorLevel: "{{ errorLevel }}"
          errorCategory: "{{ errorCategory }}"
          errorCode: "{{ errorCode }}"
          summaryMessage: "{{ summaryMessage }}"
          errorMessage: "{{ errorMessage }}"
          possibleCauses: "{{ possibleCauses }}"
          recommendedAction: "{{ recommendedAction }}"
          creationTimeUtc: "{{ creationTimeUtc }}"
          recoveryProviderErrorMessage: "{{ recoveryProviderErrorMessage }}"
          entityId: "{{ entityId }}"
          errorId: "{{ errorId }}"
          customerResolvability: "{{ customerResolvability }}"
      lastSuccessfulFailoverTime: "{{ lastSuccessfulFailoverTime }}"
      lastSuccessfulTestFailoverTime: "{{ lastSuccessfulTestFailoverTime }}"
      policyFriendlyName: "{{ policyFriendlyName }}"
      currentScenario:
        scenarioName: "{{ scenarioName }}"
        jobId: "{{ jobId }}"
        startTime: "{{ startTime }}"
      recoveryContainerId: "{{ recoveryContainerId }}"
      agentClusterId: "{{ agentClusterId }}"
      clusterFqdn: "{{ clusterFqdn }}"
      clusterNodeFqdns:
        - "{{ clusterNodeFqdns }}"
      clusterProtectedItemIds:
        - "{{ clusterProtectedItemIds }}"
      provisioningState: "{{ provisioningState }}"
      areAllClusterNodesRegistered: {{ areAllClusterNodesRegistered }}
      clusterRegisteredNodes:
        - clusterNodeFqdn: "{{ clusterNodeFqdn }}"
          machineId: "{{ machineId }}"
          biosId: "{{ biosId }}"
          isSharedDiskVirtualNode: {{ isSharedDiskVirtualNode }}
      providerSpecificDetails:
        instanceType: "{{ instanceType }}"
      sharedDiskProperties:
        protectionState: "{{ protectionState }}"
        testFailoverState: "{{ testFailoverState }}"
        activeLocation: "{{ activeLocation }}"
        allowedOperations:
          - "{{ allowedOperations }}"
        replicationHealth: "{{ replicationHealth }}"
        healthErrors:
          - innerHealthErrors: "{{ innerHealthErrors }}"
            errorSource: "{{ errorSource }}"
            errorType: "{{ errorType }}"
            errorLevel: "{{ errorLevel }}"
            errorCategory: "{{ errorCategory }}"
            errorCode: "{{ errorCode }}"
            summaryMessage: "{{ summaryMessage }}"
            errorMessage: "{{ errorMessage }}"
            possibleCauses: "{{ possibleCauses }}"
            recommendedAction: "{{ recommendedAction }}"
            creationTimeUtc: "{{ creationTimeUtc }}"
            recoveryProviderErrorMessage: "{{ recoveryProviderErrorMessage }}"
            entityId: "{{ entityId }}"
            errorId: "{{ errorId }}"
            customerResolvability: "{{ customerResolvability }}"
        currentScenario:
          scenarioName: "{{ scenarioName }}"
          jobId: "{{ jobId }}"
          startTime: "{{ startTime }}"
        sharedDiskProviderSpecificDetails:
          instanceType: "{{ instanceType }}"
      policyId: "{{ policyId }}"

DELETE examples

purge

Purge the replication protection cluster. The operation to purge the replication protection cluster. This operation will force delete the replication protection cluster. Use the remove operation on replication protection cluster to perform a clean disable replication protection cluster.

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

Lifecycle Methods

apply_recovery_point

Execute the change recovery point operation for cluster. Operation to apply a new cluster recovery point on the Protection cluster.

EXEC azure.recovery_services_site_recovery.replication_protection_clusters.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, 
@replication_protection_cluster_name='{{ replication_protection_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

failover_commit

Execute commit failover for cluster. Operation to initiate commit failover of the replication protection cluster.

EXEC azure.recovery_services_site_recovery.replication_protection_clusters.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, 
@replication_protection_cluster_name='{{ replication_protection_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

repair_replication

Resynchronize or repair replication of protection cluster. The operation to repair replication protection cluster.

EXEC azure.recovery_services_site_recovery.replication_protection_clusters.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, 
@replication_protection_cluster_name='{{ replication_protection_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

test_failover

Execute test failover for cluster. Operation to initiate a failover of the replication protection cluster.

EXEC azure.recovery_services_site_recovery.replication_protection_clusters.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, 
@replication_protection_cluster_name='{{ replication_protection_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

test_failover_cleanup

Execute test failover cleanup for cluster. Operation to clean up the test failover of a replication protected cluster.

EXEC azure.recovery_services_site_recovery.replication_protection_clusters.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, 
@replication_protection_cluster_name='{{ replication_protection_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

unplanned_failover

Execute unplanned cluster failover. Operation to initiate a failover of the replication protection cluster.

EXEC azure.recovery_services_site_recovery.replication_protection_clusters.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, 
@replication_protection_cluster_name='{{ replication_protection_cluster_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;