Stop-ComplianceSearch
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。
使用 Stop-ComplianceSearch cmdlet 停止在 Exchange Server 2016 或更高版本以及Microsoft Purview 合规门户中运行符合性搜索。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
Stop-ComplianceSearch
[-Identity] <ComplianceSearchIdParameter>
[-Confirm]
[-WhatIf]
[<CommonParameters>]
说明
您必须先获得权限,然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数,但如果这些参数并未包含在分配给您的权限中,那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
在本地 Exchange 中,此 cmdlet 在邮箱搜索角色中可用。 默认情况下,此角色仅分配给发现管理角色组。
若要在安全性 & 合规性 PowerShell 中使用此 cmdlet,需要分配权限。 有关详细信息,请参阅 Microsoft Purview 合规门户中的权限。
示例
示例 1
Stop-ComplianceSearch -Identity "Case 1234"
本示例将停止名为“案例 1234”的活动的合规性搜索
参数
-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 |
-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 |
-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 |