Set-AzSqlDatabaseBackupLongTermRetentionPolicy
語法
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>]
Description
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 的長期保留原則,以將一年中第 26 週進行的完整備份儲存 10 年
範例 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 的長期保留原則,以將一年中第 26 週進行的完整備份儲存 10 年。
此外,備份將使用解鎖的基於時間的不變性策略創建。
這些備份稍後可以鎖定或移除其不變性。
範例 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 的長期保留原則,以將一年中第 26 週進行的完整備份儲存 10 年。
此外,備份將使用鎖定的基於時間的不變性策略創建。
這些備份無法手動刪除,只會在到期時刪除。
範例 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 週,以及在一年的第 26 週進行的完整備份 10 年
範例 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 之前,提示您進行確認。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-DatabaseName
要使用的 Azure SQL 資料庫名稱。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 2 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-DefaultProfile
用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-MonthlyRetention
每月保留。
如果只傳遞一個數字而不是 ISO 8601 字串,則將假設天數作為單位。
最短7天,最長10年。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
MonthlyRetentionRequired
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-RemovePolicy
如果提供,則會清除資料庫的原則。
參數屬性
參數集
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 時才有效。
值可以是 Locked 或 Unlocked。
注意:如果 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 執行時會發生什麼事。
指令未執行。
參數屬性
參數集
(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。
輸出