Language

ReplicationProtectedItemResource Class

Definition

A Class representing a ReplicationProtectedItem along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct a ReplicationProtectedItemResource from an instance of ArmClient using the GetReplicationProtectedItemResource method. Otherwise you can get one from its parent resource SiteRecoveryProtectionContainerResource using the GetReplicationProtectedItem method.

public class ReplicationProtectedItemResource : Azure.ResourceManager.ArmResource, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.RecoveryServicesSiteRecovery.ReplicationProtectedItemData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.RecoveryServicesSiteRecovery.ReplicationProtectedItemData>
type ReplicationProtectedItemResource = class
    inherit ArmResource
    interface IJsonModel<ReplicationProtectedItemData>
    interface IPersistableModel<ReplicationProtectedItemData>
Public Class ReplicationProtectedItemResource
Inherits ArmResource
Implements IJsonModel(Of ReplicationProtectedItemData), IPersistableModel(Of ReplicationProtectedItemData)
Inheritance
ReplicationProtectedItemResource
Implements

Constructors

Name Description
ReplicationProtectedItemResource()

Initializes a new instance of the ReplicationProtectedItemResource class for mocking.

Fields

Name Description
ResourceType

Gets the resource type for the operations.

Properties

Name Description
Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmResource)
Data

Gets the data representing this Feature.

Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmResource)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmResource)
HasData

Gets whether or not the current instance has data.

Id

Gets the resource identifier.

(Inherited from ArmResource)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmResource)

Methods

