Edit-AzDataProtectionPolicyRetentionRuleClientObject
向现有策略添加或删除保留规则
语法
RemoveRetention (默认值)
Edit-AzDataProtectionPolicyRetentionRuleClientObject
-Name <RetentionRuleName>
-Policy <IBackupPolicy>
-RemoveRule
[<CommonParameters>]
AddRetention
Edit-AzDataProtectionPolicyRetentionRuleClientObject
-IsDefault <Boolean>
-LifeCycles <ISourceLifeCycle[]>
-Name <RetentionRuleName>
-Policy <IBackupPolicy>
[-OverwriteLifeCycle <Boolean?>]
[<CommonParameters>]
说明
向现有策略添加或删除保留规则
示例
示例 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
与保留规则关联的生命周期。 若要构造，请参阅 LIFECYCLES 属性的 NOTES 部分并创建哈希表。
参数属性
| 类型: | Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20260301.ISourceLifeCycle[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
AddRetention
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Name
保留规则名称
参数属性
| 类型: | RetentionRuleName |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-OverwriteLifeCycle
指定是否修改现有的 LifeCycle。
参数属性
| 类型: | Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
AddRetention
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Policy
要构造的备份策略对象，请参阅 POLICY 属性的 NOTES 部分，并创建哈希表。
参数属性
| 类型: | Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api20260301.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。