Stop-HistoricalSearch

  • 参考
模块:
ExchangePowerShell
适用于:
Exchange Online, Exchange Online Protection

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

使用 Stop-HistoricalSearch cmdlet 可以停止状态值为 NotStarted 的现有历史搜索。

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

语法

Stop-HistoricalSearch
    -JobId <Guid>
    [<CommonParameters>]

说明

历史搜索以逗号分隔的值 (CSV) 文件中提供邮件跟踪和报告详细信息，用于 90 天以下的邮件。

使用 Start-HistoricalSearch cmdlet 启动历史搜索后，会将搜索排队，但实际未运行。 搜索已排队且状态值为 NotStarted 时，您可以使用 Stop-HistoricalSearch cmdlet 将其停止。 搜索有效运行且状态值为 InProgress 后，无法将其停止。 停止历史搜索后，将赋予其状态值 Cancelled。

您必须先获得权限，然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数，但如果这些参数并未包含在分配给您的权限中，那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限，请参阅 Find the permissions required to run any Exchange cmdlet。

示例

示例 1

Stop-HistoricalSearch -JobId f9c66f83-b5c8-4a0c-91f4-a38376f74182

本示例停止具有 JobId 值 f9c66f83-b5c8-4a0c-91f4-a38376f74182 的历史搜索。

参数

-JobId

JobId 参数指定要停止的历史搜索的标识 GUID 值。

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online, Exchange Online Protection

输入

Input types

若要了解此 cmdlet 接受的输入类型，请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空，则表明此 cmdlet 不接受输入数据。

输出

Output types

若要了解此 cmdlet 接受的返回类型（亦称为"输出类型"），请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空，则表明此 cmdlet 不返回任何数据。