Applies to: Exchange Server 2013
Topic Last Modified: 2012-12-11
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 -InPlaceHoldIdentity <String>
<COMMON PARAMETERS>
|
Get-MailboxSearch [-Identity
<EwsStoreObjectIdParameter>] <COMMON PARAMETERS>
|
COMMON PARAMETERS: [-DomainController <Fqdn>]
[-Organization <OrganizationIdParameter>] [-ResultSize
<Unlimited>] [-ShowDeletionInProgressSearches
<SwitchParameter>]
|
Examples
EXAMPLE 1
This example retrieves a list of all mailbox searches.
 Copy Code |
|
|---|---|
Get-MailboxSearch -ResultSize "unlimited" |
|
EXAMPLE 2
This example retrieves the mailbox search Project Hamilton.
| Copy Code |
|
|---|---|
Get-MailboxSearch "Project Hamilton" |
|
 Note: |
|---|
| 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.
| Copy Code |
|
|---|---|
(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.
| Copy Code |
|
|---|---|
Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb |
|
Detailed Description
In Microsoft Exchange Server 2013, 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 |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
|
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. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
|
ResultSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ResultSize parameter specifies the maximum number of results to return. The default result size is 1000. Use unlimited to return all mailbox searches. |
|
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.