ReplicationProtectedItems interface

Interface representing a ReplicationProtectedItems.

Methods

beginAddDisks(string, string, string, string, string, AddDisksInput, ReplicationProtectedItemsAddDisksOptionalParams)

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

beginAddDisksAndWait(string, string, string, string, string, AddDisksInput, ReplicationProtectedItemsAddDisksOptionalParams)

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

beginApplyRecoveryPoint(string, string, string, string, string, ApplyRecoveryPointInput, ReplicationProtectedItemsApplyRecoveryPointOptionalParams)

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

beginApplyRecoveryPointAndWait(string, string, string, string, string, ApplyRecoveryPointInput, ReplicationProtectedItemsApplyRecoveryPointOptionalParams)

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

beginCreate(string, string, string, string, string, EnableProtectionInput, ReplicationProtectedItemsCreateOptionalParams)

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

beginCreateAndWait(string, string, string, string, string, EnableProtectionInput, ReplicationProtectedItemsCreateOptionalParams)

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

beginDelete(string, string, string, string, string, DisableProtectionInput, ReplicationProtectedItemsDeleteOptionalParams)

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

beginDeleteAndWait(string, string, string, string, string, DisableProtectionInput, ReplicationProtectedItemsDeleteOptionalParams)

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

beginFailoverCancel(string, string, string, string, string, ReplicationProtectedItemsFailoverCancelOptionalParams)

Operation to cancel the failover of the replication protected item.

beginFailoverCancelAndWait(string, string, string, string, string, ReplicationProtectedItemsFailoverCancelOptionalParams)

Operation to cancel the failover of the replication protected item.

beginFailoverCommit(string, string, string, string, string, ReplicationProtectedItemsFailoverCommitOptionalParams)

Operation to commit the failover of the replication protected item.

beginFailoverCommitAndWait(string, string, string, string, string, ReplicationProtectedItemsFailoverCommitOptionalParams)

Operation to commit the failover of the replication protected item.

beginPlannedFailover(string, string, string, string, string, PlannedFailoverInput, ReplicationProtectedItemsPlannedFailoverOptionalParams)

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

beginPlannedFailoverAndWait(string, string, string, string, string, PlannedFailoverInput, ReplicationProtectedItemsPlannedFailoverOptionalParams)

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

beginPurge(string, string, string, string, string, ReplicationProtectedItemsPurgeOptionalParams)

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.

beginPurgeAndWait(string, string, string, string, string, ReplicationProtectedItemsPurgeOptionalParams)

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.

beginRemoveDisks(string, string, string, string, string, RemoveDisksInput, ReplicationProtectedItemsRemoveDisksOptionalParams)

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

beginRemoveDisksAndWait(string, string, string, string, string, RemoveDisksInput, ReplicationProtectedItemsRemoveDisksOptionalParams)

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

beginRepairReplication(string, string, string, string, string, ReplicationProtectedItemsRepairReplicationOptionalParams)

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

beginRepairReplicationAndWait(string, string, string, string, string, ReplicationProtectedItemsRepairReplicationOptionalParams)

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

beginReprotect(string, string, string, string, string, ReverseReplicationInput, ReplicationProtectedItemsReprotectOptionalParams)

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

beginReprotectAndWait(string, string, string, string, string, ReverseReplicationInput, ReplicationProtectedItemsReprotectOptionalParams)

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

beginResolveHealthErrors(string, string, string, string, string, ResolveHealthInput, ReplicationProtectedItemsResolveHealthErrorsOptionalParams)

Operation to resolve health issues of the replication protected item.

beginResolveHealthErrorsAndWait(string, string, string, string, string, ResolveHealthInput, ReplicationProtectedItemsResolveHealthErrorsOptionalParams)

Operation to resolve health issues of the replication protected item.

beginSwitchProvider(string, string, string, string, string, SwitchProviderInput, ReplicationProtectedItemsSwitchProviderOptionalParams)

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

beginSwitchProviderAndWait(string, string, string, string, string, SwitchProviderInput, ReplicationProtectedItemsSwitchProviderOptionalParams)

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

beginTestFailover(string, string, string, string, string, TestFailoverInput, ReplicationProtectedItemsTestFailoverOptionalParams)

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

beginTestFailoverAndWait(string, string, string, string, string, TestFailoverInput, ReplicationProtectedItemsTestFailoverOptionalParams)

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

