Get-ContentFilterPhrase

Reference

Module:: ExchangePowerShell

Applies to:: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019

This cmdlet is available only in on-premises Exchange.

Use the Get-ContentFilterPhrase cmdlet to view one or all custom words that the Content Filter agent processes.

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

Syntax

Get-ContentFilterPhrase
   [[-Identity] <ContentFilterPhraseIdParameter>]
   [-DomainController <Fqdn>]
   [<CommonParameters>]

Get-ContentFilterPhrase
   [-Phrase <ContentFilterPhraseIdParameter>]
   [-DomainController <Fqdn>]
   [<CommonParameters>]

Description

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-ContentFilterPhrase

This example returns all custom words stored on the computer where the command is being run.

Example 2

Get-ContentFilterPhrase -Phrase "Free credit report"

This example returns a specific custom word specified by the Phrase parameter. In this example, the custom word is the phrase Free credit report.

Example 3

Get-ContentFilterPhrase | Where {$_.Phrase -like '*free offer*'}

This example returns all custom words and phrases that contain the words free offer.

Parameters

-DomainController

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.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

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

-Identity

The Identity parameter specifies a custom word or phrase to display. You must enclose the value of the Identity parameter in quotation marks (").

The Identity and Phrase parameters are interchangeable.

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

-Phrase

The Phrase parameter specifies a custom word or phrase to display. You must enclose the value of the Phrase parameter in quotation marks (").

The Phrase and Identity parameters are interchangeable.

Type:	ContentFilterPhraseIdParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Server 2010, 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.

Jaa