Package version:

Interface representing a ReplicationProtectedItems.

interface ReplicationProtectedItems {
    beginAddDisks(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, addDisksInput: AddDisksInput, options?: ReplicationProtectedItemsAddDisksOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginAddDisksAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, addDisksInput: AddDisksInput, options?: ReplicationProtectedItemsAddDisksOptionalParams): Promise<ReplicationProtectedItem>;
    beginApplyRecoveryPoint(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applyRecoveryPointInput: ApplyRecoveryPointInput, options?: ReplicationProtectedItemsApplyRecoveryPointOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginApplyRecoveryPointAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applyRecoveryPointInput: ApplyRecoveryPointInput, options?: ReplicationProtectedItemsApplyRecoveryPointOptionalParams): Promise<ReplicationProtectedItem>;
    beginCreate(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, input: EnableProtectionInput, options?: ReplicationProtectedItemsCreateOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginCreateAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, input: EnableProtectionInput, options?: ReplicationProtectedItemsCreateOptionalParams): Promise<ReplicationProtectedItem>;
    beginDelete(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, disableProtectionInput: DisableProtectionInput, options?: ReplicationProtectedItemsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginDeleteAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, disableProtectionInput: DisableProtectionInput, options?: ReplicationProtectedItemsDeleteOptionalParams): Promise<void>;
    beginFailoverCancel(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCancelOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginFailoverCancelAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCancelOptionalParams): Promise<ReplicationProtectedItem>;
    beginFailoverCommit(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCommitOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginFailoverCommitAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsFailoverCommitOptionalParams): Promise<ReplicationProtectedItem>;
    beginPlannedFailover(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: PlannedFailoverInput, options?: ReplicationProtectedItemsPlannedFailoverOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginPlannedFailoverAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: PlannedFailoverInput, options?: ReplicationProtectedItemsPlannedFailoverOptionalParams): Promise<ReplicationProtectedItem>;
    beginPurge(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsPurgeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
    beginPurgeAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsPurgeOptionalParams): Promise<void>;
    beginRemoveDisks(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, removeDisksInput: RemoveDisksInput, options?: ReplicationProtectedItemsRemoveDisksOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginRemoveDisksAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, removeDisksInput: RemoveDisksInput, options?: ReplicationProtectedItemsRemoveDisksOptionalParams): Promise<ReplicationProtectedItem>;
    beginRepairReplication(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsRepairReplicationOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginRepairReplicationAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsRepairReplicationOptionalParams): Promise<ReplicationProtectedItem>;
    beginReprotect(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, reprotectInput: ReverseReplicationInput, options?: ReplicationProtectedItemsReprotectOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginReprotectAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, reprotectInput: ReverseReplicationInput, options?: ReplicationProtectedItemsReprotectOptionalParams): Promise<ReplicationProtectedItem>;
    beginResolveHealthErrors(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, resolveHealthInput: ResolveHealthInput, options?: ReplicationProtectedItemsResolveHealthErrorsOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginResolveHealthErrorsAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, resolveHealthInput: ResolveHealthInput, options?: ReplicationProtectedItemsResolveHealthErrorsOptionalParams): Promise<ReplicationProtectedItem>;
    beginSwitchProvider(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, switchProviderInput: SwitchProviderInput, options?: ReplicationProtectedItemsSwitchProviderOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginSwitchProviderAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, switchProviderInput: SwitchProviderInput, options?: ReplicationProtectedItemsSwitchProviderOptionalParams): Promise<ReplicationProtectedItem>;
    beginTestFailover(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, testfailoverInput: TestFailoverInput, options?: ReplicationProtectedItemsTestFailoverOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginTestFailoverAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, testfailoverInput: TestFailoverInput, options?: ReplicationProtectedItemsTestFailoverOptionalParams): Promise<ReplicationProtectedItem>;
    beginTestFailoverCleanup(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, cleanupInput: TestFailoverCleanupInput, options?: ReplicationProtectedItemsTestFailoverCleanupOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginTestFailoverCleanupAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, cleanupInput: TestFailoverCleanupInput, options?: ReplicationProtectedItemsTestFailoverCleanupOptionalParams): Promise<ReplicationProtectedItem>;
    beginUnplannedFailover(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: UnplannedFailoverInput, options?: ReplicationProtectedItemsUnplannedFailoverOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginUnplannedFailoverAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, failoverInput: UnplannedFailoverInput, options?: ReplicationProtectedItemsUnplannedFailoverOptionalParams): Promise<ReplicationProtectedItem>;
    beginUpdate(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateProtectionInput: UpdateReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginUpdateAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateProtectionInput: UpdateReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateOptionalParams): Promise<ReplicationProtectedItem>;
    beginUpdateAppliance(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applianceUpdateInput: UpdateApplianceForReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateApplianceOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginUpdateApplianceAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, applianceUpdateInput: UpdateApplianceForReplicationProtectedItemInput, options?: ReplicationProtectedItemsUpdateApplianceOptionalParams): Promise<ReplicationProtectedItem>;
    beginUpdateMobilityService(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: UpdateMobilityServiceRequest, options?: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams): Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>;
    beginUpdateMobilityServiceAndWait(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, updateMobilityServiceRequest: UpdateMobilityServiceRequest, options?: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams): Promise<ReplicationProtectedItem>;
    get(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, replicatedProtectedItemName: string, options?: ReplicationProtectedItemsGetOptionalParams): Promise<ReplicationProtectedItem>;
    list(resourceGroupName: string, resourceName: string, options?: ReplicationProtectedItemsListOptionalParams): PagedAsyncIterableIterator<ReplicationProtectedItem>;
    listByReplicationProtectionContainers(resourceGroupName: string, resourceName: string, fabricName: string, protectionContainerName: string, options?: ReplicationProtectedItemsListByReplicationProtectionContainersOptionalParams): PagedAsyncIterableIterator<ReplicationProtectedItem>;
}

