ReplicationProtectedItemsOperations interface

Package:

@azure/arm-recoveryservices-siterecovery

Interface representing a ReplicationProtectedItems operations.

Properties

addDisks	Operation to add disks(s) to the replication protected item.
applyRecoveryPoint	The operation to change the recovery point of a failed over replication protected item.
beginAddDisks
beginAddDisksAndWait
beginApplyRecoveryPoint
beginApplyRecoveryPointAndWait
beginCreate
beginCreateAndWait
beginDelete
beginDeleteAndWait
beginFailoverCancel
beginFailoverCancelAndWait
beginFailoverCommit
beginFailoverCommitAndWait
beginPlannedFailover
beginPlannedFailoverAndWait
beginPurge
beginPurgeAndWait
beginReinstallMobilityService
beginReinstallMobilityServiceAndWait
beginRemoveDisks
beginRemoveDisksAndWait
beginRepairReplication
beginRepairReplicationAndWait
beginReprotect
beginReprotectAndWait
beginResolveHealthErrors
beginResolveHealthErrorsAndWait
beginSwitchProvider
beginSwitchProviderAndWait
beginTestFailover
beginTestFailoverAndWait
beginTestFailoverCleanup
beginTestFailoverCleanupAndWait
beginUnplannedFailover
beginUnplannedFailoverAndWait
beginUpdate
beginUpdateAndWait
beginUpdateAppliance
beginUpdateApplianceAndWait
beginUpdateMobilityService
beginUpdateMobilityServiceAndWait
create	The operation to create an ASR replication protected item (Enable replication).
delete	The operation to disable replication on a replication protected item. This will also remove the item.
failoverCancel	Operation to cancel the failover of the replication protected item.
failoverCommit	Operation to commit the failover of the replication protected item.
get	Gets the details of an ASR replication protected item.
list	Gets the list of ASR replication protected items in the vault.
listByReplicationProtectionContainers	Gets the list of ASR replication protected items in the protection container.
plannedFailover	Operation to initiate a planned failover of the replication protected item.
purge	The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.
reinstallMobilityService	The operation to reinstall the installed mobility service software on a replication protected item to the latest available version.
removeDisks	Operation to remove disk(s) from the replication protected item.
repairReplication	The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.
reprotect	Operation to reprotect or reverse replicate a failed over replication protected item.
resolveHealthErrors	Operation to resolve health issues of the replication protected item.
switchProvider	Operation to initiate a switch provider of the replication protected item.
testFailover	Operation to perform a test failover of the replication protected item.
testFailoverCleanup	Operation to clean up the test failover of a replication protected item.
unplannedFailover	Operation to initiate a failover of the replication protected item.
update	The operation to update the recovery settings of an ASR replication protected item.
updateAppliance	The operation to update appliance of an ASR replication protected item.
updateMobilityService	The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.

Property Details

addDisks

Operation to add disks(s) to the replication protected item.

addDisks: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, addDisksInput: AddDisksInput, options?: ReplicationProtectedItemsAddDisksOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, addDisksInput: AddDisksInput, options?: ReplicationProtectedItemsAddDisksOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

applyRecoveryPoint

The operation to change the recovery point of a failed over replication protected item.

applyRecoveryPoint: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applyRecoveryPointInput: ApplyRecoveryPointInput, options?: ReplicationProtectedItemsApplyRecoveryPointOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applyRecoveryPointInput: ApplyRecoveryPointInput, options?: ReplicationProtectedItemsApplyRecoveryPointOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

beginAddDisks

Warning

This API is now deprecated.

use addDisks instead

beginAddDisks: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, addDisksInput: AddDisksInput, options?: ReplicationProtectedItemsAddDisksOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, addDisksInput: AddDisksInput, options?: ReplicationProtectedItemsAddDisksOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginAddDisksAndWait

Warning

This API is now deprecated.

use addDisks instead

beginAddDisksAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, addDisksInput: AddDisksInput, options?: ReplicationProtectedItemsAddDisksOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, addDisksInput: AddDisksInput, options?: ReplicationProtectedItemsAddDisksOptionalParams) => Promise<ReplicationProtectedItem>

beginApplyRecoveryPoint

Warning

This API is now deprecated.

use applyRecoveryPoint instead

beginApplyRecoveryPoint: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applyRecoveryPointInput: ApplyRecoveryPointInput, options?: ReplicationProtectedItemsApplyRecoveryPointOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applyRecoveryPointInput: ApplyRecoveryPointInput, options?: ReplicationProtectedItemsApplyRecoveryPointOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginApplyRecoveryPointAndWait

Warning

This API is now deprecated.

use applyRecoveryPoint instead

beginApplyRecoveryPointAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applyRecoveryPointInput: ApplyRecoveryPointInput, options?: ReplicationProtectedItemsApplyRecoveryPointOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applyRecoveryPointInput: ApplyRecoveryPointInput, options?: ReplicationProtectedItemsApplyRecoveryPointOptionalParams) => Promise<ReplicationProtectedItem>

beginCreate

Warning

This API is now deprecated.

use create instead

beginCreate: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, input: EnableProtectionInput, options?: ReplicationProtectedItemsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, input: EnableProtectionInput, options?: ReplicationProtectedItemsCreateOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginCreateAndWait

Warning

This API is now deprecated.

use create instead

beginCreateAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, input: EnableProtectionInput, options?: ReplicationProtectedItemsCreateOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, input: EnableProtectionInput, options?: ReplicationProtectedItemsCreateOptionalParams) => Promise<ReplicationProtectedItem>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, disableProtectionInput: DisableProtectionInput, options?: ReplicationProtectedItemsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, disableProtectionInput: DisableProtectionInput, options?: ReplicationProtectedItemsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, disableProtectionInput: DisableProtectionInput, options?: ReplicationProtectedItemsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, disableProtectionInput: DisableProtectionInput, options?: ReplicationProtectedItemsDeleteOptionalParams) => Promise<void>

beginFailoverCancel

Warning

This API is now deprecated.

use failoverCancel instead

beginFailoverCancel: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCancelOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCancelOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginFailoverCancelAndWait

Warning

This API is now deprecated.

use failoverCancel instead

beginFailoverCancelAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCancelOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCancelOptionalParams) => Promise<ReplicationProtectedItem>

beginFailoverCommit

Warning

This API is now deprecated.

use failoverCommit instead

beginFailoverCommit: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCommitOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCommitOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginFailoverCommitAndWait

Warning

This API is now deprecated.

use failoverCommit instead

beginFailoverCommitAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCommitOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCommitOptionalParams) => Promise<ReplicationProtectedItem>

beginPlannedFailover

Warning

This API is now deprecated.

use plannedFailover instead

beginPlannedFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: PlannedFailoverInput, options?: ReplicationProtectedItemsPlannedFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: PlannedFailoverInput, options?: ReplicationProtectedItemsPlannedFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginPlannedFailoverAndWait

Warning

This API is now deprecated.

use plannedFailover instead

beginPlannedFailoverAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: PlannedFailoverInput, options?: ReplicationProtectedItemsPlannedFailoverOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: PlannedFailoverInput, options?: ReplicationProtectedItemsPlannedFailoverOptionalParams) => Promise<ReplicationProtectedItem>

beginPurge

Warning

This API is now deprecated.

use purge instead

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

Property Value

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

beginPurgeAndWait

Warning

This API is now deprecated.

use purge instead

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

Property Value

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

beginReinstallMobilityService

Warning

This API is now deprecated.

use reinstallMobilityService instead

beginReinstallMobilityService: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: ReinstallMobilityServiceRequest, options?: ReplicationProtectedItemsReinstallMobilityServiceOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: ReinstallMobilityServiceRequest, options?: ReplicationProtectedItemsReinstallMobilityServiceOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginReinstallMobilityServiceAndWait

