Export (0) Print
Expand All

Set-SearchDocumentFormat

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-03-05

This cmdlet is available only in on-premises Exchange Server 2013.

Use the Set-SearchDocumentFormat cmdlet to enable or disable the file format for Exchange Search.

ImportantImportant:
When you disable a file format for content indexing by Exchange Search, contents of the file become unsearchable by Exchange Search clients such as Microsoft Office Outlook Web App, Microsoft Outlook in online mode, and In-Place eDiscovery.

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

Set-SearchDocumentFormat -Enabled <$true | $false> -Identity <SearchDocumentFormatId> [-Confirm [<SwitchParameter>]] [-Server <ServerIdParameter>] [-WhatIf [<SwitchParameter>]]

This command disables the Zip file format for indexing by Exchange Search.

Set-SearchDocumentFormat ZIP -Enabled $false

In Microsoft Exchange Server 2013, Exchange Search includes built-in support for indexing many file formats. If you disable indexing for a supported file format, items containing an attachment of that file type aren't considered unsearchable. When you perform an In-Place eDiscovery search, and you select the option to include unsearchable items, only items that are actually unsearchable are returned. Items that weren't searched because the associated file format is set as unsearchable aren’t returned.

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 "Exchange Search - diagnostics" entry in the Recipients Permissions topic.

 

Parameter Required Type Description

Enabled

Required

System.Boolean

The Enabled parameter specifies whether the file format is enabled. Set the parameter to $false to disable the format for content indexing.

Identity

Required

Microsoft.Exchange.Management.Search.SearchDocumentFormatId

The Identity parameter specifies the identity of the file format.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

Server

Optional

Microsoft.Exchange.Configuration.Tasks.ServerIdParameter

The Server parameter specifies the name of the server against which the command is executed.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

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