Start-AzRecoveryServicesAsrTestFailoverCleanupJob

Reference

Module:: Az.RecoveryServices

Starts the test failover cleanup operation.

Note

This is the previous version of our documentation. Please consult the most recent version for up-to-date information.

Syntax

Start-AzRecoveryServicesAsrTestFailoverCleanupJob
     -ReplicationProtectedItem <ASRReplicationProtectedItem>
     [-Comment <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzRecoveryServicesAsrTestFailoverCleanupJob
     -ResourceId <String>
     [-Comment <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-AzRecoveryServicesAsrTestFailoverCleanupJob
     -RecoveryPlan <ASRRecoveryPlan>
     [-Comment <String>]
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-AzRecoveryServicesAsrTestFailoverCleanupJob cmdlet starts the test failover cleanup operation on a replication protected item or recovery plan on which a test failover has been performed.

Examples

Example 1

Job to track test failover Cleanup of an Azure Site Recovery recoveryPlan.

Start-AzRecoveryServicesAsrTestFailoverCleanupJob -RecoveryPlan $recoveryPlan -Comment "testing done"

Example 2

Starts the test failover cleanup operation. (autogenerated)

Start-AzRecoveryServicesAsrTestFailoverCleanupJob -Comment 'testing done' -ReplicationProtectedItem $rpi

Parameters

-Comment

User Comment for Test Failover.

Type:	String
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-RecoveryPlan

Recovery Plan to perform the test failover cleanup on.

Type:	ASRRecoveryPlan
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ReplicationProtectedItem

Replication Protected Item to perform the test failover cleanup on.

Type:	ASRReplicationProtectedItem
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

Resource Id of replication protected item / recovery plan for cleaningup test failover.

Type:	String
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

ASRRecoveryPlan

ASRReplicationProtectedItem

Outputs

ASRJob