Warning

This API is now deprecated.

use reinstallMobilityService instead

beginReinstallMobilityServiceAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: ReinstallMobilityServiceRequest, options?: ReplicationProtectedItemsReinstallMobilityServiceOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: ReinstallMobilityServiceRequest, options?: ReplicationProtectedItemsReinstallMobilityServiceOptionalParams) => Promise<ReplicationProtectedItem>

beginRemoveDisks

Warning

This API is now deprecated.

use removeDisks instead

beginRemoveDisks: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, removeDisksInput: RemoveDisksInput, options?: ReplicationProtectedItemsRemoveDisksOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, removeDisksInput: RemoveDisksInput, options?: ReplicationProtectedItemsRemoveDisksOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginRemoveDisksAndWait

Warning

This API is now deprecated.

use removeDisks instead

beginRemoveDisksAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, removeDisksInput: RemoveDisksInput, options?: ReplicationProtectedItemsRemoveDisksOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, removeDisksInput: RemoveDisksInput, options?: ReplicationProtectedItemsRemoveDisksOptionalParams) => Promise<ReplicationProtectedItem>

beginRepairReplication

Warning

This API is now deprecated.

use repairReplication instead

beginRepairReplication: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsRepairReplicationOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsRepairReplicationOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginRepairReplicationAndWait

Warning

This API is now deprecated.

use repairReplication instead

beginRepairReplicationAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsRepairReplicationOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsRepairReplicationOptionalParams) => Promise<ReplicationProtectedItem>

beginReprotect

Warning

This API is now deprecated.

use reprotect instead

beginReprotect: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, reprotectInput: ReverseReplicationInput, options?: ReplicationProtectedItemsReprotectOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, reprotectInput: ReverseReplicationInput, options?: ReplicationProtectedItemsReprotectOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginReprotectAndWait

Warning

This API is now deprecated.

use reprotect instead

beginReprotectAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, reprotectInput: ReverseReplicationInput, options?: ReplicationProtectedItemsReprotectOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, reprotectInput: ReverseReplicationInput, options?: ReplicationProtectedItemsReprotectOptionalParams) => Promise<ReplicationProtectedItem>

beginResolveHealthErrors

Warning

This API is now deprecated.

use resolveHealthErrors instead

beginResolveHealthErrors: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, resolveHealthInput: ResolveHealthInput, options?: ReplicationProtectedItemsResolveHealthErrorsOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, resolveHealthInput: ResolveHealthInput, options?: ReplicationProtectedItemsResolveHealthErrorsOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginResolveHealthErrorsAndWait

Warning

This API is now deprecated.

use resolveHealthErrors instead

beginResolveHealthErrorsAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, resolveHealthInput: ResolveHealthInput, options?: ReplicationProtectedItemsResolveHealthErrorsOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, resolveHealthInput: ResolveHealthInput, options?: ReplicationProtectedItemsResolveHealthErrorsOptionalParams) => Promise<ReplicationProtectedItem>

beginSwitchProvider

Warning

This API is now deprecated.

use switchProvider instead

beginSwitchProvider: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, switchProviderInput: SwitchProviderInput, options?: ReplicationProtectedItemsSwitchProviderOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, switchProviderInput: SwitchProviderInput, options?: ReplicationProtectedItemsSwitchProviderOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginSwitchProviderAndWait

Warning

This API is now deprecated.

use switchProvider instead

beginSwitchProviderAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, switchProviderInput: SwitchProviderInput, options?: ReplicationProtectedItemsSwitchProviderOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, switchProviderInput: SwitchProviderInput, options?: ReplicationProtectedItemsSwitchProviderOptionalParams) => Promise<ReplicationProtectedItem>

beginTestFailover

Warning

This API is now deprecated.

use testFailover instead

beginTestFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, testfailoverInput: TestFailoverInput, options?: ReplicationProtectedItemsTestFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, testfailoverInput: TestFailoverInput, options?: ReplicationProtectedItemsTestFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginTestFailoverAndWait

Warning

This API is now deprecated.

use testFailover instead

beginTestFailoverAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, testfailoverInput: TestFailoverInput, options?: ReplicationProtectedItemsTestFailoverOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, testfailoverInput: TestFailoverInput, options?: ReplicationProtectedItemsTestFailoverOptionalParams) => Promise<ReplicationProtectedItem>

beginTestFailoverCleanup

Warning

This API is now deprecated.

use testFailoverCleanup instead

beginTestFailoverCleanup: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, cleanupInput: TestFailoverCleanupInput, options?: ReplicationProtectedItemsTestFailoverCleanupOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, cleanupInput: TestFailoverCleanupInput, options?: ReplicationProtectedItemsTestFailoverCleanupOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginTestFailoverCleanupAndWait

Warning

This API is now deprecated.

use testFailoverCleanup instead

beginTestFailoverCleanupAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, cleanupInput: TestFailoverCleanupInput, options?: ReplicationProtectedItemsTestFailoverCleanupOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, cleanupInput: TestFailoverCleanupInput, options?: ReplicationProtectedItemsTestFailoverCleanupOptionalParams) => Promise<ReplicationProtectedItem>

beginUnplannedFailover

Warning

This API is now deprecated.

use unplannedFailover instead

beginUnplannedFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: UnplannedFailoverInput, options?: ReplicationProtectedItemsUnplannedFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: UnplannedFailoverInput, options?: ReplicationProtectedItemsUnplannedFailoverOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginUnplannedFailoverAndWait

Warning

This API is now deprecated.

use unplannedFailover instead

beginUnplannedFailoverAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: UnplannedFailoverInput, options?: ReplicationProtectedItemsUnplannedFailoverOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: UnplannedFailoverInput, options?: ReplicationProtectedItemsUnplannedFailoverOptionalParams) => Promise<ReplicationProtectedItem>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateProtectionInput: UpdateReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateProtectionInput: UpdateReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateProtectionInput: UpdateReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateProtectionInput: UpdateReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateOptionalParams) => Promise<ReplicationProtectedItem>

beginUpdateAppliance

Warning

This API is now deprecated.

use updateAppliance instead

beginUpdateAppliance: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applianceUpdateInput: UpdateApplianceForReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateApplianceOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applianceUpdateInput: UpdateApplianceForReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateApplianceOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginUpdateApplianceAndWait

Warning

This API is now deprecated.

use updateAppliance instead

beginUpdateApplianceAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applianceUpdateInput: UpdateApplianceForReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateApplianceOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applianceUpdateInput: UpdateApplianceForReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateApplianceOptionalParams) => Promise<ReplicationProtectedItem>

beginUpdateMobilityService

Warning

This API is now deprecated.

use updateMobilityService instead

beginUpdateMobilityService: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: UpdateMobilityServiceRequest, options?: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: UpdateMobilityServiceRequest, options?: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams) => Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

beginUpdateMobilityServiceAndWait

Warning

This API is now deprecated.

use updateMobilityService instead

beginUpdateMobilityServiceAndWait: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: UpdateMobilityServiceRequest, options?: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: UpdateMobilityServiceRequest, options?: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams) => Promise<ReplicationProtectedItem>

create

The operation to create an ASR replication protected item (Enable replication).

create: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, input: EnableProtectionInput, options?: ReplicationProtectedItemsCreateOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, input: EnableProtectionInput, options?: ReplicationProtectedItemsCreateOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

delete

The operation to disable replication on a replication protected item. This will also remove the item.

delete: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, disableProtectionInput: DisableProtectionInput, options?: ReplicationProtectedItemsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, disableProtectionInput: DisableProtectionInput, options?: ReplicationProtectedItemsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

