Start-ComplianceSearch
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 某些参数和设置可能是一个环境或另一个环境独占。
使用 Start-ComplianceSearch cmdlet 在 Exchange Server 2016 或更高版本和Microsoft Purview 合规门户中启动、停止、完成或未启动的合规性搜索。
注意
在云中,此 cmdlet 具有以下要求:
- 2025 年 8 月) (Exchange Online PowerShell 模块的版本 3.9.0 或更高版本。
- 运行 Connect-IPPSSession 命令连接到安全 & 合规性 PowerShell 时,请使用 EnableSearchOnlySession 参数。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
Default (默认值)
Start-ComplianceSearch
[-Identity] <ComplianceSearchIdParameter>
[-Confirm]
[-Force]
[-RetryOnError]
[-WhatIf]
[<CommonParameters>]
说明
您必须先获得权限,然后才能运行此 cmdlet。 尽管本文列出了 cmdlet 的所有参数,但如果分配给你的权限中未包含某些参数,则可能无权访问这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
在本地 Exchange 中,此 cmdlet 可用于邮箱搜索角色。 默认情况下,此角色仅分配给发现管理角色组。
要在安全与合规中心 PowerShell 中使用此 cmdlet,必须分配权限。 有关详细信息,请参阅 Microsoft Purview 合规门户中的权限。
示例
示例 1
Start-ComplianceSearch -Identity "Case 1234"
此示例启动了名为“案例 1234”的合规性搜索
参数
-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 |
-Force
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
Force 开关会隐藏警告或确认消息。 不必为此开关指定值。
您可以在以编程方式运行任务时使用此开关,因为此时并不适合提示用户提供管理输入。
参数属性
| 类型: | SwitchParameter |
| 默认值: | 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 |
-RetryOnError
适用:Exchange Server 2016、Exchange Server 2019、Exchange Server SE、安全性 & 合规性
RetryOnError 开关指定是否在不从头开始重新运行整个搜索的情况下重试搜索任何搜索失败的项目。 不必为此开关指定值。
参数属性
| 类型: | SwitchParameter |
| 默认值: | 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。