< Back
Set-AzureRmBackupProtectionPolicy
Post
NAME Set-AzureRmBackupProtectionPolicy
SYNOPSIS
Modifies an existing protection policy.
SYNTAX
Set-AzureRmBackupProtectionPolicy [-ProtectionPolicy] <AzureRMBackupProtectionPolicy> [[-NewName] <String>] [[-Daily]] [[-BackupTime] <DateTime>]
[[-RetentionPolicy] <AzureRMBackupRetentionPolicy[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Set-AzureRmBackupProtectionPolicy [-ProtectionPolicy] <AzureRMBackupProtectionPolicy> [[-NewName] <String>] [[-Weekly]] [[-BackupTime] <DateTime>]
[[-RetentionPolicy] <AzureRMBackupRetentionPolicy[]>] [[-DaysOfWeek] {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmBackupProtectionPolicy cmdlet modifies an existing protection policy in Azure Backup. You can modify the following protection
policy components:
- Name
- Backup schedule
- Retention policies
Any change might affect the backup and retention of the items associated with the policy.
PARAMETERS
-BackupTime <DateTime>
Specifies the new backup time of day, as a DateTime object, for the policy. To obtain a DateTime object, use the Get-Date cmdlet. For
information about DateTime objects, type `Get-Help Get-Date`.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Daily [<SwitchParameter>]
Indicates that the backup operation runs on a Daily schedule.
Required? false
Position? 2
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DaysOfWeek <String[]>
Specifies an array of days of the week. This policy runs backups on the days specified by this parameter. The acceptable values for this
parameter are:
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
- Sunday
Required? false
Position? 6
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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
-NewName <String>
Specifies the new name for the policy. This name must be unique in a vault.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProtectionPolicy <AzureRMBackupProtectionPolicy>
Specifies protection policy that this cmdlet modifies. To obtain an AzureRmBackupProtectionPolicy object, use the
Get-AzureRmBackupProtectionPolicy cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-RetentionPolicy <AzureRMBackupRetentionPolicy[]>
Specifies an array of retention policies for the backup policy. To obtain AzureRmBackupRetentionPolicy objects, use the
New-AzureRmBackupRetentionPolicyObject cmdlet.
Required? false
Position? 5
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Weekly [<SwitchParameter>]
Indicates that the backup operation runs on a Weekly schedule.
Required? false
Position? 3
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
AzureRmBackupProtectionPolicy
OUTPUTS
None
NOTES
1:
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tionpolicy
New-AzureRmBackupProtectionPolicy
SYNOPSIS
Modifies an existing protection policy.
SYNTAX
Set-AzureRmBackupProtectionPolicy [-ProtectionPolicy] <AzureRMBackupProtectionPolicy> [[-NewName] <String>] [[-Daily]] [[-BackupTime] <DateTime>]
[[-RetentionPolicy] <AzureRMBackupRetentionPolicy[]>] [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Set-AzureRmBackupProtectionPolicy [-ProtectionPolicy] <AzureRMBackupProtectionPolicy> [[-NewName] <String>] [[-Weekly]] [[-BackupTime] <DateTime>]
[[-RetentionPolicy] <AzureRMBackupRetentionPolicy[]>] [[-DaysOfWeek] {Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday}]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmBackupProtectionPolicy cmdlet modifies an existing protection policy in Azure Backup. You can modify the following protection
policy components:
- Name
- Backup schedule
- Retention policies
Any change might affect the backup and retention of the items associated with the policy.
PARAMETERS
-BackupTime <DateTime>
Specifies the new backup time of day, as a DateTime object, for the policy. To obtain a DateTime object, use the Get-Date cmdlet. For
information about DateTime objects, type `Get-Help Get-Date`.
Required? false
Position? 4
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Daily [<SwitchParameter>]
Indicates that the backup operation runs on a Daily schedule.
Required? false
Position? 2
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DaysOfWeek <String[]>
Specifies an array of days of the week. This policy runs backups on the days specified by this parameter. The acceptable values for this
parameter are:
- Monday
- Tuesday
- Wednesday
- Thursday
- Friday
- Saturday
- Sunday
Required? false
Position? 6
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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
-NewName <String>
Specifies the new name for the policy. This name must be unique in a vault.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ProtectionPolicy <AzureRMBackupProtectionPolicy>
Specifies protection policy that this cmdlet modifies. To obtain an AzureRmBackupProtectionPolicy object, use the
Get-AzureRmBackupProtectionPolicy cmdlet.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-RetentionPolicy <AzureRMBackupRetentionPolicy[]>
Specifies an array of retention policies for the backup policy. To obtain AzureRmBackupRetentionPolicy objects, use the
New-AzureRmBackupRetentionPolicyObject cmdlet.
Required? false
Position? 5
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Weekly [<SwitchParameter>]
Indicates that the backup operation runs on a Weekly schedule.
Required? false
Position? 3
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
AzureRmBackupProtectionPolicy
OUTPUTS
None
NOTES
1:
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tionpolicy
New-AzureRmBackupProtectionPolicy