共用方式為

Edit-AzDataProtectionPolicyRetentionRuleClientObject

模組:
Az.DataProtection Module

將保留規則新增至現有原則

語法

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

如果每週保留規則存在於指定的備份原則中，則此命令會移除該規則。

參數

-IsDefault

指定保留規則是否為預設保留規則。

參數屬性

類型:Boolean
預設值:None
支援萬用字元:False
不要顯示:False

參數集

AddRetention
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-LifeCycles

與保留規則相關聯的生命週期。 若要建構，請參閱 NOTES 區段，以取得 LIFECYCLES 內容並建立雜湊表。

參數屬性

類型:

ISourceLifeCycle[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

AddRetention
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Name

保留規則名稱

參數屬性

類型:RetentionRuleName
預設值:None
接受的值:Default, Daily, Weekly, Monthly, Yearly
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-OverwriteLifeCycle

指定是否要修改現有的生命週期。

參數屬性

類型:

Nullable<T>[Boolean]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

AddRetention
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Policy

備份原則物件若要建構，請參閱 NOTES 區段以取得 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