New-ComplianceSearch
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。
使用 New-ComplianceSearch cmdlet 在 Exchange Server 2016 或更高版本和 Microsoft Purview 合规门户 中创建合规性搜索。 您可以使用此 cmdlet 定义搜索条件。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
New-ComplianceSearch
[-Name] <String>
[-AllowNotFoundExchangeLocationsEnabled <Boolean>]
[-Case <String>]
[-Confirm]
[-ContentMatchQuery <String>]
[-Description <String>]
[-ExchangeLocation <String[]>]
[-ExchangeLocationExclusion <String[]>]
[-Force]
[-HoldNames <String[]>]
[-IncludeOrgContent <Boolean>]
[-IncludeUserAppContent <Boolean>]
[-Language <CultureInfo>]
[-LogLevel <ComplianceJobLogLevel>]
[-PublicFolderLocation <String[]>]
[-RefinerNames <String[]>]
[-SharePointLocation <String[]>]
[-SharePointLocationExclusion <String[]>]
[-StatusMailRecipients <String[]>]
[-WhatIf]
[<CommonParameters>]
说明
合规性搜索至少需要一个位置。 例如,使用 ExchangeLocation 参数的邮箱,或使用 SharePointLocation 参数的 SharePoint 网站。
在使用 New-ComplianceSearch cmdlet 创建了合规性搜索之后,可以使用 Start-ComplianceSearch cmdlet 运行搜索。
您必须先获得权限,然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数,但如果这些参数并未包含在分配给您的权限中,那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
在本地 Exchange 中,此 cmdlet 在邮箱搜索角色中可用。 默认情况下,此角色仅分配给发现管理角色组。
若要在安全性 & 合规性 PowerShell 中使用此 cmdlet,需要分配权限。 有关详细信息,请参阅 Microsoft Purview 合规门户中的权限。
示例
示例 1
New-ComplianceSearch -Name "Hold Project X" -ExchangeLocation "Finance Department"
本示例创建一个名为“Hold-Project X”的新合规性搜索,用来搜索名为“财务部门”的通讯组中的所有成员。 由于搜索不使用 ContentMatchQuery 参数,因此,将搜索邮箱中的所有项目。
示例 2
New-ComplianceSearch -Name "Hold-Tailspin Toys" -ExchangeLocation "Research Department" -ContentMatchQuery "'Patent' AND 'Project Tailspin Toys'"
本示例创建一个名为“Hold-Tailspin Toys”的新合规性搜索,用来搜索名为“研究部门”的通讯组中的所有成员。 由于搜索使用 ContentMatchQuery 参数,因此,仅搜索匹配查询的邮件。
示例 3
New-ComplianceSearch -Name "AnnBeebe-InactiveMailbox" -ExchangeLocation .annb@contoso.onmicrosoft.com -AllowNotFoundExchangeLocationsEnabled $true
本示例创建一个名为 AnnBeebe-InactiveMailbox 的新合规性搜索,它在处于非活动状态的邮箱中搜索并返回邮箱中的所有项。 若要搜索处于非活动状态的邮箱,您需要使用非活动邮箱的主 SMTP 地址,前面加上句点 (.)。 还需要包含 AllowNotFoundExchangeLocationsEnabled 参数,以便搜索不会尝试验证是否存在非活动邮箱。
参数
-AllowNotFoundExchangeLocationsEnabled
AllowNotFoundExchangeLocationsEnabled 参数指定是否在合规性搜索中包含常规用户邮箱以外的邮箱。 有效值包含:
- $true:在继续之前,搜索不会尝试验证邮箱是否存在。 如果要搜索未解析为常规邮箱的邮箱,则需要此值。
- $false:在继续之前,搜索会尝试验证邮箱是否存在。 如果指定不是常规用户邮箱的邮箱,搜索将失败。 此值为默认值。
受此参数值影响的邮箱类型包括:
- 非活动邮箱
- 没有Exchange Online许可证的用户使用 Office 应用程序
- Microsoft 365 个来宾用户
- 标识与 Microsoft 365 组织同步的本地用户
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Case
此参数仅在基于云的服务中可用。
Case 参数指定要与新符合性搜索关联的电子数据展示标准事例的名称。 如果值包含空格,则使用引号括住该值。
不能使用此参数创建与电子数据展示高级案例关联的合规性搜索。
如果 Name 参数包含空格,则使用 Case 参数时,将清除 ExchangeLocation 参数的值。
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: | Exchange Server 2016, Exchange Server 2019, 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: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Description
Description 参数指定合规性搜索的可选说明。 如果值包含空格,则使用引号括住该值。
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-ExchangeLocation
ExchangeLocation 参数指定要包含的邮箱。 有效值包含:
- 常规用户邮箱。 包括其他类型的邮箱 (例如,非活动邮箱或Microsoft 365 来宾用户) 由 AllowNotFoundExchangeLocationsEnabled 参数控制。
- 邮箱
- 所有邮箱的值 All。 您只能自行使用此值。
若要指定邮箱或通讯组,请使用电子邮件地址。 可以指定用逗号分隔的多个值。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-ExchangeLocationExclusion
此参数仅在本地 Exchange 中有效。
此参数指定要在 ExchangeLocation 参数使用值 All 时排除的邮箱。 有效值包含:
- ExchangeLocation 参数指定了要添加到策略中的邮箱。有效值为:
- 邮箱
若要指定邮箱或通讯组,请使用电子邮件地址。 可以指定用逗号分隔的多个值。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Force
强制开关隐藏警告或确认消息。 不必为此开关指定值。
您可以在以编程方式运行任务时使用此开关,因为此时并不适合提示用户提供管理输入。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-HoldNames
此参数仅在基于云的服务中可用。
HoldNames 参数指定将搜索指定的电子数据展示服务案例中已置于保留状态的内容位置。 可以对此参数使用值 All。 还需要使用 Case 参数指定电子数据展示服务案例的名称。
此外,如果内容位置置于基于查询的服务案例的保留状态,则在运行此合规性搜索时,只会搜索处于保留状态的项目。 例如,如果将用户置于基于查询的服务案例的保留状态,且可保留在特定日期之前发送或创建的项目,则通过使用此合规性搜索指定的搜索条件,可仅对这些项目进行搜索。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-IncludeOrgContent
{{ Fill IncludeOrgContent Description }}
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-IncludeUserAppContent
此参数仅在基于云的服务中可用。
IncludeUserAppContent 参数指定要搜索组织中没有常规Microsoft 365 用户帐户的用户的基于云的存储位置。 这些类型的用户包括使用 Office 应用程序的无Exchange Online许可证的用户、Microsoft 365 个来宾用户,以及标识与 Microsoft 365 组织同步的本地用户。 有效值包含:
- $true:搜索中将包括 ExchangeLocation 参数中指定的用户的基于云的存储位置。 如果将值 All 用于 ExchangeLocation 参数,则搜索中将包括任何来宾或本地用户的基于云的存储位置。
- $false:搜索中不包括 ExchangeLocation 参数中指定的用户的基于云的存储位置。 此值为默认值。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-Language
Language 参数指定合规性搜索的语言。
此参数的有效输入是 Microsoft .NET Framework CultureInfo 类支持的区域性代码值。 例如,da-DK 表示丹麦语,ja-JP 表示日语。 有关详细信息,请参阅 CultureInfo 类。
Type: | CultureInfo |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-LogLevel
此参数只在本地 Exchange 中可用。
保留此参数以供 Microsoft 内部使用。
Type: | ComplianceJobLogLevel |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Name
Name 参数指定符合性搜索的名称。 如果值包含空格,则使用引号括住该值。
如果计划使用 Case 参数,请不要在此参数的值中使用空格。 如果 Name 参数包含空格,则使用 Case 参数时,将清除 ExchangeLocation 参数的值。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-PublicFolderLocation
此参数仅在基于云的服务中可用。
PublicFolderLocation 参数指定要在搜索中包括所有公用文件夹。 可以对此参数使用值 All。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-RefinerNames
此参数仅在基于云的服务中可用。
保留此参数以供 Microsoft 内部使用。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-SharePointLocation
此参数仅在基于云的服务中可用。
SharePointLocation 参数指定要包含的 SharePoint Online 网站。 可以按 URL 值标识网站,也可以使用值 All 添加所有网站。
Update 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"
。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-SharePointLocationExclusion
此参数仅在基于云的服务中可用。
保留此参数以供 Microsoft 内部使用。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Security & Compliance |
-StatusMailRecipients
此参数只在本地 Exchange 中可用。
保留此参数以供 Microsoft 内部使用。
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019 |
-WhatIf
保留此参数以供 Microsoft 内部使用。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |