New-HoldComplianceRule

此 cmdlet 仅在安全性 & 合规性 PowerShell 中可用。 有关详细信息,请参阅 安全性 & 合规性 PowerShell

使用 New-HoldComplianceRule cmdlet 在Microsoft Purview 合规门户中创建新的保留规则。

注意:New-HoldComplianceRule cmdlet 已替换为 New-RetentionComplianceRule cmdlet。 如果有使用 New-HoldComplianceRule 的脚本,请将其更新为使用 New-RetentionComplianceRule。

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

语法

New-HoldComplianceRule
   [-Name] <String>
   -Policy <PolicyIdParameter>
   [-Comment <String>]
   [-Confirm]
   [-ContentDateFrom <DateTime>]
   [-ContentDateTo <DateTime>]
   [-ContentMatchQuery <String>]
   [-Disabled <Boolean>]
   [-HoldContent <Unlimited>]
   [-HoldDurationDisplayHint <HoldDurationHint>]
   [-WhatIf]
   [<CommonParameters>]

说明

必须使用 Policy 参数将保留规则添加到现有的保留策略中。 每个保留策略只能添加一个规则。

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

示例

示例 1

New-HoldComplianceRule -Name SeptOneYear -Policy "Internal Company Policy" -ContentDateFrom "09/10/14 5:00 PM" -ContentDateTo "09/10/15 5:00 PM" -HoldContent Unlimited

此示例创建名为“SeptOneYear”的新保留规则,并将其添加到名为“内部公司策略”的现有保留策略中。 在指定日期之间创建或更新的内容将无限期地保留。

参数

-Comment

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Confirm

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

  • 破坏性 cmdlet (例如,Remove-* cmdlet) 具有内置的暂停,该暂停会强制你在继续操作之前确认命令。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:-Confirm:$false
  • 大多数其他 cmdlet (例如,New-* 和 Set-* cmdlet) 没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。
Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ContentDateFrom

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

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

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ContentDateTo

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

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

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ContentMatchQuery

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

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Disabled

Disabled 参数指定是启用还是禁用保留规则。 此参数的有效输入为 $true 或 $false。 默认值为 $false。

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-HoldContent

HoldContent 参数指定保留规则的保留持续时间。 有效值包含:

  • 整数:保留持续时间(天)。
  • 无限制:内容无限期保留。
Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-HoldDurationDisplayHint

HoldDurationDisplayHint 参数指定用于在Microsoft Purview 合规门户中显示保留持续时间的单位。 有效值包含:

  • 年限

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

Type:HoldDurationHint
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Name

Name 参数指定保留规则的唯一名称。 如果值包含空格,则使用引号括住该值。

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-Policy

Policy 参数指定要包含该规则的策略。

Type:PolicyIdParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance