Get-ContentFilterPhrase
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
Identity
Get-ContentFilterPhrase
[[-Identity] <ContentFilterPhraseIdParameter>]
[-DomainController <Fqdn>]
[<CommonParameters>]
Phrase
Get-ContentFilterPhrase
[-Phrase <ContentFilterPhraseIdParameter>]
[-DomainController <Fqdn>]
[<CommonParameters>]
Description
You need to be assigned permissions before you can run this cmdlet. Although this article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't 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
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Parameter properties
| Type: | Fqdn |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Parameter properties
| Type: | ContentFilterPhraseIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Phrase
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Parameter properties
| Type: | ContentFilterPhraseIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Phrase
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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.