Name Description
AddDisks(WaitUntil, SiteRecoveryAddDisksContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks
  • Operation Id: ReplicationProtectedItems_AddDisks
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
AddDisksAsync(WaitUntil, SiteRecoveryAddDisksContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/addDisks
  • Operation Id: ReplicationProtectedItems_AddDisks
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
ApplyRecoveryPoint(WaitUntil, SiteRecoveryApplyRecoveryPointContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint
  • Operation Id: ReplicationProtectedItems_ApplyRecoveryPoint
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
ApplyRecoveryPointAsync(WaitUntil, SiteRecoveryApplyRecoveryPointContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint
  • Operation Id: ReplicationProtectedItems_ApplyRecoveryPoint
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
CanUseTagResource(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)

Checks to see if the TagResource API is deployed in the current environment.

(Inherited from ArmResource)
CreateResourceIdentifier(String, String, String, String, String, String)

Generate the resource identifier of a ReplicationProtectedItemResource instance.

Delete(WaitUntil, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
  • Operation Id: ReplicationProtectedItems_Purge
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
Delete(WaitUntil, DisableProtectionContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove
  • Operation Id: ReplicationProtectedItems_Delete
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
DeleteAsync(WaitUntil, CancellationToken)

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.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
  • Operation Id: ReplicationProtectedItems_Purge
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
DeleteAsync(WaitUntil, DisableProtectionContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove
  • Operation Id: ReplicationProtectedItems_Delete
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
FailoverCancel(WaitUntil, CancellationToken)

Operation to cancel the failover of the replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel
  • Operation Id: ReplicationProtectedItems_FailoverCancel
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
FailoverCancelAsync(WaitUntil, CancellationToken)

Operation to cancel the failover of the replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCancel
  • Operation Id: ReplicationProtectedItems_FailoverCancel
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
FailoverCommit(WaitUntil, CancellationToken)

Operation to commit the failover of the replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit
  • Operation Id: ReplicationProtectedItems_FailoverCommit
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
FailoverCommitAsync(WaitUntil, CancellationToken)

Operation to commit the failover of the replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit
  • Operation Id: ReplicationProtectedItems_FailoverCommit
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
Get(CancellationToken)

Gets the details of an ASR replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
  • Operation Id: ReplicationProtectedItems_Get
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
GetAsync(CancellationToken)

Gets the details of an ASR replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
  • Operation Id: ReplicationProtectedItems_Get
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
GetAvailableLocations(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)

Lists all available geo-locations.

(Inherited from ArmResource)
GetManagementLock(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)

Get a management lock by scope.

  • Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName}
  • Operation Id: ManagementLocks_GetByScope
  • Default Api Version: 2020-05-01
  • Resource: ManagementLockResource
(Inherited from ArmResource)
GetManagementLocks()

Gets a collection of ManagementLockResources in the ArmResource.

(Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)

This operation retrieves a single policy assignment, given its name and the scope it was created at.

  • Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName}
  • Operation Id: PolicyAssignments_Get
  • Default Api Version: 2022-06-01
  • Resource: PolicyAssignmentResource
(Inherited from ArmResource)
GetPolicyAssignments()

Gets a collection of PolicyAssignmentResources in the ArmResource.

(Inherited from ArmResource)
GetSiteRecoveryPoint(String, CancellationToken)

Get the details of specified recovery point.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}
  • Operation Id: RecoveryPoints_Get
  • Default Api Version: 2025-01-01
  • Resource: SiteRecoveryPointResource
GetSiteRecoveryPointAsync(String, CancellationToken)

Get the details of specified recovery point.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}
  • Operation Id: RecoveryPoints_Get
  • Default Api Version: 2025-01-01
  • Resource: SiteRecoveryPointResource
GetSiteRecoveryPoints()

Gets a collection of SiteRecoveryPointResources in the ReplicationProtectedItem.

GetTagResource()

Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource.

(Inherited from ArmResource)
GetTargetComputeSizesByReplicationProtectedItems(CancellationToken)

Lists the available target compute sizes for a replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes
  • Operation Id: TargetComputeSizes_ListByReplicationProtectedItems
  • Default Api Version: 2025-01-01
GetTargetComputeSizesByReplicationProtectedItemsAsync(CancellationToken)

Lists the available target compute sizes for a replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes
  • Operation Id: TargetComputeSizes_ListByReplicationProtectedItems
  • Default Api Version: 2025-01-01
PlannedFailover(WaitUntil, PlannedFailoverContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover
  • Operation Id: ReplicationProtectedItems_PlannedFailover
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
PlannedFailoverAsync(WaitUntil, PlannedFailoverContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover
  • Operation Id: ReplicationProtectedItems_PlannedFailover
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
RemoveDisks(WaitUntil, RemoveDisksContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks
  • Operation Id: ReplicationProtectedItems_RemoveDisks
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
RemoveDisksAsync(WaitUntil, RemoveDisksContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/removeDisks
  • Operation Id: ReplicationProtectedItems_RemoveDisks
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
RepairReplication(WaitUntil, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication
  • Operation Id: ReplicationProtectedItems_RepairReplication
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
RepairReplicationAsync(WaitUntil, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication
  • Operation Id: ReplicationProtectedItems_RepairReplication
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
Reprotect(WaitUntil, ReverseReplicationContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect
  • Operation Id: ReplicationProtectedItems_Reprotect
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
ReprotectAsync(WaitUntil, ReverseReplicationContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect
  • Operation Id: ReplicationProtectedItems_Reprotect
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
ResolveHealthErrors(WaitUntil, ResolveHealthContent, CancellationToken)

Operation to resolve health issues of the replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors
  • Operation Id: ReplicationProtectedItems_ResolveHealthErrors
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
ResolveHealthErrorsAsync(WaitUntil, ResolveHealthContent, CancellationToken)

Operation to resolve health issues of the replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/resolveHealthErrors
  • Operation Id: ReplicationProtectedItems_ResolveHealthErrors
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
SwitchProvider(WaitUntil, SwitchProviderContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/switchProvider
  • Operation Id: ReplicationProtectedItems_SwitchProvider
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
SwitchProviderAsync(WaitUntil, SwitchProviderContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/switchProvider
  • Operation Id: ReplicationProtectedItems_SwitchProvider
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
TestFailover(WaitUntil, TestFailoverContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover
  • Operation Id: ReplicationProtectedItems_TestFailover
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
TestFailoverAsync(WaitUntil, TestFailoverContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover
  • Operation Id: ReplicationProtectedItems_TestFailover
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
TestFailoverCleanup(WaitUntil, TestFailoverCleanupContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup
  • Operation Id: ReplicationProtectedItems_TestFailoverCleanup
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
TestFailoverCleanupAsync(WaitUntil, TestFailoverCleanupContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup
  • Operation Id: ReplicationProtectedItems_TestFailoverCleanup
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmResource)
UnplannedFailover(WaitUntil, UnplannedFailoverContent, CancellationToken)

Operation to initiate a failover of the replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover
  • Operation Id: ReplicationProtectedItems_UnplannedFailover
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
UnplannedFailoverAsync(WaitUntil, UnplannedFailoverContent, CancellationToken)

Operation to initiate a failover of the replication protected item.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover
  • Operation Id: ReplicationProtectedItems_UnplannedFailover
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
Update(WaitUntil, ReplicationProtectedItemPatch, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
  • Operation Id: ReplicationProtectedItems_Update
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
UpdateAppliance(WaitUntil, UpdateApplianceForReplicationProtectedItemContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance
  • Operation Id: ReplicationProtectedItems_UpdateAppliance
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
UpdateApplianceAsync(WaitUntil, UpdateApplianceForReplicationProtectedItemContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateAppliance
  • Operation Id: ReplicationProtectedItems_UpdateAppliance
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
UpdateAsync(WaitUntil, ReplicationProtectedItemPatch, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}
  • Operation Id: ReplicationProtectedItems_Update
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
UpdateMobilityService(WaitUntil, UpdateMobilityServiceContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateMobilityService
  • Operation Id: ReplicationProtectedItems_UpdateMobilityService
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource
UpdateMobilityServiceAsync(WaitUntil, UpdateMobilityServiceContent, CancellationToken)

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

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/updateMobilityService
  • Operation Id: ReplicationProtectedItems_UpdateMobilityService
  • Default Api Version: 2025-01-01
  • Resource: ReplicationProtectedItemResource

Explicit Interface Implementations

Name Description
IJsonModel<ReplicationProtectedItemData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ReplicationProtectedItemData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ReplicationProtectedItemData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ReplicationProtectedItemData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ReplicationProtectedItemData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Extension Methods

Name Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Gets the role definition identified by roleDefinitionId at this resource scope.

GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentCollection objects within the specified scope.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
  • Default Api Version: 2022-05-01
  • Resource: LinkerResource
<item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)

Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentCollection objects within the specified scope.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope.

GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope.

GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyCollection objects within the specified scope.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope.

GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope.

GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to