Export (0) Print
Expand All
Expand Minimize

Stop-HistoricalSearch

Exchange 2013
 

Applies to: Exchange Online Protection, Exchange Online

Topic Last Modified: 2014-01-20

This cmdlet is available only in the cloud-based service.

Use the Stop-HistoricalSearch cmdlet to stop an existing historical search that has a status value of NotStarted.

For information about the parameter sets in the Syntax section below, see Syntax.

Stop-HistoricalSearch -JobId <Guid> [-Organization <OrganizationIdParameter>]

This example stops the historical search that has the JobId value f9c66f83-b5c8-4a0c-91f4-a38376f74182.

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

A historical search provides message trace and report details in a comma-separated value (CSV) file for messages that are between seven and ninety days old.

After you start a historical search by using the Start-HistoricalSearch cmdlet, the search is queued, but not actually running. While the search is queued and has the status value of NotStarted, you can use the Stop-HistoricalSearch cmdlet to stop it. After the search is actively running, and has a status value of InProgress, you can't stop it. When you stop a historical search, it's given a status value of Cancelled.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "View Reports" entry in the Feature permissions in Exchange Online topic.

 

Parameter Required Type Description

JobId

Required

System.Guid

The JobId parameter specifies the identity GUID value of the historical search that you want to stop.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft