Upravit

Sdílet prostřednictvím


Get-SearchDocumentFormat

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-SearchDocumentFormat cmdlet to retrieve details of file formats supported by Exchange Search.

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

Syntax

Get-SearchDocumentFormat
   [[-Identity] <SearchDocumentFormatId>]
   [-Server <ServerIdParameter>]
   [<CommonParameters>]

Description

Exchange Search includes built-in support for indexing many file formats. Output from the Get-SearchDocumentFormat cmdlet includes details about each supported file format, including whether content indexing is enabled for the file format, the format handler and the file extension (such as .docx).

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.

Examples

Example 1

Get-SearchDocumentFormat

This example retrieves a list of all file formats supported by Exchange Search.

Example 2

Get-SearchDocumentFormat docx | Format-List *

This example retrieves all properties of the docx file format.

Parameters

-Identity

The Identity parameter specifies the identity of a file format.

Type:SearchDocumentFormatId
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online

-Server

This parameter is available only in on-premises Exchange.

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:

  • Name
  • FQDN
  • Distinguished name (DN)
  • Exchange Legacy DN

If you don't use this parameter, the command is run on the local server.

Type:ServerIdParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

Inputs

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.

Outputs

Output 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.