Set-RetentionComplianceRule

此 cmdlet 仅在安全与合规中心 PowerShell 内可用。 有关更多信息,请参见 安全与合规中心 PowerShell

使用 Set-RetentionComplianceRule cmdlet 修改Microsoft Purview 合规门户中的现有保留规则。

有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法

语法

Default (默认值)

Set-RetentionComplianceRule
    [-Identity] <ComplianceRuleIdParameter>
    [-ApplyComplianceTag <String>]
    [-Comment <String>]
    [-Confirm]
    [-ContentContainsSensitiveInformation <PswsHashtable[]>]
    [-ContentDateFrom <DateTime>]
    [-ContentDateTo <DateTime>]
    [-ContentMatchQuery <String>]
    [-ExcludedItemClasses <MultiValuedProperty>]
    [-ExpirationDateOption <String>]
    [-IRMRiskyUserProfiles <String>]
    [-PriorityCleanup]
    [-RetentionComplianceAction <String>]
    [-RetentionDuration <Unlimited>]
    [-RetentionDurationDisplayHint <HoldDurationHint>]
    [-WhatIf]
    [<CommonParameters>]

说明

要在安全与合规中心 PowerShell 中使用此 cmdlet,必须分配权限。 有关详细信息,请参阅 Microsoft Purview 合规门户中的权限

示例

示例 1

Set-RetentionComplianceRule -Identity "Internal Company Rule" -RetentionDuration 180 -RetentionDurationDisplayHint Days

此示例更改了名为“内部公司规则”的现有保留规则的保留期限。

参数

-ApplyComplianceTag

适用:安全 & 合规性

ApplyComplianceTag 参数指定按规则应用到电子邮件或文档的标签(这会影响内容的保留时间)。 此参数的有效值是现有标签的名称。 如果值包含空格,则使用引号括住该值。

通过使用 Get-ComplianceTag 和 New-ComplianceTag cmdlet 查看和创建标签。

此参数不能与 Name 或 PublishComplianceTag 参数一起使用。

不能将此参数用于 Teams 保留规则。

参数属性

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

参数集

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

-Comment

适用:安全 & 合规性

