Commands › Exchange Online

Set-SearchDocumentFormat

Exchange Online ExchangeOnlineManagement Set-*

Enable or disable the file format for Exchange Search. When you disable a file format for content indexing by Exchange Search, contents of the file become unsearchable by Exchange Search clients such as Outlook on the web, Microsoft Outlook in online mode and In-Place eDiscovery.

Quick start script

# Set-SearchDocumentFormat — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-SearchDocumentFormat
$before | Format-List

# 3. Make the change (dry run first)
Set-SearchDocumentFormat -Identity <SearchDocumentFormatId> -Enabled <Boolean> -WhatIf
Set-SearchDocumentFormat -Identity <SearchDocumentFormatId> -Enabled <Boolean>

# 4. Verify and diff
$after = Get-SearchDocumentFormat
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-SearchDocumentFormat [-Identity] <SearchDocumentFormatId> -Enabled <Boolean>
 [-Confirm]
 [-Server <ServerIdParameter>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (5)

Parameter	Type	Required	What it controls
-Identity	SearchDocumentFormatId	yes	The Identity parameter specifies the identity of the file format.
-Enabled	Boolean	yes	The Enabled parameter specifies whether the file format is enabled. Set the parameter to $false to disable the format for content indexing.
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-Server	ServerIdParameter		The Server parameter specifies the Exchange server where you want to run this command. You can use any value that uniquely identifies the server. For example:
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.