New-ComplianceSearchAction
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。
使用 New-ComplianceSearchAction cmdlet 在 Exchange Server 和 Microsoft Purview 合规门户 中创建内容搜索操作。
有关以下语法部分的参数设置的详细信息，请参阅 Exchange cmdlet 语法。
语法
New-ComplianceSearchAction
[-SearchName] <String[]>
[-Export]
[-ActionName <String>]
[-ArchiveFormat <ComplianceExportArchiveFormat>]
[-Confirm]
[-FileTypeExclusionsForUnindexedItems <String[]>]
[-EnableDedupe <Boolean>]
[-ExchangeArchiveFormat <ComplianceExportArchiveFormat>]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-IncludeSharePointDocumentVersions <Boolean>]
[-JobOptions <Int32>]
[-NotifyEmail <String>]
[-NotifyEmailCC <String>]
[-ReferenceActionName <String>]
[-Region <String>]
[-Report]
[-RetentionReport]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-Scope <ComplianceExportScope>]
[-SearchNames <String[]>]
[-SharePointArchiveFormat <ComplianceExportArchiveFormat>]
[-ShareRootPath <String>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>] New-ComplianceSearchAction
[-SearchName] <String[]>
[-Preview]
[-ActionName <String>]
[-Confirm]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-JobOptions <Int32>]
[-ReferenceActionName <String>]
[-Region <String>]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-SearchNames <String[]>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>] New-ComplianceSearchAction
[-SearchName] <String[]>
[-Purge]
[-PurgeType <ComplianceDestroyType>]
[-ActionName <String>]
[-Confirm]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-JobOptions <Int32>]
[-Region <String>]
[-ReferenceActionName <String>]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-SearchNames <String[]>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>] 说明
使用 New-ComplianceSearch cmdlet 创建内容搜索并使用 Start-ComplianceSearch cmdlet 运行它后，可以使用 New-ComplianceSearchAction cmdlet 为搜索分配搜索操作。
在本地 Exchange 中，此 cmdlet 在邮箱搜索角色中可用。 默认情况下，此角色仅分配给发现管理角色组。
您必须先获得权限，然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数，但如果这些参数并未包含在分配给您的权限中，那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限，请参阅 Find the permissions required to run any Exchange cmdlet。
在 Microsoft 365 中，用于运行此 cmdlet 的帐户必须分配有有效的 Microsoft 365 许可证。
若要在安全性 & 合规性 PowerShell 中使用此 cmdlet，需要分配权限。 有关详细信息，请参阅 Microsoft Purview 合规门户中的权限。
示例
示例 1
New-ComplianceSearchAction -SearchName "Project X" -Preview此示例为名为 Project X 的内容搜索创建预览搜索操作。
示例 2
New-ComplianceSearchAction -SearchName "Project X" -Export此示例为名为 Project X 的内容搜索创建导出搜索操作。
示例 3
New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeType SoftDelete此示例删除名为“删除钓鱼邮件”的内容搜索返回的搜索结果。 请注意，使用 Purge 参数时，不会删除未编制索引的项。
示例 4
New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPst此示例导出由名为“Case 321 All Sites”的内容搜索返回的结果。 搜索结果将压缩并导出到单个 ZIP 文件。 如果搜索包含任何 Exchange 位置，搜索结果将导出为每个邮箱的一个 PST 文件。
参数
-ActionName
此参数仅在基于云的服务中可用。
ActionName 参数指定内容搜索操作的名称。 仅当在 SearchName 参数中指定多个内容搜索时，才使用此参数。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-ArchiveFormat
此参数已被弃用，将不再使用。
若要指定 Exchange 搜索结果的格式，请使用 ExchangeArchiveFormat 参数。 若要指定 SharePoint 和 OneDrive 搜索结果的格式，请使用 SharePointArchiveFormat 参数。
| Type: | ComplianceExportArchiveFormat |
| 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 |
-EnableDedupe
保留此参数以供 Microsoft 内部使用。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-ExchangeArchiveFormat
此参数仅在基于云的服务中有效。
此参数需要安全性 & 合规性 PowerShell 中的“导出”角色。 默认情况下，此角色仅分配给电子数据展示管理员角色组。
ExchangeArchiveFormat 参数指定如何导出 Exchange 搜索结果。 有效值包含:
- PerUserPst：每个邮箱有一个 PST 文件。
- SinglePst：包含所有导出邮件的 PST 文件。
- SingleFolderPst：一个 PST 文件，其中包含整个导出的单个根文件夹。
- IndividualMessage：将每条消息导出为 .msg 消息文件。 此值为默认值。
- PerUserZip：每个邮箱的一个 ZIP 文件。 每个 ZIP 文件都包含从邮箱导出的 .msg 邮件文件。
- SingleZip：所有邮箱的一个 ZIP 文件。 ZIP 文件包含所有邮箱中导出的所有 .msg 邮件文件。 此输出设置仅在 PowerShell 中可用。
若要指定 SharePoint 和 OneDrive 搜索结果的格式，请使用 SharePointArchiveFormat 参数。
| Type: | ComplianceExportArchiveFormat |
| 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 |
-Export
此参数仅在基于云的服务中有效。
此参数需要安全性 & 合规性 PowerShell 中的“导出”角色。 默认情况下，此角色仅分配给电子数据展示管理员角色组。
“导出”开关指定内容搜索的操作是导出与搜索条件匹配的完整结果集。 不必为此开关指定值。
若要仅返回有关报表中每个检测到的项的信息，请使用“报表”开关。
| 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 |
-FileTypeExclusionsForUnindexedItems
FileTypeExclusionsForUnindexedItems 指定要排除的文件类型，因为它们无法编制索引。 可以指定用逗号分隔的多个值。
| 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 |
-Format
在安全 & 合规性 PowerShell 中，此参数需要“导出”角色。 默认情况下，此角色仅分配给电子数据展示管理员角色组。
使用“导出”开关时，Format 参数指定搜索结果的格式。 有效值包含:
- FxStream：导出到 PST 文件。 这是从Microsoft Purview 合规门户导出搜索结果时唯一可用的选项。
- Mime：导出到 .eml 消息文件。 这是使用 cmdlet 导出搜索结果时的默认值。
- 消息：导出到 .msg 消息文件。
| Type: | ComplianceDataTransferFormat |
| 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 |
-IncludeCredential
IncludeCredential 开关指定是否在结果中包含凭据。 不必为此开关指定值。
| 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 |
-IncludeSharePointDocumentVersions
此参数仅在基于云的服务中可用。
IncludeSharePointDocumentVersions 参数指定在使用“导出”开关时是否导出文档的以前版本。 有效值包含:
- $true：导出文档的所有版本。
- $false：仅导出主题的当前已发布版本。 此值为默认值。
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-JobOptions
保留此参数以供 Microsoft 内部使用。
| Type: | Int32 |
| 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 |
-NotifyEmail
在安全 & 合规性 PowerShell 中，此参数需要“导出”角色。 默认情况下，它仅分配给电子数据展示管理员角色组。
NotifyEmail 参数指定使用“导出”开关时搜索结果的电子邮件地址目标。
指定的收件人位于邮件的“收件人：”字段中。
| 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 |
-NotifyEmailCC
在安全 & 合规性 PowerShell 中，此参数需要“导出”角色。 默认情况下，此角色仅分配给电子数据展示管理员角色组。
NotifyEmailCC 参数指定使用“导出”开关时搜索结果的电子邮件地址目标。
指定的收件人位于邮件的“抄送：”字段中。
| 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 |
-Preview
在安全 & 合规性 PowerShell 中，此参数需要预览角色。 默认情况下，此角色仅分配给电子数据展示管理员角色组。
预览开关指定内容搜索的操作是预览与搜索条件匹配的结果。 不必为此开关指定值。
| 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 |
-Purge
注意：在安全性 & 合规性 PowerShell 中，此开关仅在“搜索和清除”角色中可用。 默认情况下，此角色仅分配给组织管理和数据调查员角色组。
清除开关指定内容搜索的操作是删除与搜索条件匹配的项目。 不必为此开关指定值。
- 一次最多可以删除每个邮箱的 10 封邮件。 因为搜索和删除邮件的功能是用作事件响应工具，所以此限制可帮助确保从邮箱中快速删除邮件。 此操作不用于清理用户邮箱。
- 可以使用单个内容搜索从最多 50，000 个邮箱中删除项目。 若要从 50，000 多个邮箱中删除项目，必须创建单独的内容搜索。 有关详细信息，请参阅 在 Microsoft 365 组织中搜索和删除电子邮件。
- 使用此开关时，不会从邮箱中删除未编制索引的项目。
- PurgeType 参数的值控制如何删除项。
| 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 |
-PurgeType
注意：在安全性 & 合规性 PowerShell 中，此参数仅在“搜索和清除”角色中可用。 默认情况下，此角色仅分配给组织管理和数据调查员角色组。
PurgeType 参数指定在操作为 Purge 时如何删除项。 有效值包含:
- SoftDelete：用户可恢复清除的项目，直到已删除项目保留期到期。
- HardDelete (仅限云) ：已清除的项目标记为从邮箱中永久删除，并在下次由托管文件夹助理处理邮箱时永久删除。 如果在邮箱上启用了单个项目恢复，则清除的项目将在已删除邮件保留期到期后永久删除。
| Type: | ComplianceDestroyType |
| 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 |
-ReferenceActionName
保留此参数以供 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 |
-Region
保留此参数以供 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 |
-Report
此参数仅在基于云的服务中有效。
“报告”开关指定内容搜索的操作是导出有关结果 (每个项的信息的报表，而不是导出与搜索条件匹配的完整结果集) 。 不必为此开关指定值。
| 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 |
-RetentionReport
RetentionReport 开关指定内容搜索的操作是导出保留报告。 不必为此开关指定值。
| 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 |
-RetryOnError
RetryOnError 开关指定是否对失败的任何项重试操作，而不重新运行整个操作。 不必为此开关指定值。
| 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 |
-Scenario
在安全 & 合规性 PowerShell 中，此参数需要预览角色。 默认情况下，此角色仅分配给电子数据展示管理员角色组。
使用“导出”开关时，Scenario 参数指定方案类型。 有效值包含:
- AnalyzeWithZoom：准备在 Microsoft Purview 电子数据展示高级版 中处理的搜索结果。
- 常规：将搜索结果导出到本地计算机。 电子邮件将导出到 .pst 文件。 SharePoint 和 OneDrive for Business 文档以其本机 Office 格式导出。
- GenerateReportsOnly：
- 库存：
- RetentionReports：
- 会审预览：
| Type: | ComplianceSearchActionScenario |
| 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 |
-Scope
Scope 参数指定要在操作为 Export 时包含的项。 有效值包含:
- IndexedItemsOnly
- UnindexedItemsOnly
- BothIndexedAndUnindexedItems
| Type: | ComplianceExportScope |
| 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 |
-SearchName
SearchName 参数指定要与内容搜索操作关联的现有内容搜索的名称。 可以指定多个以逗号分隔的内容搜索。
可以通过运行命令来查找内容搜索Get-ComplianceSearch |Format-Table -“自动名称”、“状态”。
| 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 |
-SearchNames
此参数仅在基于云的服务中可用。
SearchNames 参数指定要与内容搜索操作关联的现有内容搜索的名称。 用逗号分隔内容搜索名称。
可以通过运行命令来查找内容搜索名称Get-ComplianceSearch |Format-Table -“自动名称”、“状态”。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-SharePointArchiveFormat
此参数仅在基于云的服务中有效。
此参数需要“导出”角色。 默认情况下，此角色仅分配给电子数据展示管理员角色组。
SharePointArchiveFormat 参数指定如何导出 SharePoint 和 OneDrive 搜索结果。 有效值包含:
- IndividualMessage：导出未压缩的文件。 此值为默认值。
- PerUserZip：每个用户的一个 ZIP 文件。 每个 ZIP 文件都包含用户的导出文件。
- SingleZip：所有用户的一个 ZIP 文件。 ZIP 文件包含所有用户导出的所有文件。 此输出设置仅在 PowerShell 中可用。
若要指定 Exchange 搜索结果的格式，请使用 ExchangeArchiveFormat 参数。
| Type: | ComplianceExportArchiveFormat |
| 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 |
-ShareRootPath
{{ Fill ShareRootPath 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 |
-Version
保留此参数以供 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 |
-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 |