Update-AzureSiteRecoveryProtectionDirection
Updates the source and target server for the protection of a Site Recovery object.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
ByRPObject (Default)
Update-AzureSiteRecoveryProtectionDirection
-RecoveryPlan <ASRRecoveryPlan>
-Direction <String>
[-WaitForCompletion]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByRPId
Update-AzureSiteRecoveryProtectionDirection
-RPId <String>
-Direction <String>
[-WaitForCompletion]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByPEId
Update-AzureSiteRecoveryProtectionDirection
-ProtectionEntityId <String>
-ProtectionContainerId <String>
-Direction <String>
[-WaitForCompletion]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
ByPEObject
Update-AzureSiteRecoveryProtectionDirection
-ProtectionEntity <ASRProtectionEntity>
-Direction <String>
[-WaitForCompletion]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
The Update-AzureSiteRecoveryProtectionDirection cmdlet updates the source and target server for the protection of an Azure Site Recovery object after a commit failover operation finishes.
Examples
Example 1: Modify the direction for a protected object in a container
PS C:\> $Container = Get-AzureSiteRecoveryProtectionContainer
PS C:\> $Protected = Get-AzureSiteRecoveryProtectionEntity -ProtectionContainer $Container
PS C:\> Update-AzureSiteRecoveryProtectionDirection -Direction RecoveryToPrimary -ProtectionEntity $Protected
ID : c38eecdc-731c-405b-a61c-08db99aae2fe
ClientRequestId : 32ace403-0916-4967-83a1-529176bd6e88-2014-49-06 15:49:24Z-P
State : NotStarted
StateDescription : NotStarted
StartTime :
EndTime :
AllowedActions : {}
Name :
Tasks : {}
Errors : {}
The first command gets the protected containers in the current Azure Site Recovery vault by using the Get-AzureSiteRecoveryProtectionContainer cmdlet, and then stores it in the $Container variable.
The second command gets the virtual machines that belong to the container stored in $Container by using the Get-AzureSiteRecoveryProtectionEntity cmdlet. The command stores the results in the $Protected variable.
The final command sets the direction to RecoverToPrimary for the objects stored in $Protected.
Parameters
-Direction
Specifies the direction of the commit. The acceptable values for this parameter are:
- PrimaryToRecovery
- RecoveryToPrimary
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProtectionContainerId
Specifies the ID of a protected container. This cmdlet modifies the direction for a protected virtual machine that belongs to the container that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByPEId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProtectionEntity
Specifies the protection entity object.
Parameter properties
| Type: | ASRProtectionEntity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByPEObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProtectionEntityId
Specifies the ID of a protected virtual machine. This cmdlet modifies the direction for the protected virtual machine that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByPEId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RecoveryPlan
Specifies a recovery plan object.
Parameter properties
| Type: | ASRRecoveryPlan |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByRPObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RPId
Specifies the ID of a recovery plan. This cmdlet modifies the direction for the recovery plan that this parameter specifies.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByRPId
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WaitForCompletion
Indicates that the cmdlet waits for the operation to complete before it returns control to the Windows PowerShell console.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.