Start-AzureRmRecoveryServicesAsrCommitFailoverJob

Reference

Module:: AzureRM.RecoveryServices.SiteRecovery

Starts the commit failover action for a Site Recovery object.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Start-AzureRmRecoveryServicesAsrCommitFailoverJob
     -ReplicationProtectedItem <ASRReplicationProtectedItem>
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzureRmRecoveryServicesAsrCommitFailoverJob
     -RecoveryPlan <ASRRecoveryPlan>
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-AzureRmRecoveryServicesAsrCommitFailoverJob cmdlet starts the commit failover process for an Azure Site Recovery object after a failover operation.

Examples

Example 1

PS C:\> $currentJob = Start-AzureRmRecoveryServicesAsrCommitFailoverJob -RecoveryPlan $RP

Starts the commit failover for the specified recovery plan and returns the ASR job used to track the operation.

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:	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

ASRRecoveryPlan

Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRReplicationProtectedItem

Outputs

ASRJob