Set-ComplianceSearch

模块:

ExchangePowerShell

适用于:

Exchange Server 2016, Exchange Server 2019, Security & Compliance

此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。

使用 Set-ComplianceSearch cmdlet 修改 Exchange Server 2016 或更高版本以及Microsoft Purview 合规门户中未运行的符合性搜索。

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

语法

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

当 ExchangeLocation 参数未使用值 All 时，AddExchangeLocation 参数指定要添加到包含邮箱列表的邮箱。 有效值包含:

• 常规用户邮箱。 包括其他类型的邮箱 (例如，非活动邮箱或Microsoft 365 来宾用户) 由 AllowNotFoundExchangeLocationsEnabled 参数控制。
• 邮箱

若要指定邮箱或通讯组，请使用电子邮件地址。 可以指定用逗号分隔的多个值。

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

-AddExchangeLocationExclusion

此参数仅在本地 Exchange 中有效。

此参数指定要在对 ExchangeLocation 参数使用值 All 时添加到已排除邮箱列表的邮箱。 有效值包含:

• 常规用户邮箱。 包括其他类型的邮箱 (例如，非活动邮箱或Microsoft 365 来宾用户) 由 AllowNotFoundExchangeLocationsEnabled 参数控制。
• 邮箱

若要指定邮箱或通讯组，请使用电子邮件地址。 可以指定用逗号分隔的多个值。

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

-AddSharePointLocation

此参数仅在基于云的服务中可用。

AddSharePointLocation 参数指定要在未对 SharePointLocation 参数使用值 All 时添加到包含网站列表的 SharePoint Online 网站。 可以按 URL 值标识网站。

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

-AddSharePointLocationExclusion

此参数仅在基于云的服务中可用。

保留此参数以供 Microsoft 内部使用。

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

-AllowNotFoundExchangeLocationsEnabled

AllowNotFoundExchangeLocationsEnabled 参数指定是否在合规性搜索中包含常规用户邮箱以外的邮箱。 有效值包含:

• $true：在继续之前，搜索不会尝试验证邮箱是否存在。 如果要搜索未解析为常规邮箱的邮箱，则需要此值。
• $false：在继续之前，搜索会尝试验证邮箱是否存在。 如果指定不是常规用户邮箱的邮箱，搜索将失败。 此值为默认值。

受此参数值影响的邮箱类型包括：

• 非活动邮箱
• 没有Exchange Online许可证的用户使用 Office 应用程序
• 来宾用户
• 标识与 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

-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。 您只能自行使用此值。

若要指定邮箱或通讯组，请使用电子邮件地址。 可以指定用逗号分隔的多个值。

Update 如果值包含空格或需要引号，请使用以下语法： "Value1","Value2",..."ValueN"。

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

-ExchangeLocationExclusion

此参数仅在本地 Exchange 中有效。

此参数指定要在 ExchangeLocation 参数使用值 All 时排除的邮箱。 有效值包含:

• 常规用户邮箱。 包括其他类型的邮箱 (例如，非活动邮箱或Microsoft 365 来宾用户) 由 AllowNotFoundExchangeLocationsEnabled 参数控制。
• 邮箱

若要指定邮箱或通讯组，请使用电子邮件地址。 可以指定用逗号分隔的多个值。

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。 只能将此参数用于与电子数据展示服务案例关联的合规性搜索。

如果符合性搜索中的内容位置包括邮箱，则还需要将 ExchangeLocation 参数与值$null。 同样，如果符合性搜索包括 SharePoint 网站，则还需要将 SharePointLocation 参数与值$null。

此外，如果内容位置置于基于查询的服务案例的保留状态，则在重新启动此合规性搜索时，只会搜索处于保留状态的项目。 例如，如果将用户置于基于查询的服务案例的保留状态，且可保留在特定日期之前发送或创建的项目，则通过使用此合规性搜索指定的搜索条件，可仅对这些项目进行搜索。

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

-Identity

Identity 参数指定要修改的合规性搜索。

使用此参数时，必须使用 Identity 参数，但可忽略值。 例如，对 Identity 参数使用值 000。

• 名称
• JobRunId (GUID)

JobRunId (GUID)

Type:	ComplianceSearchIdParameter
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Server 2016, Exchange Server 2019, 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：搜索中将包括任何 Exchange 位置参数中指定的用户的基于云的存储位置。 如果将值 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

-Name

保留此参数以供 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, 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

-RemoveExchangeLocation

RemoveExchangeLocation 参数指定要在未对 ExchangeLocation 参数使用值 All 时从包含邮箱列表中删除的邮箱。 有效值包含:

• 此参数指定了在对 ExchangeLocation 参数使用值 All 时要从已排除邮箱列表中删除的邮箱。有效值为：
• 邮箱

若要指定邮箱或通讯组，请使用电子邮件地址。 可以指定用逗号分隔的多个值。

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

-RemoveExchangeLocationExclusion

此参数仅在本地 Exchange 中有效。

此参数指定要在对 ExchangeLocation 参数使用值 All 时从排除的邮箱列表中删除的邮箱。 有效值包含:

• 此参数指定了在对 ExchangeLocation 参数使用值 All 时要从已排除邮箱列表中删除的邮箱。有效值为：
• 邮箱

若要指定邮箱或通讯组，请使用电子邮件地址。 可以指定用逗号分隔的多个值。

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

-RemovePublicFolderLocation

此参数仅在基于云的服务中可用。

保留此参数以供 Microsoft 内部使用。

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

-RemoveSharePointLocation

此参数仅在基于云的服务中可用。

RemoveSharePointLocation 参数指定要在未对 SharePointLocation 参数使用值 All 时从包含网站列表中删除的 SharePoint Online 网站。 可以按 URL 值标识网站。

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

-RemoveSharePointLocationExclusion

此参数仅在基于云的服务中可用。

保留此参数以供 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

-WhatIf

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

WhatIf 开关模拟命令操作。 可以使用此开关在不实际应用将会发生的更改的情况下预览这些更改。 不必为此开关指定值。

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