你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Set-AzSqlDatabaseBackupLongTermRetentionPolicy

模块:: Az.Sql Module

设置服务器长期保留策略。

语法

WeeklyRetentionRequired (默认值)

Set-AzSqlDatabaseBackupLongTermRetentionPolicy
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    -WeeklyRetention <String>
    [-TimeBasedImmutability <String>]
    [-TimeBasedImmutabilityMode <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

RemovePolicy

Set-AzSqlDatabaseBackupLongTermRetentionPolicy
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    [-RemovePolicy]
    [-TimeBasedImmutability <String>]
    [-TimeBasedImmutabilityMode <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

MonthlyRetentionRequired

Set-AzSqlDatabaseBackupLongTermRetentionPolicy
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    -MonthlyRetention <String>
    [-WeeklyRetention <String>]
    [-TimeBasedImmutability <String>]
    [-TimeBasedImmutabilityMode <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

YearlyRetentionRequired

Set-AzSqlDatabaseBackupLongTermRetentionPolicy
    [-ServerName] <String>
    [-DatabaseName] <String>
    [-ResourceGroupName] <String>
    -YearlyRetention <String>
    -WeekOfYear <Int32>
    [-WeeklyRetention <String>]
    [-MonthlyRetention <String>]
    [-TimeBasedImmutability <String>]
    [-TimeBasedImmutabilityMode <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

Set-AzSqlDatabaseBackupLongTermRetentionPolicy cmdlet 设置注册到此数据库的长期保留策略。该策略是用于定义备份存储策略的 Azure 备份资源。

示例

示例 1：为当前版本的长期保留策略设置每周保留期

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                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

这将设置 database01 的长期保留策略，以便将每周完整备份保存 2 周

示例 2：为当前版本的长期保留策略设置每月保留期

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                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

这将设置 database01 的长期保留策略，以便将每月的第一个完整备份保存到 5 年

示例 3：为当前版本的长期保留策略设置每年保留期

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                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

这将设置 database01 的长期保留策略，以保存 10 年来在年度第 26 周执行的完整备份

示例 4：为启用了解锁的基于时间的不可变性设置当前版本的长期保留策略的年度保留期

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26 -TimeBasedImmutability Enabled

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : P10Y
WeekOfYear                             : 26
Location                               :
TimeBasedImmutability                  : Enabled
TimeBasedImmutabilityMode              : Unlocked

这将设置 database01 的长期保留策略，以保存 10 年来在年度第 26 周执行的完整备份。此外，将使用解锁的基于时间的不可变性策略创建备份。这些备份稍后可以锁定或删除其不可变性。

示例 5：为启用了锁定的基于时间的不可变性设置当前版本的长期保留策略的年度保留期

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -YearlyRetention P10Y -WeekOfYear 26 -TimeBasedImmutability Enabled -TimeBasedImmutabilityMode Locked

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : P10Y
WeekOfYear                             : 26
Location                               :
TimeBasedImmutability                  : Enabled
TimeBasedImmutabilityMode              : Locked

这将设置 database01 的长期保留策略，以保存 10 年来在年度第 26 周执行的完整备份。此外，将使用锁定的基于时间的不可变性策略创建备份。无法手动删除这些备份，只能在过期时删除。

示例 6：为当前版本的长期保留策略设置每个保留期

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                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

这将设置 database01 的长期保留策略，以便将每个完整备份保存 14 天，每月第一次完整备份 24 周，以及 10 年来第 26 周执行的完整备份

示例 7：删除长期保留策略

Set-AzSqlDatabaseBackupLongTermRetentionPolicy -ResourceGroupName resourcegroup01 -ServerName server01 -DatabaseName database01 -RemovePolicy

ResourceGroupName                      : resourcegroup01
ServerName                             : server01
DatabaseName                           : database01
WeeklyRetention                        : PT0S
MonthlyRetention                       : PT0S
YearlyRetention                        : PT0S
WeekOfYear                             : 0
Location                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

删除 database01 的策略，使其不再保存任何长期保留备份。这不会影响已创建的备份。

示例 8：删除长期保留策略

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                               :
TimeBasedImmutability                  : Disabled
TimeBasedImmutabilityMode              : Unlocked

这是删除 database01 策略的另一种方法，因此它不再保存任何长期保留备份。这不会影响已创建的备份

参数

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	cf

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DatabaseName

要使用的 Azure SQL 数据库的名称。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	2
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:	IAzureContextContainer
默认值:	None
支持通配符:	False
不显示:	False
别名:	AzContext, AzureRmContext, AzureCredential

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-MonthlyRetention

每月保留期。如果只传递数字而不是 ISO 8601 字符串，则天数将假定为单位。至少有 7 天，最多 10 年。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

MonthlyRetentionRequired

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-RemovePolicy

如果提供，将清除数据库的策略。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

RemovePolicy

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ResourceGroupName

资源组的名称。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-ServerName

数据库位于的 Azure SQL Server 的名称。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	1
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-TimeBasedImmutability

设置后，将来的备份将启用 TimeBasedImmutableability。

参数属性

类型:	String
默认值:	None
接受的值:	Enabled, Disabled
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-TimeBasedImmutabilityMode

用于将来备份的基于时间的不可变性模式的设置。仅当启用了 TimeBasedImmutability 时有效。值可以锁定或解锁。注意：如果 TimeBasedImmutabilityMode 为 Locked，则无法删除 LTR 备份的不变性。

参数属性

类型:	String
默认值:	None
接受的值:	Unlocked, Locked
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-WeeklyRetention

每周保留期。如果只传递数字而不是 ISO 8601 字符串，则天数将假定为单位。至少有 7 天，最多 10 年。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

WeeklyRetentionRequired

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-WeekOfYear

年份周，1 到 52，用于保存每年保留期。

参数属性

类型:	Int32
默认值:	None
支持通配符:	False
不显示:	False

参数集

YearlyRetentionRequired

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。命令脚本未运行。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	无线

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-YearlyRetention

每年保留期。如果只传递数字而不是 ISO 8601 字符串，则天数将假定为单位。至少有 7 天，最多 10 年。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

YearlyRetentionRequired

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。有关详细信息，请参阅 about_CommonParameters。

通过

Set-AzSqlDatabaseBackupLongTermRetentionPolicy

语法

WeeklyRetentionRequired (默认值)

RemovePolicy

MonthlyRetentionRequired

YearlyRetentionRequired

说明

示例

示例 1：为当前版本的长期保留策略设置每周保留期

示例 2：为当前版本的长期保留策略设置每月保留期

示例 3：为当前版本的长期保留策略设置每年保留期

示例 4：为启用了解锁的基于时间的不可变性设置当前版本的长期保留策略的年度保留期

示例 5：为启用了锁定的基于时间的不可变性设置当前版本的长期保留策略的年度保留期

示例 6：为当前版本的长期保留策略设置每个保留期

示例 7：删除长期保留策略

示例 8：删除长期保留策略

参数

-Confirm

参数属性

参数集

-DatabaseName

参数属性

参数集

-DefaultProfile

参数属性

参数集

-MonthlyRetention

参数属性

参数集

-RemovePolicy

参数属性

参数集

-ResourceGroupName

参数属性

参数集

-ServerName

参数属性

参数集

-TimeBasedImmutability

参数属性

参数集

-TimeBasedImmutabilityMode

参数属性

参数集

-WeeklyRetention

参数属性

参数集

-WeekOfYear

参数属性

参数集

-WhatIf

参数属性

参数集

-YearlyRetention

参数属性

参数集

CommonParameters

输入

String

Int32

输出

AzureSqlDatabaseBackupLongTermRetentionPolicyModel

相关链接

反馈