Skip to content

Latest commit

 

History

History
138 lines (100 loc) · 3.5 KB

Remove-AzureRmRecoveryServicesAsrRecoveryPlan.md

File metadata and controls

138 lines (100 loc) · 3.5 KB
external help file Module Name online version schema
Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.dll-Help.xml
AzureRM.RecoveryServices.SiteRecovery
2.0.0

Remove-AzureRmRecoveryServicesAsrRecoveryPlan

SYNOPSIS

Deletes the specified ASR recovery plan from Recovery Services vault.

SYNTAX

ByObject (Default)

Remove-AzureRmRecoveryServicesAsrRecoveryPlan -InputObject <ASRRecoveryPlan>
 [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]

ByName

Remove-AzureRmRecoveryServicesAsrRecoveryPlan -Name <String> [-DefaultProfile <IAzureContextContainer>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-AzureRmRecoveryServicesAsrRecoveryPlan cmdlet deletes the specified recovery plan from the Recovery Services vault.

EXAMPLES

Example 1

PS C:\> $currentJob = Remove-AzureRmRecoveryServicesAsrRecoveryPlan -RecoveryPlan $RP

Starts the deletion of specified recovery plan and returns the ASR job used to track the operation.

PARAMETERS

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzureRmContext, AzureCredential

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

-InputObject

The input object to the cmdlet: The ASR recovery plan object corresponding to the recovery plan to be deleted.

Type: Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan
Parameter Sets: ByObject
Aliases: RecoveryPlan

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the recovery plan to be deleted.

Type: System.String
Parameter Sets: ByName
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.Azure.Commands.RecoveryServices.SiteRecovery.ASRRecoveryPlan

OUTPUTS

System.Object

NOTES

RELATED LINKS

Get-AzureRmRecoveryServicesAsrRecoveryPlan

New-AzureRmRecoveryServicesAsrRecoveryPlan

Update-AzureRmRecoveryServicesAsrRecoveryPlan