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

vw_replication_protection_clusters

Name	Datatype	Description
id	text	The protection cluster Id.
name	text	The name of the protection cluster.
active_location	text	field from the properties object
agent_cluster_id	text	field from the properties object
allowed_operations	text	field from the properties object
are_all_cluster_nodes_registered	text	field from the properties object
cluster_fqdn	text	field from the properties object
cluster_node_fqdns	text	field from the properties object
cluster_protected_item_ids	text	field from the properties object
cluster_registered_nodes	text	field from the properties object
current_scenario	text	field from the properties object
fabricName	text	field from the properties object
health_errors	text	field from the properties object
last_successful_failover_time	text	field from the properties object
last_successful_test_failover_time	text	field from the properties object
policy_friendly_name	text	field from the properties object
policy_id	text	field from the properties object
primary_fabric_friendly_name	text	field from the properties object
primary_fabric_provider	text	field from the properties object
primary_protection_container_friendly_name	text	field from the properties object
protectionContainerName	text	field from the properties object
protection_cluster_type	text	field from the properties object
protection_state	text	field from the properties object
protection_state_description	text	field from the properties object
provider_specific_details	text	field from the properties object
provisioning_state	text	field from the properties object
recovery_container_id	text	field from the properties object
recovery_fabric_friendly_name	text	field from the properties object
recovery_fabric_id	text	field from the properties object
recovery_protection_container_friendly_name	text	field from the properties object
replicationProtectionClusterName	text	field from the properties object
replication_health	text	field from the properties object
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
shared_disk_properties	text	field from the properties object
subscriptionId	text	field from the properties object
test_failover_state	text	field from the properties object
test_failover_state_description	text	field from the properties object
type	text	The Type of the object.

replication_protection_clusters

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

Methods

Name	Accessible by	Required Params	Description
get	SELECT	fabricName, protectionContainerName, replicationProtectionClusterName, resourceGroupName, resourceName, subscriptionId	Gets the details of an ASR replication protection cluster.
list	SELECT	resourceGroupName, resourceName, subscriptionId	Gets the list of ASR replication protected clusters in the vault.
list_by_replication_protection_containers	SELECT	fabricName, protectionContainerName, resourceGroupName, resourceName, subscriptionId	Gets the list of ASR replication protected clusters in the protection container.
create	INSERT	fabricName, protectionContainerName, replicationProtectionClusterName, resourceGroupName, resourceName, subscriptionId	The operation to create an ASR replication protection cluster item.
apply_recovery_point	EXEC	fabricName, protectionContainerName, replicationProtectionClusterName, resourceGroupName, resourceName, subscriptionId, data__properties	Operation to apply a new cluster recovery point on the Protection cluster.
failover_commit	EXEC	fabricName, protectionContainerName, replicationProtectionClusterName, resourceGroupName, resourceName, subscriptionId	Operation to initiate commit failover of the replication protection cluster.
purge	EXEC	fabricName, protectionContainerName, replicationProtectionClusterName, resourceGroupName, resourceName, subscriptionId	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.
repair_replication	EXEC	fabricName, protectionContainerName, replicationProtectionClusterName, resourceGroupName, resourceName, subscriptionId	The operation to repair replication protection cluster.
test_failover	EXEC	fabricName, protectionContainerName, replicationProtectionClusterName, resourceGroupName, resourceName, subscriptionId, data__properties	Operation to initiate a failover of the replication protection cluster.
test_failover_cleanup	EXEC	fabricName, protectionContainerName, replicationProtectionClusterName, resourceGroupName, resourceName, subscriptionId, data__properties	Operation to clean up the test failover of a replication protected cluster.
unplanned_failover	EXEC	fabricName, protectionContainerName, replicationProtectionClusterName, resourceGroupName, resourceName, subscriptionId, data__properties	Operation to initiate a failover of the replication protection cluster.

SELECT examples

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

vw_replication_protection_clusters

SELECT
id,
name,
active_location,
agent_cluster_id,
allowed_operations,
are_all_cluster_nodes_registered,
cluster_fqdn,
cluster_node_fqdns,
cluster_protected_item_ids,
cluster_registered_nodes,
current_scenario,
fabricName,
health_errors,
last_successful_failover_time,
last_successful_test_failover_time,
policy_friendly_name,
policy_id,
primary_fabric_friendly_name,
primary_fabric_provider,
primary_protection_container_friendly_name,
protectionContainerName,
protection_cluster_type,
protection_state,
protection_state_description,
provider_specific_details,
provisioning_state,
recovery_container_id,
recovery_fabric_friendly_name,
recovery_fabric_id,
recovery_protection_container_friendly_name,
replicationProtectionClusterName,
replication_health,
resourceGroupName,
resourceName,
shared_disk_properties,
subscriptionId,
test_failover_state,
test_failover_state_description,
type
FROM azure.recovery_services_site_recovery.vw_replication_protection_clusters
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

replication_protection_clusters

SELECT
id,
name,
properties,
type
FROM azure.recovery_services_site_recovery.replication_protection_clusters
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new replication_protection_clusters resource.

