Get-ComplianceSearchAction

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

Use the Get-ComplianceSearchAction cmdlet to view information about compliance search actions in Exchange Server 2016 and in the Office 365 Security & Compliance Center.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://docs.microsoft.com/powershell/exchange/exchange-server/exchange-cmdlet-syntax).

Syntax

Get-ComplianceSearchAction
   [[-Identity] <ComplianceSearchActionIdParameter>]
   [-Case <String>]
   [-Details]
   [-DomainController <Fqdn>]
   [-IncludeCredential]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]
Get-ComplianceSearchAction
   [-Preview]
   [-Case <String>]
   [-Details]
   [-DomainController <Fqdn>]
   [-IncludeCredential]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]
Get-ComplianceSearchAction
   [-Purge]
   [-Case <String>]
   [-Details]
   [-DomainController <Fqdn>]
   [-IncludeCredential]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]
Get-ComplianceSearchAction
   [-Export]
   [-Case <String>]
   [-Details]
   [-DomainController <Fqdn>]
   [-IncludeCredential]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

Description

After you create and run a compliance search using the New-ComplianceSearch cmdlet, and start the search using the Start-ComplianceSearch cmdlet, you assign a search action using the New-ComplianceSearchAction cmdlet. You use the Get-ComplianceSearchAction cmdlet to track the progress of the compliance search action.

You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet.

This cmdlet is available in the Mailbox Search role. By default, this role is assigned only to the Discovery Management role group, and not to the Organization Management role group.

You need to be assigned permissions in the Office 365 Security & Compliance Center before you can use this cmdlet. For more information, see Permissions in Office 365 Security & Compliance Center.

Examples

Example 1

Get-ComplianceSearchAction

This example shows a summary list of all compliance search actions.

Example 2

Get-ComplianceSearchAction -Identity "Case 1234_Preview" | Format-List

This example shows details about the compliance search action named "Case 1234_Preview"

Parameters

-Case

This parameter is reserved for internal Microsoft use.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center
-Details

The Details switch specifies whether to include detailed information in the results. You don't need to specify a value with this switch.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center
-DomainController

This parameter is available only in on-premises Exchange.

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.

Type:Fqdn
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019
-Export

The Export switch filters the results by Export compliance search actions. You don't need to specify a value with this switch.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center
-Identity

The Identity parameter specifies the compliance search action that you want to view. You can use any value that uniquely identifies the compliance search action. For example:

  • Name: The compliance search action name uses the syntax <Compliance Search Name>_<Action> . For example, Case 1234_Preview.

  • JobRunId (GUID)

Type:ComplianceSearchActionIdParameter
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center
-IncludeCredential

The IncludeCredential switch specifies whether to include the credential in the results. You don't need to specify a value with this switch.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center
-Preview

The Preview switch filters the results by Preview compliance search actions.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center
-Purge

The Purge switch filters the results by Purge compliance search actions.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center
-ResultSize

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.

Type:Unlimited
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Office 365 Security & Compliance Center

Inputs

Outputs