beginTestFailoverCleanup(string, string, string, string, string, TestFailoverCleanupInput, ReplicationProtectedItemsTestFailoverCleanupOptionalParams)

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

beginTestFailoverCleanupAndWait(string, string, string, string, string, TestFailoverCleanupInput, ReplicationProtectedItemsTestFailoverCleanupOptionalParams)

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

beginUnplannedFailover(string, string, string, string, string, UnplannedFailoverInput, ReplicationProtectedItemsUnplannedFailoverOptionalParams)

Operation to initiate a failover of the replication protected item.

beginUnplannedFailoverAndWait(string, string, string, string, string, UnplannedFailoverInput, ReplicationProtectedItemsUnplannedFailoverOptionalParams)

Operation to initiate a failover of the replication protected item.

beginUpdate(string, string, string, string, string, UpdateReplicationProtectedItemInput, ReplicationProtectedItemsUpdateOptionalParams)

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

beginUpdateAndWait(string, string, string, string, string, UpdateReplicationProtectedItemInput, ReplicationProtectedItemsUpdateOptionalParams)

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

beginUpdateAppliance(string, string, string, string, string, UpdateApplianceForReplicationProtectedItemInput, ReplicationProtectedItemsUpdateApplianceOptionalParams)

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

beginUpdateApplianceAndWait(string, string, string, string, string, UpdateApplianceForReplicationProtectedItemInput, ReplicationProtectedItemsUpdateApplianceOptionalParams)

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

beginUpdateMobilityService(string, string, string, string, string, UpdateMobilityServiceRequest, ReplicationProtectedItemsUpdateMobilityServiceOptionalParams)

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

beginUpdateMobilityServiceAndWait(string, string, string, string, string, UpdateMobilityServiceRequest, ReplicationProtectedItemsUpdateMobilityServiceOptionalParams)

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

get(string, string, string, string, string, ReplicationProtectedItemsGetOptionalParams)

Gets the details of an ASR replication protected item.

list(string, string, ReplicationProtectedItemsListOptionalParams)

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

listByReplicationProtectionContainers(string, string, string, string, ReplicationProtectedItemsListByReplicationProtectionContainersOptionalParams)

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

Method Details

