Skip to main content
TechNet
Get-MailboxSearch
 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MailboxSearch cmdlet to view mailbox searches that are in progress, complete, or stopped.

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

Syntax
Get-MailboxSearch [-Identity <EwsStoreObjectIdParameter>] <COMMON PARAMETERS>
Get-MailboxSearch -InPlaceHoldIdentity <String> <COMMON PARAMETERS>
COMMON PARAMETERS: [-DomainController <Fqdn>] [-ResultSize <Unlimited>] [-ShowDeletionInProgressSearches <SwitchParameter>]
Examples
Example 1

This example retrieves a list of all mailbox searches.

Get-MailboxSearch -ResultSize "unlimited"
Example 2

This example retrieves all properties for the mailbox search Project Hamilton.

Get-MailboxSearch "Project Hamilton" | FL
noteNote:
The Identity parameter is a positional parameter. Positional parameters can be used without the label (Identity). For more information about positional parameters, see Parameters.
Example 3

This example retrieves the In-Place Holds that a user is placed on. The following command outputs GUIDs of In-Place Holds.

(Get-Mailbox Mark).InPlaceHolds

The following command retrieves a mailbox search based on the GUID of the In-Place Hold that the user is placed on.

Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb
Detailed Description

In on-premises Exchange and Exchange Online, a mailbox search is used to perform an In-Place eDiscovery or to place users on an In-Place Hold. Use the Get-MailboxSearch cmdlet to retrieve details of either type of mailbox search.

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 "In-Place eDiscovery" entry in the Messaging policy and compliance permissions topic.

Parameters

 

Parameter Required Type Description

InPlaceHoldIdentity

Required

System.String

The InPlaceHoldIdentity parameter specifies the GUID of an In-Place Hold. Use this parameter to search for an In-Place Hold that a user is placed on. GUIDs of all In-Place Holds that a user is placed on are added to the user's InPlaceHolds property. You can retrieve the property by using the Get-Mailbox cmdlet.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.EwsStoreObjectIdParameter

The Identity parameter specifies the name of the search query. If a name isn't provided, all mailbox search queries are returned.

To improve the performance of this cmdlet in Exchange Online, some mailbox search properties aren't returned if you don't specify the name of a mailbox search. These properties are:

  • SourceMailboxes

  • Sources

  • SearchQuery

  • ResultsLink

  • PreviewResultsLink

  • Errors

To view these properties, you have to provide the name of a mailbox search.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

ShowDeletionInProgressSearches

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

Input Types

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.

Return Types

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.