Set-AzSqlDatabaseBackupLongTermRetentionPolicy
Sets a server long term retention policy.
Syntax
WeeklyRetentionRequired (Default)
Set-AzSqlDatabaseBackupLongTermRetentionPolicy
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
-WeeklyRetention <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RemovePolicy
Set-AzSqlDatabaseBackupLongTermRetentionPolicy
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-RemovePolicy]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
MonthlyRetentionRequired
Set-AzSqlDatabaseBackupLongTermRetentionPolicy
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
-MonthlyRetention <String>
[-WeeklyRetention <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
YearlyRetentionRequired
Set-AzSqlDatabaseBackupLongTermRetentionPolicy
[-ServerName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
-YearlyRetention <String>
-WeekOfYear <Int32>
[-WeeklyRetention <String>]
[-MonthlyRetention <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzSqlDatabaseBackupLongTermRetentionPolicy cmdlet sets the long term retention policy registered to this database.
The policy is an Azure Backup resource used to define backup storage policy.
Examples
Example 1: Set the weekly retention for the current version of long term retention policy
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P2W
ResourceGroupName : resourcegroup01
ServerName : server01
DatabaseName : database01
WeeklyRetention : P2W
MonthlyRetention : PT0S
YearlyRetention : PT0S
WeekOfYear : 0
Location :
This sets the long term retention policy of database01 to save every weekly full backup for 2 weeks
Example 2: Set the monthly retention for the current version of long term retention policy
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -MonthlyRetention P5Y
ResourceGroupName : resourcegroup01
ServerName : server01
DatabaseName : database01
WeeklyRetention : PT0S
MonthlyRetention : P5Y
YearlyRetention : PT0S
WeekOfYear : 0
Location :
This sets the long term retention policy of database01 to save the first full backup of each month for 5 years
Example 3: Set the yearly retention for the current version of long term retention policy
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26
ResourceGroupName : resourcegroup01
ServerName : server01
DatabaseName : database01
WeeklyRetention : PT0S
MonthlyRetention : PT0S
YearlyRetention : P10Y
WeekOfYear : 26
Location :
This sets the long term retention policy of database01 to save the full backup taken on the 26th week of the year for 10 years
Example 4: Set each retention for the current version of long term retention policy
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention 14 -MonthlyRetention P24W -YearlyRetention P10Y -WeekOfYear 26
ResourceGroupName : resourcegroup01
ServerName : server01
DatabaseName : database01
WeeklyRetention : P14D
MonthlyRetention : P24W
YearlyRetention : P10Y
WeekOfYear : 26
Location :
This sets the long term retention policy of database01 to save each full backup for 14 days, the first full backup of each month for 24 weeks, and the full backup taken on the 26th week of the year for 10 years
Example 5: Remove the long term retention policy
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -RemovePolicy
ResourceGroupName : resourcegroup01
ServerName : server01
DatabaseName : database01
WeeklyRetention : PT0S
MonthlyRetention : PT0S
YearlyRetention : PT0S
WeekOfYear : 0
Location :
Removes the policy for database01 so it no longer saves any long term retention backups.
This will not affect backups that have already been taken
Example 6: Remove the long term retention policy
Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -WeeklyRetention P0D
ResourceGroupName : resourcegroup01
ServerName : server01
DatabaseName : database01
WeeklyRetention : PT0S
MonthlyRetention : PT0S
YearlyRetention : PT0S
WeekOfYear : 0
Location :
This is another way of removing the policy for database01 so it no longer saves any long term retention backups.
This will not affect backups that have already been taken
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DatabaseName
The name of the Azure SQL Database to use.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 2 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MonthlyRetention
The Monthly Retention.
If just a number is passed instead of an ISO 8601 string, days will be assumed as the units.
There is a minimum of 7 days and a maximum of 10 years.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
MonthlyRetentionRequired
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-RemovePolicy
If provided, the policy for the database will be removed.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
RemovePolicy
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-ServerName
The name of the Azure SQL Server the database is in.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WeeklyRetention
The Weekly Retention.
If just a number is passed instead of an ISO 8601 string, days will be assumed as the units.
There is a minimum of 7 days and a maximum of 10 years.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
WeeklyRetentionRequired
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WeekOfYear
The Week of Year, 1 to 52, to save for the Yearly Retention.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
YearlyRetentionRequired
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: False Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-YearlyRetention
The Yearly Retention.
If just a number is passed instead of an ISO 8601 string, days will be assumed as the units.
There is a minimum of 7 days and a maximum of 10 years.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
YearlyRetentionRequired
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs