Start-AzRecoveryServicesAsrCancelFailoverJob
Starts the cancel failover action for a Site Recovery object.
Syntax
Start-AzRecoveryServicesAsrCancelFailoverJob
-ReplicationProtectedItem <ASRReplicationProtectedItem>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Start-AzRecoveryServicesAsrCancelFailoverJob
-RecoveryPlan <ASRRecoveryPlan>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Start-AzRecoveryServicesAsrCancelFailoverJob cmdlet starts the cancel failover process for an Azure Site Recovery object.
Examples
Example 1
$currentJob = Start-AzRecoveryServicesAsrCancelFailoverJob -RecoveryPlan $RP
Starts the cancel failover for the specified recovery plan and returns the ASR job used to track the operation.
Example 2
Starts the cancel failover action for a Site Recovery object. (autogenerated)
Start-AzRecoveryServicesAsrCancelFailoverJob -ReplicationProtectedItem $ReplicationProtectedItem
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RecoveryPlan
Specifies an ASR recovery plan object corresponding to recovery plan to be failovered.
Type: | ASRRecoveryPlan |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ReplicationProtectedItem
Specifies an ASR replication protected item object corresponding to replication protected item to be failovered.
Type: | ASRReplicationProtectedItem |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Outputs
Azure PowerShell