Start-AzRecoveryServicesAsrCommitFailoverJob
Starts the commit failover action for a Site Recovery object.
Syntax
ByRPIObject (Default)
Start-AzRecoveryServicesAsrCommitFailoverJob
-ReplicationProtectedItem <ASRReplicationProtectedItem>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByRPObject
Start-AzRecoveryServicesAsrCommitFailoverJob
-RecoveryPlan <ASRRecoveryPlan>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Start-AzRecoveryServicesAsrCommitFailoverJob cmdlet starts the commit failover process for an Azure Site Recovery object after a failover operation.
Examples
Example 1
$currentJob = Start-AzRecoveryServicesAsrCommitFailoverJob -RecoveryPlan $RP
Starts the commit failover for the specified recovery plan and returns the ASR job used to track the operation.
Example 2
Starts the commit failover action for a Site Recovery object. (autogenerated)
Start-AzRecoveryServicesAsrCommitFailoverJob -ReplicationProtectedItem $ReplicationProtectedItem
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | IAzureContextContainer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RecoveryPlan
Specifies an ASR recovery plan object corresponding to recovery plan to be failovered.
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 |
-ReplicationProtectedItem
Specifies an ASR replication protected item object corresponding to replication protected item to be failovered.
Parameter properties
| Type: | ASRReplicationProtectedItem |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByRPIObject
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
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.