Share via


ReplicationProtectionClusters interface

Interface representing a ReplicationProtectionClusters.

Methods

beginApplyRecoveryPoint(string, string, string, string, string, ApplyClusterRecoveryPointInput, ReplicationProtectionClustersApplyRecoveryPointOptionalParams)

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

beginApplyRecoveryPointAndWait(string, string, string, string, string, ApplyClusterRecoveryPointInput, ReplicationProtectionClustersApplyRecoveryPointOptionalParams)

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

beginCreate(string, string, string, string, string, ReplicationProtectionCluster, ReplicationProtectionClustersCreateOptionalParams)

The operation to create an ASR replication protection cluster item.

beginCreateAndWait(string, string, string, string, string, ReplicationProtectionCluster, ReplicationProtectionClustersCreateOptionalParams)

The operation to create an ASR replication protection cluster item.

beginFailoverCommit(string, string, string, string, string, ReplicationProtectionClustersFailoverCommitOptionalParams)

Operation to initiate commit failover of the replication protection cluster.

beginFailoverCommitAndWait(string, string, string, string, string, ReplicationProtectionClustersFailoverCommitOptionalParams)

Operation to initiate commit failover of the replication protection cluster.

beginPurge(string, string, string, string, string, ReplicationProtectionClustersPurgeOptionalParams)

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.

beginPurgeAndWait(string, string, string, string, string, ReplicationProtectionClustersPurgeOptionalParams)

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.

beginRepairReplication(string, string, string, string, string, ReplicationProtectionClustersRepairReplicationOptionalParams)

The operation to repair replication protection cluster.

beginRepairReplicationAndWait(string, string, string, string, string, ReplicationProtectionClustersRepairReplicationOptionalParams)

The operation to repair replication protection cluster.

beginTestFailover(string, string, string, string, string, ClusterTestFailoverInput, ReplicationProtectionClustersTestFailoverOptionalParams)

Operation to initiate a failover of the replication protection cluster.

beginTestFailoverAndWait(string, string, string, string, string, ClusterTestFailoverInput, ReplicationProtectionClustersTestFailoverOptionalParams)

Operation to initiate a failover of the replication protection cluster.

beginTestFailoverCleanup(string, string, string, string, string, ClusterTestFailoverCleanupInput, ReplicationProtectionClustersTestFailoverCleanupOptionalParams)

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

beginTestFailoverCleanupAndWait(string, string, string, string, string, ClusterTestFailoverCleanupInput, ReplicationProtectionClustersTestFailoverCleanupOptionalParams)

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

beginUnplannedFailover(string, string, string, string, string, ClusterUnplannedFailoverInput, ReplicationProtectionClustersUnplannedFailoverOptionalParams)

Operation to initiate a failover of the replication protection cluster.

beginUnplannedFailoverAndWait(string, string, string, string, string, ClusterUnplannedFailoverInput, ReplicationProtectionClustersUnplannedFailoverOptionalParams)

Operation to initiate a failover of the replication protection cluster.

get(string, string, string, string, string, ReplicationProtectionClustersGetOptionalParams)

Gets the details of an ASR replication protection cluster.

getOperationResults(string, string, string, string, string, string, ReplicationProtectionClustersGetOperationResultsOptionalParams)

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

list(string, string, ReplicationProtectionClustersListOptionalParams)

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

listByReplicationProtectionContainers(string, string, string, string, ReplicationProtectionClustersListByReplicationProtectionContainersOptionalParams)

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

Method Details

