New-CaseHoldRule

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

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

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

语法

New-CaseHoldRule
   [-Name] <String>
   -Policy <PolicyIdParameter>
   [-Comment <String>]
   [-Confirm]
   [-ContentMatchQuery <String>]
   [-Disabled <Boolean>]
   [-WhatIf]
   [<CommonParameters>]

说明

你需要使用 Policy 参数将此事例保留规则添加到现有事例保留策略。 每个事例保留策略只能添加一个规则。

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

示例

示例 1

New-CaseHoldRule -Name "2016 Budget Spreadsheets" -Policy "Internal Company Policy" -ContentMatchQuery "filename:2016 budget filetype:xlsx"

此示例创建名为“2016 预算电子表格”的新事例保留规则,并将其添加到名为“内部公司策略”的现有事例保留策略。 该规则适用于包含短语 2016 预算的 Excel 工作表,例如“2016 预算planning.xlsx”和“2016 预算review.xlsx”

示例 2

New-CaseHoldRule -Name "Contoso Case 07172018 Hold 1" -Policy "Contoso Case 07172018" -ContentMatchQuery "received:12/01/2017..12/31/2018"

本示例将 2018 年 12 月 1 日至 2018 年 12 月 31 日期间收件人收到的电子邮件置于保留状态。

参数

-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

-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:已启用规则。 此值为默认值。
Type:Boolean
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 参数指定包含规则的保留策略。 可以使用任何能够唯一标识该策略的值。 例如:

  • 名称
  • 可分辨名称 (DN)
  • GUID
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