Set-ComplianceSearch
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 某些参数和设置可能是一个环境或另一个环境独占。
使用 Set-ComplianceSearch cmdlet 修改 Exchange Server 2016 或更高版本和 Microsoft Purview 合规门户 中未运行的合规性搜索。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
注意
在云中,此 cmdlet 具有以下要求:
- 2025 年 8 月) (Exchange Online PowerShell 模块的版本 3.9.0 或更高版本。
- 运行 Connect-IPPSSession 命令连接到安全 & 合规性 PowerShell 时,请使用 EnableSearchOnlySession 参数。
语法
Default (默认值)
Set-ComplianceSearch
[-Identity] <ComplianceSearchIdParameter>
[-AddExchangeLocation <String[]>]
[-AddExchangeLocationExclusion <String[]>]
[-AddSharePointLocation <String[]>]
[-AddSharePointLocationExclusion <String[]>]
[-AllowNotFoundExchangeLocationsEnabled <Boolean>]
[-Confirm]
[-ContentMatchQuery <String>]
[-Description <String>]
[-ExchangeLocation <String[]>]
[-ExchangeLocationExclusion <String[]>]
[-Force]
[-HoldNames <String[]>]
[-IncludeOrgContent <Boolean>]
[-IncludeUserAppContent <Boolean>]
[-Language <CultureInfo>]
[-Name <String>]
[-PublicFolderLocation <String[]>]
[-RefinerNames <String[]>]
[-RemoveExchangeLocation <String[]>]
[-RemoveExchangeLocationExclusion <String[]>]
[-RemovePublicFolderLocation <String[]>]
[-RemoveSharePointLocation <String[]>]
[-RemoveSharePointLocationExclusion <String[]>]
[-SharePointLocation <String[]>]
[-SharePointLocationExclusion <String[]>]
[-WhatIf]
[<CommonParameters>]
说明
您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果分配给你的权限中未包含某些参数,则可能无权访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
在本地 Exchange 中,此 cmdlet 可用于邮箱搜索角色。 默认情况下,此角色仅分配给发现管理角色组。
要在安全与合规中心 PowerShell 中使用此 cmdlet,必须分配权限。 有关详细信息,请参阅 Microsoft Purview 合规门户中的权限。
示例
示例 1
Set-ComplianceSearch -Identity "Project X" -ExchangeLocation All
此示例更改了名为 Project X 的现有合规性搜索。Exchange 搜索范围将更改为“所有邮箱”。
示例 2
Set-ComplianceSearch -Identity "Contoso Case Search 1" -HoldNames All -ExchangeLocation $null -SharePointLocation $null
此示例更改了与 Microsoft Purview 合规门户中的电子数据展示事例关联的现有合规性搜索。 搜索范围从搜索所选邮箱和 SharePoint 网站更改为搜索电子数据展示事例中暂停的所有内容位置。
示例 3
Set-ComplianceSearch -Identity "China Subsidiary Search" -Language zh-CN
此示例将现有合规性搜索的语言设置更改为中文。
如果在搜索查询 (中使用非英语关键字(在 ContentMatchQuery 参数) 中指定),则可能需要更改语言设置。
参数
-AddExchangeLocation
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
AddExchangeLocation 参数指定在未对 ExchangeLocation 参数使用值“全部”时要添加到包含邮箱列表中的邮箱。 有效值包含:
- 常规用户邮箱。 包括其他类型的邮箱 (例如非活动邮箱或 Microsoft 365 来宾用户) 由 AllowNotFoundExchangeLocationsEnabled 参数控制。
- 邮箱
若要指定邮箱或通讯组,请使用电子邮件地址。 可以指定用逗号分隔的多个值。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-AddExchangeLocationExclusion
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
此参数仅在本地 Exchange 中有效。
此参数指定在对 ExchangeLocation 参数使用值“全部”时要添加到排除邮箱列表中的邮箱。 有效值包含:
- 常规用户邮箱。 包括其他类型的邮箱 (例如非活动邮箱或 Microsoft 365 来宾用户) 由 AllowNotFoundExchangeLocationsEnabled 参数控制。
- 邮箱
若要指定邮箱或通讯组,请使用电子邮件地址。 可以指定用逗号分隔的多个值。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-AddSharePointLocation
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
AddSharePointLocation 参数指定在未将值“全部”用于 SharePointLocation 参数时要添加到包含网站列表中的 SharePoint 网站。 可以按 URL 值标识网站。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-AddSharePointLocationExclusion
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
保留此参数以供 Microsoft 内部使用。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-AllowNotFoundExchangeLocationsEnabled
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
AllowNotFoundExchangeLocationsEnabled 参数指定是否在合规性搜索中包括常规用户邮箱以外的邮箱。 有效值包含:
- $true:搜索不会在继续之前尝试验证邮箱是否存在。 如果要搜索解析不为常规邮箱的邮箱,则需要此值。
- $false:在继续之前,搜索将尝试验证邮箱是否存在。 如果你指定的邮箱不是常规用户邮箱,则搜索将失败。 此值为默认值。
受此参数值影响的邮箱类型包括:
- 非活动邮箱
- 没有 Exchange Online 许可证但使用 Office 应用程序的用户
- 来宾用户
- 其标识与你的 Microsoft 365 组织同步的本地用户
参数属性
| 类型: | Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Confirm
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 有何影响取决于 cmdlet 在继续操作前是否需要确认。
- 破坏性 cmdlet(例如 Remove-* cmdlets)内置有暂停,可强制要求先确认命令,然后再继续操作。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:
-Confirm:$false。 - 其他大多数 cmdlet(例如 New-* 和 Set-* cmdlet)都没有内置暂停。 对于这些 cmdlet,在不带值的情况下指定“确认”开关会引入一个暂停,从而强制你在继续之前确认命令。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | cf |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ContentMatchQuery
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
ContentMatchQuery 参数指定内容搜索筛选器。
此参数使用通过关键字查询语言 (KQL) 设置格式的文本搜索字符串或查询。 有关详细信息,请参阅 关键字查询语言 (KQL) 语法参考和电子数据展示的关键字查询和搜索条件。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Description
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
Description 参数指定合规性搜索说明。 如果值包含空格,则使用引号括住该值。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ExchangeLocation
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
ExchangeLocation 参数指定要包含的邮箱。 有效值包含:
- 常规用户邮箱。 包括其他类型的邮箱 (例如非活动邮箱或 Microsoft 365 来宾用户) 由 AllowNotFoundExchangeLocationsEnabled 参数控制。
- 邮箱
- 所有邮箱的“全部”值。 您只能自行使用此值。
若要指定邮箱或通讯组,请使用电子邮件地址。 可以指定用逗号分隔的多个值。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ExchangeLocationExclusion
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
此参数仅在本地 Exchange 中有效。
此参数指定将值 All 用于 ExchangeLocation 参数时要排除的邮箱。 有效值包含:
- 常规用户邮箱。 包括其他类型的邮箱 (例如非活动邮箱或 Microsoft 365 来宾用户) 由 AllowNotFoundExchangeLocationsEnabled 参数控制。
- 邮箱
若要指定邮箱或通讯组,请使用电子邮件地址。 可以指定用逗号分隔的多个值。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Force
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
Force 开关会隐藏警告或确认消息。 不必为此开关指定值。
您可以在以编程方式运行任务时使用此开关,因为此时并不适合提示用户提供管理输入。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-HoldNames
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
HoldNames 参数指定搜索指定电子数据展示事例中保留的内容位置。 对此参数使用值 All。 只能将此参数用于与电子数据展示服务案例关联的合规性搜索。
如果合规性搜索中的内容位置包含邮箱,则还需要将 ExchangeLocation 参数与值 $null 一起使用。 同样,如果合规性搜索包括 SharePoint 网站,则还需要将 SharePointLocation 参数与值 $null 一起使用。
此外,如果将内容位置置于基于查询的案例保留中,则重新启动此合规性搜索时仅搜索暂停的项。 例如,如果将用户置于基于查询的服务案例的保留状态,且可保留在特定日期之前发送或创建的项目,则通过使用此合规性搜索指定的搜索条件,可仅对这些项目进行搜索。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Identity
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
Identity 参数指定要修改的合规性搜索。
使用此参数时,必须使用 Identity 参数,但可忽略值。 例如,对 Identity 参数使用值 000。
- 名称
- JobRunId (GUID)
JobRunId (GUID)
参数属性
| 类型: | ComplianceSearchIdParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | 1 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-IncludeOrgContent
适用:安全性 & 合规性
{{ Fill IncludeOrgContent Description }}
参数属性
| 类型: | Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-IncludeUserAppContent
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
IncludeUserAppContent 参数指定要在基于云的存储位置搜索组织中没有常规 Microsoft 365 用户帐户的用户。 这些类型的用户包括使用 Office 应用程序的没有 Exchange Online 许可证的用户、Microsoft 365 来宾用户,以及身份与 Microsoft 365 组织同步的本地用户。 有效值包含:
- $true:搜索中包括任何“Exchange 位置”参数中指定的用户的基于云的存储位置。 如果对 ExchangeLocation 参数使用值“全部”,则搜索中将包括任何来宾或本地用户的基于云的存储位置。
- $false:搜索中不包括 ExchangeLocation 参数中指定的用户基于云的存储位置。 此值为默认值。
参数属性
| 类型: | Boolean |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Language
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
Language 参数指定合规性搜索的语言。
此参数的有效输入是来自 Microsoft .NET Framework CultureInfo 类的受支持的区域性代码值。 例如,da-DK 表示丹麦语,ja-JP 表示日语。 有关详细信息,请参阅 CultureInfo 类。
参数属性
| 类型: | CultureInfo |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Name
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
保留此参数以供 Microsoft 内部使用。
参数属性
| 类型: | String |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PublicFolderLocation
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
PublicFolderLocation 参数指定要在搜索中包括所有公用文件夹。 可以对此参数使用值 All。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RefinerNames
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
保留此参数以供 Microsoft 内部使用。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RemoveExchangeLocation
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
RemoveExchangeLocation 参数指定在未对 ExchangeLocation 参数使用“全部”值时要从包含的邮箱列表中删除的邮箱。 有效值包含:
- 此参数指定了在对 ExchangeLocation 参数使用值 All 时要从已排除邮箱列表中删除的邮箱。有效值为:
- 邮箱
若要指定邮箱或通讯组,请使用电子邮件地址。 可以指定用逗号分隔的多个值。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RemoveExchangeLocationExclusion
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
此参数仅在本地 Exchange 中有效。
此参数指定在对 ExchangeLocation 参数使用值“全部”时要从排除邮箱列表中删除的邮箱。 有效值包含:
- 此参数指定了在对 ExchangeLocation 参数使用值 All 时要从已排除邮箱列表中删除的邮箱。有效值为:
- 邮箱
若要指定邮箱或通讯组,请使用电子邮件地址。 可以指定用逗号分隔的多个值。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RemovePublicFolderLocation
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
保留此参数以供 Microsoft 内部使用。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RemoveSharePointLocation
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
RemoveSharePointLocation 参数指定在未将值“全部”用于 SharePointLocation 参数时要从包含的网站列表中删除的 SharePoint 网站。 可以按 URL 值标识网站。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RemoveSharePointLocationExclusion
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
保留此参数以供 Microsoft 内部使用。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SharePointLocation
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
SharePointLocation 参数指定要包含的 SharePoint 网站。 可以按 URL 值标识网站,也可以使用值 All 添加所有网站。
Update 如果值中有空格或需要使用双引号,请使用以下语法:"Value1","Value2",..."ValueN"。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SharePointLocationExclusion
适用:安全性 & 合规性
此参数仅在基于云的服务中可用。
保留此参数以供 Microsoft 内部使用。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-WhatIf
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
WhatIf 开关在安全与合规 PowerShell 中不起作用。
WhatIf 开关显示命令执行的操作,而无需进行任何更改。 不必为此开关指定值。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | WI |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持以下常用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。