Edit-AzDataProtectionPolicyRetentionRuleClientObject
新增或移除現有備份政策的保留規則。
語法
RemoveRetention (預設值)
Edit-AzDataProtectionPolicyRetentionRuleClientObject
-Policy <IBackupPolicy>
-Name <RetentionRuleName>
[-RemoveRule]
[<CommonParameters>]
AddRetention
Edit-AzDataProtectionPolicyRetentionRuleClientObject
-Policy <IBackupPolicy>
-Name <RetentionRuleName>
-IsDefault <Boolean>
-LifeCycles <ISourceLifeCycle[]>
[-OverwriteLifeCycle <Boolean>]
[<CommonParameters>]
Description
新增或移除現有備份政策的保留規則。
範例
範例 1：新增每週保留規則
$pol = Get-AzDataProtectionPolicyTemplate
$lifecycle = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Weeks -SourceRetentionDurationCount 5
Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Weekly -LifeCycles $lifecycle -IsDefault $false
DatasourceType ObjectType
-------------- ----------
{Microsoft.Compute/disks} BackupPolicy
第一個命令會取得預設原則範本。 第二個命令會建立每週生命週期物件。 第三個命令將每週保留規則新增至預設原則。
範例 2：移除每週保留規則
Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Weekly -RemoveRule
DatasourceType ObjectType
-------------- ----------
{Microsoft.Compute/disks} BackupPolicy
如果每週保留規則存在於指定的備份原則中，則此命令會移除該規則。
範例 3：在 AzureBlob 政策中新增 OperationalStore 保留規則
$pol = Get-AzDataProtectionPolicyTemplate -DatasourceType AzureBlob
$opLifecycle = New-AzDataProtectionRetentionLifeCycleClientObject -SourceDataStore OperationalStore -SourceRetentionDurationType Days -SourceRetentionDurationCount 30
Edit-AzDataProtectionPolicyRetentionRuleClientObject -Policy $pol -Name Default_OperationalStore -LifeCycles $opLifecycle -IsDefault $true
DatasourceType ObjectType
-------------- ----------
{Microsoft.Storage/storageAccounts/blobServices} BackupPolicy
對於 AzureBlob，OperationalStore 保留規則 必須 命名 Default_OperationalStore為 。 規則是加法式的——保單範本上的現有 Default （VaultStore）保留規則會被保留。 通過 -Name Default OperationalStore 生命週期會被驗證拒絕。
注意： -OverwriteLifeCycle 已棄用，將於即將發布的版本中移除。 設定 -OverwriteLifeCycle $false 區塊以更新現有保留規則;當 $true 或被省略時，現有規則的生命週期會被原地取代——這是移除該參數後的預設行為。
參數
-IsDefault
指定保留規則是否為預設保留規則。
參數屬性
| 類型: | Boolean |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AddRetention
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-LifeCycles
與保留規則相關聯的生命週期。
參數屬性
| 類型: | |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AddRetention
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
保留規則名稱。
注意： "Default" 保留規則無論生命週期如何，都無法移除。
參數屬性
| 類型: | RetentionRuleName |
| 預設值: | None |
| 接受的值: | Default, Daily, Weekly, Monthly, Yearly, Default_OperationalStore |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-OverwriteLifeCycle
[已棄用]選修;此參數將於即將發布的版本中移除。 設定 -OverwriteLifeCycle $false 區塊以更新現有保留規則;當 $true 或被省略時，現有規則的生命週期會被原地取代——這是移除該參數後的預設行為。
參數屬性
| 類型: | |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
AddRetention
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Policy
備份政策物件
參數屬性
| 類型: | IBackupPolicy |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-RemoveRule
指定是否要移除保留規則。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
RemoveRetention
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 cmdlet 支援常見參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
輸出
IBackupPolicy
備註
- 保留規則無論生命週期如何，都無法移除。
"Default"-RemoveRule -Name Default拋出Removing Default Retention Rule is not allowed. Please try again with different rule name. -
-OverwriteLifeCycle已被棄用，將於即將發布的版本中移除。 設定-OverwriteLifeCycle $false區塊以更新現有保留規則;當$true或被省略時，現有規則的生命週期會被原地取代——這是移除該參數後的預設行為。