Methods

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Unique fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • addDisksInput: AddDisksInput

      Add disks input.

    • Optionaloptions: ReplicationProtectedItemsAddDisksOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      The ARM fabric name.

    • protectionContainerName: string

      The protection container name.

    • replicatedProtectedItemName: string

      The replicated protected item name.

    • applyRecoveryPointInput: ApplyRecoveryPointInput

      The ApplyRecoveryPointInput.

    • Optionaloptions: ReplicationProtectedItemsApplyRecoveryPointOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Name of the fabric.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      A name for the replication protected item.

    • input: EnableProtectionInput

      Enable Protection Input.

    • Optionaloptions: ReplicationProtectedItemsCreateOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • disableProtectionInput: DisableProtectionInput

      Disable protection input.

    • Optionaloptions: ReplicationProtectedItemsDeleteOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • disableProtectionInput: DisableProtectionInput

      Disable protection input.

    • Optionaloptions: ReplicationProtectedItemsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

  • Operation to cancel the failover of the replication protected item.

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Unique fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • Optionaloptions: ReplicationProtectedItemsFailoverCancelOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

  • Operation to commit the failover of the replication protected item.

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Unique fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • Optionaloptions: ReplicationProtectedItemsFailoverCommitOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

  • 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.

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • Optionaloptions: ReplicationProtectedItemsPurgeOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<void>, void>>

  • 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.

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • Optionaloptions: ReplicationProtectedItemsPurgeOptionalParams

      The options parameters.

    Returns Promise<void>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Unique fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • removeDisksInput: RemoveDisksInput

      Remove disks input.

    • Optionaloptions: ReplicationProtectedItemsRemoveDisksOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      The name of the fabric.

    • protectionContainerName: string

      The name of the container.

    • replicatedProtectedItemName: string

      The name of the replication protected item.

    • Optionaloptions: ReplicationProtectedItemsRepairReplicationOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Unique fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • reprotectInput: ReverseReplicationInput

      Reverse replication input.

    • Optionaloptions: ReplicationProtectedItemsReprotectOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Unique fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • switchProviderInput: SwitchProviderInput

      Switch provider input.

    • Optionaloptions: ReplicationProtectedItemsSwitchProviderOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Unique fabric name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • testfailoverInput: TestFailoverInput

      Test failover input.

    • Optionaloptions: ReplicationProtectedItemsTestFailoverOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      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.

    • Optionaloptions: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams

      The options parameters.

    Returns Promise<SimplePollerLike<OperationState<ReplicationProtectedItem>, ReplicationProtectedItem>>

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

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      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.

    • Optionaloptions: ReplicationProtectedItemsUpdateMobilityServiceOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>

  • Gets the details of an ASR replication protected item.

    Parameters

    • resourceGroupName: string

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

    • resourceName: string

      The name of the recovery services vault.

    • fabricName: string

      Fabric unique name.

    • protectionContainerName: string

      Protection container name.

    • replicatedProtectedItemName: string

      Replication protected item name.

    • Optionaloptions: ReplicationProtectedItemsGetOptionalParams

      The options parameters.

    Returns Promise<ReplicationProtectedItem>