beginAddDisks(string, string, string, string, string, AddDisksInput, ReplicationProtectedItemsAddDisksOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

addDisksInput
AddDisksInput

Add disks input.

options
ReplicationProtectedItemsAddDisksOptionalParams

The options parameters.

Returns

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

beginAddDisksAndWait(string, string, string, string, string, AddDisksInput, ReplicationProtectedItemsAddDisksOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

addDisksInput
AddDisksInput

Add disks input.

options
ReplicationProtectedItemsAddDisksOptionalParams

The options parameters.

Returns

beginApplyRecoveryPoint(string, string, string, string, string, ApplyRecoveryPointInput, ReplicationProtectedItemsApplyRecoveryPointOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

The ARM fabric name.

protectionContainerName

string

The protection container name.

replicatedProtectedItemName

string

The replicated protected item name.

applyRecoveryPointInput
ApplyRecoveryPointInput

The ApplyRecoveryPointInput.

Returns

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

beginApplyRecoveryPointAndWait(string, string, string, string, string, ApplyRecoveryPointInput, ReplicationProtectedItemsApplyRecoveryPointOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

The ARM fabric name.

protectionContainerName

string

The protection container name.

replicatedProtectedItemName

string

The replicated protected item name.

applyRecoveryPointInput
ApplyRecoveryPointInput

The ApplyRecoveryPointInput.

Returns

beginCreate(string, string, string, string, string, EnableProtectionInput, ReplicationProtectedItemsCreateOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Name of the fabric.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

A name for the replication protected item.

input
EnableProtectionInput

Enable Protection Input.

options
ReplicationProtectedItemsCreateOptionalParams

The options parameters.

Returns

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

beginCreateAndWait(string, string, string, string, string, EnableProtectionInput, ReplicationProtectedItemsCreateOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Name of the fabric.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

A name for the replication protected item.

input
EnableProtectionInput

Enable Protection Input.

options
ReplicationProtectedItemsCreateOptionalParams

The options parameters.

Returns

beginDelete(string, string, string, string, string, DisableProtectionInput, ReplicationProtectedItemsDeleteOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

disableProtectionInput
DisableProtectionInput

Disable protection input.

options
ReplicationProtectedItemsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, string, string, string, DisableProtectionInput, ReplicationProtectedItemsDeleteOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

disableProtectionInput
DisableProtectionInput

Disable protection input.

options
ReplicationProtectedItemsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginFailoverCancel(string, string, string, string, string, ReplicationProtectedItemsFailoverCancelOptionalParams)

Operation to cancel the failover of the replication protected item.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

Returns

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

beginFailoverCancelAndWait(string, string, string, string, string, ReplicationProtectedItemsFailoverCancelOptionalParams)

Operation to cancel the failover of the replication protected item.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

Returns

beginFailoverCommit(string, string, string, string, string, ReplicationProtectedItemsFailoverCommitOptionalParams)

Operation to commit the failover of the replication protected item.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

Returns

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

beginFailoverCommitAndWait(string, string, string, string, string, ReplicationProtectedItemsFailoverCommitOptionalParams)

Operation to commit the failover of the replication protected item.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

Returns

beginPlannedFailover(string, string, string, string, string, PlannedFailoverInput, ReplicationProtectedItemsPlannedFailoverOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

failoverInput
PlannedFailoverInput

Planned failover input.

Returns

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

beginPlannedFailoverAndWait(string, string, string, string, string, PlannedFailoverInput, ReplicationProtectedItemsPlannedFailoverOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

failoverInput
PlannedFailoverInput

Planned failover input.

Returns

beginPurge(string, string, string, string, string, ReplicationProtectedItemsPurgeOptionalParams)

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.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

options
ReplicationProtectedItemsPurgeOptionalParams

The options parameters.

Returns

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

beginPurgeAndWait(string, string, string, string, string, ReplicationProtectedItemsPurgeOptionalParams)

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.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

options
ReplicationProtectedItemsPurgeOptionalParams

The options parameters.

Returns

Promise<void>

beginRemoveDisks(string, string, string, string, string, RemoveDisksInput, ReplicationProtectedItemsRemoveDisksOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

removeDisksInput
RemoveDisksInput

Remove disks input.

options
ReplicationProtectedItemsRemoveDisksOptionalParams

The options parameters.

Returns

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

beginRemoveDisksAndWait(string, string, string, string, string, RemoveDisksInput, ReplicationProtectedItemsRemoveDisksOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

removeDisksInput
RemoveDisksInput

Remove disks input.

options
ReplicationProtectedItemsRemoveDisksOptionalParams

The options parameters.

Returns

beginRepairReplication(string, string, string, string, string, ReplicationProtectedItemsRepairReplicationOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

The name of the fabric.

protectionContainerName

string

The name of the container.

replicatedProtectedItemName

string

The name of the replication protected item.

Returns

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

beginRepairReplicationAndWait(string, string, string, string, string, ReplicationProtectedItemsRepairReplicationOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

The name of the fabric.

protectionContainerName

string

The name of the container.

replicatedProtectedItemName

string

The name of the replication protected item.

Returns

beginReprotect(string, string, string, string, string, ReverseReplicationInput, ReplicationProtectedItemsReprotectOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

reprotectInput
ReverseReplicationInput

Reverse replication input.

options
ReplicationProtectedItemsReprotectOptionalParams

The options parameters.

Returns

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

beginReprotectAndWait(string, string, string, string, string, ReverseReplicationInput, ReplicationProtectedItemsReprotectOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

reprotectInput
ReverseReplicationInput

Reverse replication input.

options
ReplicationProtectedItemsReprotectOptionalParams

The options parameters.

Returns

beginResolveHealthErrors(string, string, string, string, string, ResolveHealthInput, ReplicationProtectedItemsResolveHealthErrorsOptionalParams)

Operation to resolve health issues of the replication protected item.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

resolveHealthInput
ResolveHealthInput

Health issue input object.

Returns

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

beginResolveHealthErrorsAndWait(string, string, string, string, string, ResolveHealthInput, ReplicationProtectedItemsResolveHealthErrorsOptionalParams)

Operation to resolve health issues of the replication protected item.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

resolveHealthInput
ResolveHealthInput

Health issue input object.

Returns

beginSwitchProvider(string, string, string, string, string, SwitchProviderInput, ReplicationProtectedItemsSwitchProviderOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

switchProviderInput
SwitchProviderInput

Switch provider input.

Returns

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

beginSwitchProviderAndWait(string, string, string, string, string, SwitchProviderInput, ReplicationProtectedItemsSwitchProviderOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

switchProviderInput
SwitchProviderInput

Switch provider input.

Returns

beginTestFailover(string, string, string, string, string, TestFailoverInput, ReplicationProtectedItemsTestFailoverOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

testfailoverInput
TestFailoverInput

Test failover input.

options
ReplicationProtectedItemsTestFailoverOptionalParams

The options parameters.

Returns

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

beginTestFailoverAndWait(string, string, string, string, string, TestFailoverInput, ReplicationProtectedItemsTestFailoverOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

testfailoverInput
TestFailoverInput

Test failover input.

options
ReplicationProtectedItemsTestFailoverOptionalParams

The options parameters.

Returns

beginTestFailoverCleanup(string, string, string, string, string, TestFailoverCleanupInput, ReplicationProtectedItemsTestFailoverCleanupOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

cleanupInput
TestFailoverCleanupInput

Test failover cleanup input.

Returns

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

beginTestFailoverCleanupAndWait(string, string, string, string, string, TestFailoverCleanupInput, ReplicationProtectedItemsTestFailoverCleanupOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

cleanupInput
TestFailoverCleanupInput

Test failover cleanup input.

Returns

beginUnplannedFailover(string, string, string, string, string, UnplannedFailoverInput, ReplicationProtectedItemsUnplannedFailoverOptionalParams)

Operation to initiate a failover of the replication protected item.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

failoverInput
UnplannedFailoverInput

Failover input.

Returns

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

beginUnplannedFailoverAndWait(string, string, string, string, string, UnplannedFailoverInput, ReplicationProtectedItemsUnplannedFailoverOptionalParams)

Operation to initiate a failover of the replication protected item.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Unique fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

failoverInput
UnplannedFailoverInput

Failover input.

Returns

beginUpdate(string, string, string, string, string, UpdateReplicationProtectedItemInput, ReplicationProtectedItemsUpdateOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

updateProtectionInput
UpdateReplicationProtectedItemInput

Update protection input.

options
ReplicationProtectedItemsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, string, string, string, UpdateReplicationProtectedItemInput, ReplicationProtectedItemsUpdateOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

updateProtectionInput
UpdateReplicationProtectedItemInput

Update protection input.

options
ReplicationProtectedItemsUpdateOptionalParams

The options parameters.

Returns

beginUpdateAppliance(string, string, string, string, string, UpdateApplianceForReplicationProtectedItemInput, ReplicationProtectedItemsUpdateApplianceOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

applianceUpdateInput
UpdateApplianceForReplicationProtectedItemInput

Appliance update protection input.

Returns

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

beginUpdateApplianceAndWait(string, string, string, string, string, UpdateApplianceForReplicationProtectedItemInput, ReplicationProtectedItemsUpdateApplianceOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

applianceUpdateInput
UpdateApplianceForReplicationProtectedItemInput

Appliance update protection input.

Returns

beginUpdateMobilityService(string, string, string, string, string, UpdateMobilityServiceRequest, ReplicationProtectedItemsUpdateMobilityServiceOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

The name of the fabric containing the protected item.

protectionContainerName

string

The name of the container containing the protected item.

replicatedProtectedItemName

string

The name of the protected item on which the agent is to be updated.

updateMobilityServiceRequest
UpdateMobilityServiceRequest

Request to update the mobility service on the protected item.

Returns

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

beginUpdateMobilityServiceAndWait(string, string, string, string, string, UpdateMobilityServiceRequest, ReplicationProtectedItemsUpdateMobilityServiceOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

The name of the fabric containing the protected item.

protectionContainerName

string

The name of the container containing the protected item.

replicatedProtectedItemName

string

The name of the protected item on which the agent is to be updated.

updateMobilityServiceRequest
UpdateMobilityServiceRequest

Request to update the mobility service on the protected item.

Returns

get(string, string, string, string, string, ReplicationProtectedItemsGetOptionalParams)

Gets the details of an ASR replication protected item.

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric unique name.

protectionContainerName

string

Protection container name.

replicatedProtectedItemName

string

Replication protected item name.

options
ReplicationProtectedItemsGetOptionalParams

The options parameters.

Returns

list(string, string, ReplicationProtectedItemsListOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

options
ReplicationProtectedItemsListOptionalParams

The options parameters.

Returns

listByReplicationProtectionContainers(string, string, string, string, ReplicationProtectedItemsListByReplicationProtectionContainersOptionalParams)

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

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

Parameters

resourceName

string

The name of the recovery services vault.

resourceGroupName

string

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

fabricName

string

Fabric name.

protectionContainerName

string

Protection container name.

Returns