beginApplyRecoveryPoint(string, string, string, string, string, ApplyClusterRecoveryPointInput, ReplicationProtectionClustersApplyRecoveryPointOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

applyClusterRecoveryPointInput
ApplyClusterRecoveryPointInput

Apply recovery point input.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginApplyRecoveryPointAndWait(string, string, string, string, string, ApplyClusterRecoveryPointInput, ReplicationProtectionClustersApplyRecoveryPointOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

applyClusterRecoveryPointInput
ApplyClusterRecoveryPointInput

Apply recovery point input.

Returns

beginCreate(string, string, string, string, string, ReplicationProtectionCluster, ReplicationProtectionClustersCreateOptionalParams)

The operation to create an ASR replication protection cluster item.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

replicationProtectionCluster
ReplicationProtectionCluster

Create replication protection cluster Input.

options
ReplicationProtectionClustersCreateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginCreateAndWait(string, string, string, string, string, ReplicationProtectionCluster, ReplicationProtectionClustersCreateOptionalParams)

The operation to create an ASR replication protection cluster item.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

replicationProtectionCluster
ReplicationProtectionCluster

Create replication protection cluster Input.

options
ReplicationProtectionClustersCreateOptionalParams

The options parameters.

Returns

beginFailoverCommit(string, string, string, string, string, ReplicationProtectionClustersFailoverCommitOptionalParams)

Operation to initiate commit failover of the replication protection cluster.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginFailoverCommitAndWait(string, string, string, string, string, ReplicationProtectionClustersFailoverCommitOptionalParams)

Operation to initiate commit failover of the replication protection cluster.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

Returns

beginPurge(string, string, string, string, string, ReplicationProtectionClustersPurgeOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

options
ReplicationProtectionClustersPurgeOptionalParams

The options parameters.

Returns

beginPurgeAndWait(string, string, string, string, string, ReplicationProtectionClustersPurgeOptionalParams)

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.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

options
ReplicationProtectionClustersPurgeOptionalParams

The options parameters.

Returns

beginRepairReplication(string, string, string, string, string, ReplicationProtectionClustersRepairReplicationOptionalParams)

The operation to repair replication protection cluster.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginRepairReplicationAndWait(string, string, string, string, string, ReplicationProtectionClustersRepairReplicationOptionalParams)

The operation to repair replication protection cluster.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

Returns

beginTestFailover(string, string, string, string, string, ClusterTestFailoverInput, ReplicationProtectionClustersTestFailoverOptionalParams)

Operation to initiate a failover of the replication protection cluster.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

failoverInput
ClusterTestFailoverInput

Cluster test failover input body.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginTestFailoverAndWait(string, string, string, string, string, ClusterTestFailoverInput, ReplicationProtectionClustersTestFailoverOptionalParams)

Operation to initiate a failover of the replication protection cluster.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

failoverInput
ClusterTestFailoverInput

Cluster test failover input body.

Returns

beginTestFailoverCleanup(string, string, string, string, string, ClusterTestFailoverCleanupInput, ReplicationProtectionClustersTestFailoverCleanupOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

cleanupInput
ClusterTestFailoverCleanupInput

Test failover cleanup input.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginTestFailoverCleanupAndWait(string, string, string, string, string, ClusterTestFailoverCleanupInput, ReplicationProtectionClustersTestFailoverCleanupOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

cleanupInput
ClusterTestFailoverCleanupInput

Test failover cleanup input.

Returns

beginUnplannedFailover(string, string, string, string, string, ClusterUnplannedFailoverInput, ReplicationProtectionClustersUnplannedFailoverOptionalParams)

Operation to initiate a failover of the replication protection cluster.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

failoverInput
ClusterUnplannedFailoverInput

Failover input.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ReplicationProtectionCluster>, ReplicationProtectionCluster>>

beginUnplannedFailoverAndWait(string, string, string, string, string, ClusterUnplannedFailoverInput, ReplicationProtectionClustersUnplannedFailoverOptionalParams)

Operation to initiate a failover of the replication protection cluster.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

failoverInput
ClusterUnplannedFailoverInput

Failover input.

Returns

get(string, string, string, string, string, ReplicationProtectionClustersGetOptionalParams)

Gets the details of an ASR replication protection cluster.

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

options
ReplicationProtectionClustersGetOptionalParams

The options parameters.

Returns

getOperationResults(string, string, string, string, string, string, ReplicationProtectionClustersGetOperationResultsOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicationProtectionClusterName

string

Replication protection cluster name.

jobId

string

job id to track.

Returns

list(string, string, ReplicationProtectionClustersListOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

options
ReplicationProtectionClustersListOptionalParams

The options parameters.

Returns

listByReplicationProtectionContainers(string, string, string, string, ReplicationProtectionClustersListByReplicationProtectionContainersOptionalParams)

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

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

Parameters

resourceGroupName

string

The name of the resource group where the recovery services vault is present.

resourceName

string

The name of the recovery services vault.

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

Returns