Share via


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
type ReplicationProtectedItemResource = class
    inherit ArmResource
Public Class ReplicationProtectedItemResource
Inherits ArmResource
Inheritance
ReplicationProtectedItemResource

Constructors

ReplicationProtectedItemResource()

Initializes a new instance of the ReplicationProtectedItemResource class for mocking.

Fields

ResourceType

Gets the resource type for the operations.

Properties

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

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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-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: 2023-08-01
  • Resource: ReplicationProtectedItemResource

Extension Methods

GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)

Get role definition by name (GUID).

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}
  • Operation Id: RoleDefinitions_Get
  • Default Api Version: 2022-04-01
  • Resource: AuthorizationRoleDefinitionResource
GetAuthorizationRoleDefinitions(ArmResource)

Gets a collection of AuthorizationRoleDefinitionResources in the ArmResource. MockingTo mock this method, please mock GetAuthorizationRoleDefinitions() instead.

GetDenyAssignment(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified deny assignment.

  • Request Path: /{scope}/providers/Microsoft.Authorization/denyAssignments/{denyAssignmentId}
  • Operation Id: DenyAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: DenyAssignmentResource
GetDenyAssignments(ArmResource)

Gets a collection of DenyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetDenyAssignments() instead.

GetRoleAssignment(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)

Get a role assignment by scope and name.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}
  • Operation Id: RoleAssignments_Get
  • Default Api Version: 2022-04-01
  • Resource: RoleAssignmentResource
GetRoleAssignments(ArmResource)

Gets a collection of RoleAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignments() instead.

GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentSchedules/{roleAssignmentScheduleName}
  • Operation Id: RoleAssignmentSchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleResource
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role assignment schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleInstances/{roleAssignmentScheduleInstanceName}
  • Operation Id: RoleAssignmentScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleInstanceResource
GetRoleAssignmentScheduleInstances(ArmResource)

Gets a collection of RoleAssignmentScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleInstances() instead.

GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role assignment schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleAssignmentScheduleRequests/{roleAssignmentScheduleRequestName}
  • Operation Id: RoleAssignmentScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleAssignmentScheduleRequestResource
GetRoleAssignmentScheduleRequests(ArmResource)

Gets a collection of RoleAssignmentScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentScheduleRequests() instead.

GetRoleAssignmentSchedules(ArmResource)

Gets a collection of RoleAssignmentScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleAssignmentSchedules() instead.

GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilitySchedules/{roleEligibilityScheduleName}
  • Operation Id: RoleEligibilitySchedules_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleResource
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)

Gets the specified role eligibility schedule instance.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleInstances/{roleEligibilityScheduleInstanceName}
  • Operation Id: RoleEligibilityScheduleInstances_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleInstanceResource
GetRoleEligibilityScheduleInstances(ArmResource)

Gets a collection of RoleEligibilityScheduleInstanceResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleInstances() instead.

GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)

Get the specified role eligibility schedule request.

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleEligibilityScheduleRequests/{roleEligibilityScheduleRequestName}
  • Operation Id: RoleEligibilityScheduleRequests_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleEligibilityScheduleRequestResource
GetRoleEligibilityScheduleRequests(ArmResource)

Gets a collection of RoleEligibilityScheduleRequestResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilityScheduleRequests() instead.

GetRoleEligibilitySchedules(ArmResource)

Gets a collection of RoleEligibilityScheduleResources in the ArmResource. MockingTo mock this method, please mock GetRoleEligibilitySchedules() instead.

GetRoleManagementPolicies(ArmResource)

Gets a collection of RoleManagementPolicyResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicies() instead.

GetRoleManagementPolicy(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)

Get the specified role management policy assignment for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicyAssignments/{roleManagementPolicyAssignmentName}
  • Operation Id: RoleManagementPolicyAssignments_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyAssignmentResource
GetRoleManagementPolicyAssignments(ArmResource)

Gets a collection of RoleManagementPolicyAssignmentResources in the ArmResource. MockingTo mock this method, please mock GetRoleManagementPolicyAssignments() instead.

GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)

Get the specified role management policy for a resource scope

  • Request Path: /{scope}/providers/Microsoft.Authorization/roleManagementPolicies/{roleManagementPolicyName}
  • Operation Id: RoleManagementPolicies_Get
  • Default Api Version: 2020-10-01
  • Resource: RoleManagementPolicyResource
GetSystemAssignedIdentity(ArmResource)

Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource. MockingTo mock this method, please mock GetSystemAssignedIdentity() instead.

GetLinkerResource(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResourceAsync(ArmResource, String, CancellationToken)

Returns Linker resource for a given name.

  • Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}
  • Operation Id: Linker_Get
GetLinkerResources(ArmResource)

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

Applies to