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

Name	Datatype	Description
id	string	The protection cluster Id.
name	string	The name of the protection cluster.
properties	object	The custom data.
type	string	The Type of the object.

list_by_replication_protection_containers

Name	Datatype	Description
id	string	The protection cluster Id.
name	string	The name of the protection cluster.
properties	object	The custom data.
type	string	The Type of the object.

list

Name	Datatype	Description
id	string	The protection cluster Id.
name	string	The name of the protection cluster.
properties	object	The custom data.
type	string	The Type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicationProtectionClusterName	api-version	Gets the details of an ASR replication protection cluster.
list_by_replication_protection_containers	select	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName	api-version	Gets the list of ASR replication protected clusters in the protection container.
list	select	resourceName, resourceGroupName, subscriptionId	api-version, skipToken, $filter	Gets the list of ASR replication protected clusters in the vault.
create	insert	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicationProtectionClusterName	api-version	The operation to create an ASR replication protection cluster item.
purge	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicationProtectionClusterName	api-version	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	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicationProtectionClusterName, properties	api-version	Operation to apply a new cluster recovery point on the Protection cluster.
failover_commit	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicationProtectionClusterName	api-version	Operation to initiate commit failover of the replication protection cluster.
repair_replication	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicationProtectionClusterName	api-version	The operation to repair replication protection cluster.
test_failover	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicationProtectionClusterName, properties	api-version	Operation to initiate a failover of the replication protection cluster.
test_failover_cleanup	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicationProtectionClusterName, properties	api-version	Operation to clean up the test failover of a replication protected cluster.
unplanned_failover	exec	resourceName, resourceGroupName, subscriptionId, fabricName, protectionContainerName, replicationProtectionClusterName, properties	api-version	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
fabricName	string	Fabric name.
protectionContainerName	string	Protection container name.
replicationProtectionClusterName	string	Replication protection cluster 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 protection cluster.

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

list_by_replication_protection_containers

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

SELECT
id,
name,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protection_clusters
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 clusters in the vault.

SELECT
id,
name,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protection_clusters
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 protection cluster item.

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

Manifest

# Description fields are for documentation purposes
- name: replication_protection_clusters
  props:
    - name: resourceName
      value: string
      description: Required parameter for the replication_protection_clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the replication_protection_clusters resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the replication_protection_clusters resource.
    - name: fabricName
      value: string
      description: Required parameter for the replication_protection_clusters resource.
    - name: protectionContainerName
      value: string
      description: Required parameter for the replication_protection_clusters resource.
    - name: replicationProtectionClusterName
      value: string
      description: Required parameter for the replication_protection_clusters resource.
    - name: properties
      value: object
      description: |
        The custom data.
    - name: api-version
      value: string
      description: Client Api Version.

Lifecycle Methods

purge

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.

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

apply_recovery_point

Operation to apply a new cluster recovery point on the Protection cluster.

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

failover_commit

Operation to initiate commit failover of the replication protection cluster.

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

repair_replication

The operation to repair replication protection cluster.

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

test_failover

Operation to initiate a failover of the replication protection cluster.

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

test_failover_cleanup

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

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

unplanned_failover

Operation to initiate a failover of the replication protection cluster.

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