ReplicationProtectionClustersOperations interface

Package:

@azure/arm-recoveryservices-siterecovery

Interface representing a ReplicationProtectionClusters operations.

Properties

applyRecoveryPoint	Operation to apply a new cluster recovery point on the Protection cluster.
beginApplyRecoveryPoint
beginApplyRecoveryPointAndWait
beginCreate
beginCreateAndWait
beginFailoverCommit
beginFailoverCommitAndWait
beginPurge
beginPurgeAndWait
beginRepairReplication
beginRepairReplicationAndWait
beginTestFailover
beginTestFailoverAndWait
beginTestFailoverCleanup
beginTestFailoverCleanupAndWait
beginUnplannedFailover
beginUnplannedFailoverAndWait
create	The operation to create an ASR replication protection cluster item.
failoverCommit	Operation to initiate commit failover of the replication protection cluster.
get	Gets the details of an ASR replication protection cluster.
getOperationResults	Track the results of an asynchronous operation on the replication protection cluster.
list	Gets the list of ASR replication protected clusters in the vault.
listByReplicationProtectionContainers	Gets the list of ASR replication protected clusters in the protection container.
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.
repairReplication	The operation to repair replication protection cluster.
testFailover	Operation to initiate a failover of the replication protection cluster.
testFailoverCleanup	Operation to clean up the test failover of a replication protected cluster.
unplannedFailover	Operation to initiate a failover of the replication protection cluster.

Property Details

applyRecoveryPoint

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

applyRecoveryPoint: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, applyClusterRecoveryPointInput: ApplyClusterRecoveryPointInput, options?: ReplicationProtectionClustersApplyRecoveryPointOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, applyClusterRecoveryPointInput: ApplyClusterRecoveryPointInput, options?: ReplicationProtectionClustersApplyRecoveryPointOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

beginApplyRecoveryPoint

Warning

This API is now deprecated.

use applyRecoveryPoint instead

beginApplyRecoveryPoint: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, applyClusterRecoveryPointInput: ApplyClusterRecoveryPointInput, options?: ReplicationProtectionClustersApplyRecoveryPointOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, applyClusterRecoveryPointInput: ApplyClusterRecoveryPointInput, options?: ReplicationProtectionClustersApplyRecoveryPointOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginApplyRecoveryPointAndWait

Warning

This API is now deprecated.

use applyRecoveryPoint instead

beginApplyRecoveryPointAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, applyClusterRecoveryPointInput: ApplyClusterRecoveryPointInput, options?: ReplicationProtectionClustersApplyRecoveryPointOptionalParams) => Promise<ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, applyClusterRecoveryPointInput: ApplyClusterRecoveryPointInput, options?: ReplicationProtectionClustersApplyRecoveryPointOptionalParams) => Promise<ReplicationProtectionCluster>

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, replicationProtectionCluster: ReplicationProtectionCluster, options?: ReplicationProtectionClustersCreateOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, replicationProtectionCluster: ReplicationProtectionCluster, options?: ReplicationProtectionClustersCreateOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, replicationProtectionCluster: ReplicationProtectionCluster, options?: ReplicationProtectionClustersCreateOptionalParams) => Promise<ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, replicationProtectionCluster: ReplicationProtectionCluster, options?: ReplicationProtectionClustersCreateOptionalParams) => Promise<ReplicationProtectionCluster>

beginFailoverCommit

Warning

This API is now deprecated.

use failoverCommit instead

beginFailoverCommit: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersFailoverCommitOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersFailoverCommitOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginFailoverCommitAndWait

Warning

This API is now deprecated.

use failoverCommit instead

beginFailoverCommitAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersFailoverCommitOptionalParams) => Promise<ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersFailoverCommitOptionalParams) => Promise<ReplicationProtectionCluster>

beginPurge

Warning

This API is now deprecated.

use purge instead

beginPurge: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersPurgeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersPurgeOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginPurgeAndWait

Warning

This API is now deprecated.

use purge instead

beginPurgeAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersPurgeOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersPurgeOptionalParams) => Promise<void>

beginRepairReplication

Warning

This API is now deprecated.

use repairReplication instead

beginRepairReplication: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersRepairReplicationOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersRepairReplicationOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginRepairReplicationAndWait

Warning

This API is now deprecated.

use repairReplication instead

beginRepairReplicationAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersRepairReplicationOptionalParams) => Promise<ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersRepairReplicationOptionalParams) => Promise<ReplicationProtectionCluster>

beginTestFailover

Warning

This API is now deprecated.

use testFailover instead

beginTestFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterTestFailoverInput, options?: ReplicationProtectionClustersTestFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterTestFailoverInput, options?: ReplicationProtectionClustersTestFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginTestFailoverAndWait

Warning

This API is now deprecated.

use testFailover instead

beginTestFailoverAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterTestFailoverInput, options?: ReplicationProtectionClustersTestFailoverOptionalParams) => Promise<ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterTestFailoverInput, options?: ReplicationProtectionClustersTestFailoverOptionalParams) => Promise<ReplicationProtectionCluster>

beginTestFailoverCleanup

Warning

This API is now deprecated.

use testFailoverCleanup instead

beginTestFailoverCleanup: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, cleanupInput: ClusterTestFailoverCleanupInput, options?: ReplicationProtectionClustersTestFailoverCleanupOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, cleanupInput: ClusterTestFailoverCleanupInput, options?: ReplicationProtectionClustersTestFailoverCleanupOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginTestFailoverCleanupAndWait

Warning

This API is now deprecated.

use testFailoverCleanup instead

beginTestFailoverCleanupAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, cleanupInput: ClusterTestFailoverCleanupInput, options?: ReplicationProtectionClustersTestFailoverCleanupOptionalParams) => Promise<ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, cleanupInput: ClusterTestFailoverCleanupInput, options?: ReplicationProtectionClustersTestFailoverCleanupOptionalParams) => Promise<ReplicationProtectionCluster>

beginUnplannedFailover

Warning

This API is now deprecated.

use unplannedFailover instead

beginUnplannedFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterUnplannedFailoverInput, options?: ReplicationProtectionClustersUnplannedFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterUnplannedFailoverInput, options?: ReplicationProtectionClustersUnplannedFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginUnplannedFailoverAndWait

Warning

This API is now deprecated.

use unplannedFailover instead

beginUnplannedFailoverAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterUnplannedFailoverInput, options?: ReplicationProtectionClustersUnplannedFailoverOptionalParams) => Promise<ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterUnplannedFailoverInput, options?: ReplicationProtectionClustersUnplannedFailoverOptionalParams) => Promise<ReplicationProtectionCluster>

create

The operation to create an ASR replication protection cluster item.

create: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, replicationProtectionCluster: ReplicationProtectionCluster, options?: ReplicationProtectionClustersCreateOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, replicationProtectionCluster: ReplicationProtectionCluster, options?: ReplicationProtectionClustersCreateOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

failoverCommit

Operation to initiate commit failover of the replication protection cluster.

failoverCommit: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersFailoverCommitOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersFailoverCommitOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

get

Gets the details of an ASR replication protection cluster.

get: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersGetOptionalParams) => Promise<ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersGetOptionalParams) => Promise<ReplicationProtectionCluster>

getOperationResults

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

getOperationResults: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, jobId: string, options?: ReplicationProtectionClustersGetOperationResultsOptionalParams) => Promise<ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, jobId: string, options?: ReplicationProtectionClustersGetOperationResultsOptionalParams) => Promise<ReplicationProtectionCluster>

list

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

list: (resourceGroupName: string, resourceName: string, options?: ReplicationProtectionClustersListOptionalParams) => PagedAsyncIterableIterator<ReplicationProtectionCluster, ReplicationProtectionCluster[], PageSettings>

Property Value

(resourceGroupName: string, resourceName: string, options?: ReplicationProtectionClustersListOptionalParams) => PagedAsyncIterableIterator<ReplicationProtectionCluster, ReplicationProtectionCluster[], PageSettings>

listByReplicationProtectionContainers

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

listByReplicationProtectionContainers: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, options?: ReplicationProtectionClustersListByReplicationProtectionContainersOptionalParams) => PagedAsyncIterableIterator<ReplicationProtectionCluster, ReplicationProtectionCluster[], PageSettings>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, options?: ReplicationProtectionClustersListByReplicationProtectionContainersOptionalParams) => PagedAsyncIterableIterator<ReplicationProtectionCluster, ReplicationProtectionCluster[], PageSettings>

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.

purge: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersPurgeOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersPurgeOptionalParams) => PollerLike<OperationState<void>, void>

repairReplication

The operation to repair replication protection cluster.

repairReplication: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersRepairReplicationOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, options?: ReplicationProtectionClustersRepairReplicationOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

testFailover

Operation to initiate a failover of the replication protection cluster.

testFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterTestFailoverInput, options?: ReplicationProtectionClustersTestFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterTestFailoverInput, options?: ReplicationProtectionClustersTestFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

testFailoverCleanup

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

testFailoverCleanup: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, cleanupInput: ClusterTestFailoverCleanupInput, options?: ReplicationProtectionClustersTestFailoverCleanupOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, cleanupInput: ClusterTestFailoverCleanupInput, options?: ReplicationProtectionClustersTestFailoverCleanupOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

unplannedFailover

Operation to initiate a failover of the replication protection cluster.

unplannedFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterUnplannedFailoverInput, options?: ReplicationProtectionClustersUnplannedFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicationProtectionClusterName: string, failoverInput: ClusterUnplannedFailoverInput, options?: ReplicationProtectionClustersUnplannedFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>