Comment 参数指定可选注释。 如果您指定包含空格的值,为该值加上双引号("),例如:"这是管理员备注"。

参数属性

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

参数集

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

-Confirm

适用:安全 & 合规性

Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。

  • 破坏性 cmdlet(例如 Remove-* cmdlets)内置有暂停,可强制要求先确认命令,然后再继续操作。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:-Confirm:$false
  • 其他大多数 cmdlet(例如 New-* 和 Set-* cmdlet)都没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。

参数属性

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

参数集

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

-ContentContainsSensitiveInformation

适用:安全 & 合规性

ContentContainsSensitiveInformation 参数指定基于内容中敏感信息类型匹配的规则的条件。 该规则会应用于包含指定的敏感信息类型的内容。

此参数使用基本语法 @(@{Name="SensitiveInformationType1";[minCount="Value"],@{Name="SensitiveInformationType2";[minCount="Value"],...)。 例如,@(@{Name="U.S. Social Security Number (SSN)"; minCount="2"},@{Name="Credit Card Number"})

使用 Get-DLPSensitiveInformationType cmdlet 可以列出组织的敏感信息类型。 有关敏感信息类型的详细信息,请参阅 Exchange 中的敏感信息类型查找的内容

不能将此参数用于 Teams 保留规则。

参数属性

类型:

PswsHashtable[]

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

参数集

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

-ContentDateFrom

适用:安全 & 合规性

ContentDateFrom 参数指定要包含内容的日期范围的开始日期。

请使用短日期格式,该格式在运行命令的计算机上的“区域选项”设置中定义。 例如,如果计算机配置为使用短日期格式 MM/dd/yyyy,请输入 09/01/2018 以指定 2018 年 9 月 1 日。 可以只输入日期,也可以输入当天的日期和时间。 如果输入当天的日期和时间,请将该值括在引号 (") 中,例如,"09/01/2018 5:00 PM"。

参数属性

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

参数集

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

-ContentDateTo

适用:安全 & 合规性

ContentDateTo 参数指定要包含内容的日期范围的结束日期。

请使用短日期格式,该格式在运行命令的计算机上的“区域选项”设置中定义。 例如,如果计算机配置为使用短日期格式 MM/dd/yyyy,请输入 09/01/2018 以指定 2018 年 9 月 1 日。 可以只输入日期,也可以输入当天的日期和时间。 如果输入当天的日期和时间,请将该值括在引号 (") 中,例如,"09/01/2018 5:00 PM"。

参数属性

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

参数集

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

-ContentMatchQuery

适用:安全 & 合规性

ContentMatchQuery 参数指定内容搜索筛选器。

此参数使用通过关键字查询语言 (KQL) 设置格式的文本搜索字符串或查询。 有关详细信息,请参阅 关键字查询语言 (KQL) 语法参考电子数据展示的关键字查询和搜索条件

不能将此参数用于 Teams 保留规则。

参数属性

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

参数集

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

-ExcludedItemClasses

适用:安全 & 合规性

ExcludedItemClasses 参数指定要从规则中排除的消息类型。 此参数只能用于从保留策略中排除项,这将排除指定的项类的保留。 此参数不会从删除策略中排除项。 通常,使用此参数可以排除保留策略保留语音邮件、即时消息和其他Skype for Business Online 内容。 常见Skype for Business值包括:

  • IPM。Note.Microsoft.Conversation
  • IPM。Note.Microsoft.Conversation.Voice
  • IPM。Note.Microsoft.Missed
  • IPM。Note.Microsoft.Missed.Voice
  • IPM。Note.Microsoft.Voicemail
  • IPM.Note.Microsoft.VoiceMessage.UA
  • IPM。Note.Microsoft.Voicemail.UM
  • IPM.Note.Microsoft.Voicemail.UM.CA

此外,还可以 为 Exchange 项目指定邮件类 以及自定义邮件类或非Microsoft邮件类。 指定的值不会验证,因此参数接受任何文本值。

可以使用以下语法指定多个项类值: "Value1","Value2",..."ValueN"

不能将此参数用于 Teams 保留规则。

参数属性

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

参数集

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

-ExpirationDateOption

适用:安全 & 合规性

ExpirationDateOption 参数指定是从内容创建日期还是上次修改日期计算到期日期。 有效值包含:

  • CreationAgeInDays
  • ModificationAgeInDays

不能将此参数用于 Teams 保留规则。

参数属性

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

参数集

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

-Identity

适用:安全 & 合规性

Identity 参数指定要修改的保留规则。 可以使用唯一标识该规则的任何值。 例如:

  • 名称
  • 可分辨名称 (DN)
  • GUID

参数属性

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

参数集

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

-IRMRiskyUserProfiles

适用:安全 & 合规性

{{ Fill IRMRiskyUserProfiles Description }}

参数属性

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

参数集

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

-PriorityCleanup

适用:安全 & 合规性

PriorityCleanup 开关指定是否更新与优先级清理策略关联的规则。 不必为此开关指定值。

优先级清理策略通过重写任何现有保留设置或电子数据展示保留来加速敏感内容的删除。 有关详细信息,请参阅 优先级清理

参数属性

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

参数集

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

-RetentionComplianceAction

适用:安全 & 合规性

RetentionComplianceAction 参数指定规则的保留作。 有效值包含:

  • 删除
  • 保留
  • KeepAndDelete

参数属性

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

参数集

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

-RetentionDuration

适用:安全 & 合规性

RetentionDuration 参数指定保留规则的保留期限。 有效值包含:

  • 整数:保留持续时间(天)。
  • 无限制:内容无限期保留。

参数属性

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

参数集

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

-RetentionDurationDisplayHint

适用:安全 & 合规性

RetentionDurationDisplayHint 参数指定用于在Microsoft Purview 合规门户中显示保留持续时间的单位。 有效值为 Days、Months 或 Years。

  • 年限

例如,如果将此参数设置为值 Years,并将 RetentionDuration 参数设置为值 365,则Microsoft Purview 合规门户显示 1 年作为内容保留持续时间。

不能将此参数用于 Teams 保留规则。

参数属性

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

参数集

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

-WhatIf

适用:安全 & 合规性

WhatIf 开关在安全与合规 PowerShell 中不起作用。

参数属性

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

参数集

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

CommonParameters

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