All Properties

/*+ create */
INSERT INTO azure.recovery_services_site_recovery.replication_protection_clusters (
fabricName,
protectionContainerName,
replicationProtectionClusterName,
resourceGroupName,
resourceName,
subscriptionId,
properties
)
SELECT 
'{{ fabricName }}',
'{{ protectionContainerName }}',
'{{ replicationProtectionClusterName }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: protectionClusterType
          value: string
        - name: primaryFabricFriendlyName
          value: string
        - name: primaryFabricProvider
          value: string
        - name: recoveryFabricFriendlyName
          value: string
        - name: recoveryFabricId
          value: string
        - name: primaryProtectionContainerFriendlyName
          value: string
        - name: recoveryProtectionContainerFriendlyName
          value: string
        - name: protectionState
          value: string
        - name: protectionStateDescription
          value: string
        - name: activeLocation
          value: string
        - name: testFailoverState
          value: string
        - name: testFailoverStateDescription
          value: string
        - name: allowedOperations
          value:
            - string
        - name: replicationHealth
          value: string
        - name: healthErrors
          value:
            - - name: innerHealthErrors
                value:
                  - - name: errorSource
                      value: string
                    - name: errorType
                      value: string
                    - name: errorLevel
                      value: string
                    - name: errorCategory
                      value: string
                    - name: errorCode
                      value: string
                    - name: summaryMessage
                      value: string
                    - name: errorMessage
                      value: string
                    - name: possibleCauses
                      value: string
                    - name: recommendedAction
                      value: string
                    - name: creationTimeUtc
                      value: string
                    - name: recoveryProviderErrorMessage
                      value: string
                    - name: entityId
                      value: string
                    - name: errorId
                      value: string
                    - name: customerResolvability
                      value: string
              - name: errorSource
                value: string
              - name: errorType
                value: string
              - name: errorLevel
                value: string
              - name: errorCategory
                value: string
              - name: errorCode
                value: string
              - name: summaryMessage
                value: string
              - name: errorMessage
                value: string
              - name: possibleCauses
                value: string
              - name: recommendedAction
                value: string
              - name: creationTimeUtc
                value: string
              - name: recoveryProviderErrorMessage
                value: string
              - name: entityId
                value: string
              - name: errorId
                value: string
              - name: customerResolvability
                value: string
        - name: lastSuccessfulFailoverTime
          value: string
        - name: lastSuccessfulTestFailoverTime
          value: string
        - name: policyFriendlyName
          value: string
        - name: currentScenario
          value:
            - name: scenarioName
              value: string
            - name: jobId
              value: string
            - name: startTime
              value: string
        - name: recoveryContainerId
          value: string
        - name: agentClusterId
          value: string
        - name: clusterFqdn
          value: string
        - name: clusterNodeFqdns
          value:
            - string
        - name: clusterProtectedItemIds
          value:
            - string
        - name: provisioningState
          value: string
        - name: areAllClusterNodesRegistered
          value: boolean
        - name: clusterRegisteredNodes
          value:
            - - name: clusterNodeFqdn
                value: string
              - name: machineId
                value: string
              - name: biosId
                value: string
              - name: isSharedDiskVirtualNode
                value: boolean
        - name: providerSpecificDetails
          value:
            - name: instanceType
              value: string
        - name: sharedDiskProperties
          value:
            - name: protectionState
              value: string
            - name: testFailoverState
              value: string
            - name: activeLocation
              value: string
            - name: allowedOperations
              value:
                - string
            - name: replicationHealth
              value: string
            - name: healthErrors
              value:
                - - name: innerHealthErrors
                    value:
                      - - name: errorSource
                          value: string
                        - name: errorType
                          value: string
                        - name: errorLevel
                          value: string
                        - name: errorCategory
                          value: string
                        - name: errorCode
                          value: string
                        - name: summaryMessage
                          value: string
                        - name: errorMessage
                          value: string
                        - name: possibleCauses
                          value: string
                        - name: recommendedAction
                          value: string
                        - name: creationTimeUtc
                          value: string
                        - name: recoveryProviderErrorMessage
                          value: string
                        - name: entityId
                          value: string
                        - name: errorId
                          value: string
                        - name: customerResolvability
                          value: string
                  - name: errorSource
                    value: string
                  - name: errorType
                    value: string
                  - name: errorLevel
                    value: string
                  - name: errorCategory
                    value: string
                  - name: errorCode
                    value: string
                  - name: summaryMessage
                    value: string
                  - name: errorMessage
                    value: string
                  - name: possibleCauses
                    value: string
                  - name: recommendedAction
                    value: string
                  - name: creationTimeUtc
                    value: string
                  - name: recoveryProviderErrorMessage
                    value: string
                  - name: entityId
                    value: string
                  - name: errorId
                    value: string
                  - name: customerResolvability
                    value: string
            - name: sharedDiskProviderSpecificDetails
              value:
                - name: instanceType
                  value: string
        - name: policyId
          value: string