failoverCancel

Operation to cancel the failover of the replication protected item.

failoverCancel: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCancelOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCancelOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

failoverCommit

Operation to commit the failover of the replication protected item.

failoverCommit: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCommitOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCommitOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

get

Gets the details of an ASR replication protected item.

get: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsGetOptionalParams) => Promise<ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsGetOptionalParams) => Promise<ReplicationProtectedItem>

list

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

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

Property Value

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

listByReplicationProtectionContainers

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

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

Property Value

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

plannedFailover

Operation to initiate a planned failover of the replication protected item.

plannedFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: PlannedFailoverInput, options?: ReplicationProtectedItemsPlannedFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: PlannedFailoverInput, options?: ReplicationProtectedItemsPlannedFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

purge

The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.

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

Property Value

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

reinstallMobilityService

The operation to reinstall the installed mobility service software on a replication protected item to the latest available version.

reinstallMobilityService: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: ReinstallMobilityServiceRequest, options?: ReplicationProtectedItemsReinstallMobilityServiceOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: ReinstallMobilityServiceRequest, options?: ReplicationProtectedItemsReinstallMobilityServiceOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

removeDisks

Operation to remove disk(s) from the replication protected item.

removeDisks: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, removeDisksInput: RemoveDisksInput, options?: ReplicationProtectedItemsRemoveDisksOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, removeDisksInput: RemoveDisksInput, options?: ReplicationProtectedItemsRemoveDisksOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

repairReplication

The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.

repairReplication: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsRepairReplicationOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsRepairReplicationOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

reprotect

Operation to reprotect or reverse replicate a failed over replication protected item.

reprotect: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, reprotectInput: ReverseReplicationInput, options?: ReplicationProtectedItemsReprotectOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, reprotectInput: ReverseReplicationInput, options?: ReplicationProtectedItemsReprotectOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

resolveHealthErrors

Operation to resolve health issues of the replication protected item.

resolveHealthErrors: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, resolveHealthInput: ResolveHealthInput, options?: ReplicationProtectedItemsResolveHealthErrorsOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, resolveHealthInput: ResolveHealthInput, options?: ReplicationProtectedItemsResolveHealthErrorsOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

switchProvider

Operation to initiate a switch provider of the replication protected item.

switchProvider: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, switchProviderInput: SwitchProviderInput, options?: ReplicationProtectedItemsSwitchProviderOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, switchProviderInput: SwitchProviderInput, options?: ReplicationProtectedItemsSwitchProviderOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

testFailover

Operation to perform a test failover of the replication protected item.

testFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, testfailoverInput: TestFailoverInput, options?: ReplicationProtectedItemsTestFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, testfailoverInput: TestFailoverInput, options?: ReplicationProtectedItemsTestFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

testFailoverCleanup

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

testFailoverCleanup: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, cleanupInput: TestFailoverCleanupInput, options?: ReplicationProtectedItemsTestFailoverCleanupOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, cleanupInput: TestFailoverCleanupInput, options?: ReplicationProtectedItemsTestFailoverCleanupOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

unplannedFailover

Operation to initiate a failover of the replication protected item.

unplannedFailover: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: UnplannedFailoverInput, options?: ReplicationProtectedItemsUnplannedFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: UnplannedFailoverInput, options?: ReplicationProtectedItemsUnplannedFailoverOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

update

The operation to update the recovery settings of an ASR replication protected item.

update: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateProtectionInput: UpdateReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateProtectionInput: UpdateReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

updateAppliance

The operation to update appliance of an ASR replication protected item.

updateAppliance: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applianceUpdateInput: UpdateApplianceForReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateApplianceOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applianceUpdateInput: UpdateApplianceForReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateApplianceOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

updateMobilityService

The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.

updateMobilityService: (resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: UpdateMobilityServiceRequest, options?: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>

Property Value

(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: UpdateMobilityServiceRequest, options?: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams) => PollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>