Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy
The Set-AzSqlInstanceDatabaseLongTermRetentionBackup cmdlet sets a managed database's long term retention policy.
Syntax
WeeklyRetentionRequired (Default)
Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy
[-InstanceName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
-WeeklyRetention <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
RemovePolicy
Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy
[-InstanceName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
[-RemovePolicy]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
MonthlyRetentionRequired
Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy
[-InstanceName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
-MonthlyRetention <String>
[-WeeklyRetention <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
YearlyRetentionRequired
Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy
[-InstanceName] <String>
[-DatabaseName] <String>
[-ResourceGroupName] <String>
-YearlyRetention <String>
-WeekOfYear <Int32>
[-WeeklyRetention <String>]
[-MonthlyRetention <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy cmdlet sets the long term retention policy for this managed database.
Examples
Example 1
Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy -ResourceGroupName testResourceGroup -InstanceName testInstance -DatabaseName test -WeeklyRetention "P1W"
ResourceGroupName : testResourceGroup
ManagedInstanceName : testInstance
DatabaseName : test
WeeklyRetention : P1W
MonthlyRetention : PT0S
YearlyRetention : PT0S
WeekOfYear : 0
Location :
Configures the database's long term retention weekly policy to one week.
Example 2
Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy -ResourceGroupName testResourceGroup -InstanceName testInstance -DatabaseName target1 -RemovePolicy
ResourceGroupName : testResourceGroup
ManagedInstanceName : testInstance
DatabaseName : target1
WeeklyRetention : PT0S
MonthlyRetention : PT0S
YearlyRetention : PT0S
WeekOfYear : 0
Location :
This command removes the long term retention policy from the database.
Example 3
The Set-AzSqlInstanceDatabaseLongTermRetentionBackup cmdlet sets a managed database's long term retention policy. (autogenerated)
Set-AzSqlInstanceDatabaseBackupLongTermRetentionPolicy -DatabaseName target1 -InstanceName testInstance -MonthlyRetention P24W -ResourceGroupName testResourceGroup -WeekOfYear 26 -WeeklyRetention 'P1W' -YearlyRetention P10Y
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None
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 Managed 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
-InstanceName
The name of the Azure Managed Instance the database belongs to.
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
-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 cleared.
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
-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: None
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