< Back

Disable-AzureRmRecoveryServicesBackupProtection

Tue Jan 29, 2019 10:00 pm

NAME Disable-AzureRmRecoveryServicesBackupProtection



SYNOPSIS

Disables protection for a Backup-protected item.





SYNTAX

Disable-AzureRmRecoveryServicesBackupProtection [-Item] <ItemBase> [[-RemoveRecoveryPoints]] [-DefaultProfile <IAzureContextContainer>] [-Force]

[-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Disable-AzureRmRecoveryServicesBackupProtection cmdlet disables protection for an Azure Backup-protected item. This cmdlet stops regular

scheduled backup of an item. This cmdlet can also delete existing recovery points for the backup item.



Set the vault context by using the Set-AzureRmRecoveryServicesVaultContext cmdlet before you use the current cmdlet.





PARAMETERS

-DefaultProfile <IAzureContextContainer>

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



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Item <ItemBase>

Specifies the Backup item for which this cmdlet disables protection. To obtain an AzureRmRecoveryServicesBackupItem , use the

Get-AzureRmRecoveryServicesBackupItem cmdlet.



Required? true

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-RemoveRecoveryPoints [<SwitchParameter>]

Indicates that this cmdlet deletes existing recovery points. To delete stored recovery points later, run this cmdlet again and specify this

parameter.



Required? false

Position? 2

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

ItemBase

Parameter 'Item' accepts value of type 'ItemBase' from the pipeline





OUTPUTS

Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets.Models.JobBase







NOTES









Example 1: Disable Backup protection



PS C:\\> $Cont = Get-AzureRmRecoveryServicesBackupContainer -ContainerType AzureVM -Status Registered

PS C:\\> $PI = Get-AzureRmRecoveryServicesBackupItem -Container $Cont[0] -WorkloadType AzureVM

PS C:\\> Disable-AzureRmRecoveryServicesBackupProtection -Item $PI[0]



The first command gets an array of backup containers, and then stores it in the $Cont array.



The second command gets the Backup item corresponding to the first container item, and then stores it in the $PI variable.



The last command disables Backup protection for the item in $PI[0], but retains the data.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... protection

Enable-AzureRmRecoveryServicesBackupProtection

Get-AzureRmRecoveryServicesBackupContainer

Get-AzureRmRecoveryServicesBackupItem