Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2012-07-12

Use the Get-TransportRulePredicate cmdlet to retrieve a list of all available rule predicates that can be used when creating a transport rule.

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

Syntax

Get-TransportRulePredicate [-Name <String>]

Examples

EXAMPLE 1

This example returns all available predicates for transport rules.

Copy Code
Get-TransportRulePredicate

EXAMPLE 2

This example retrieves the single predicate SubjectMatches. The command is piped to the Format-List command to display detailed transport rule predicate information.

Copy Code
Get-TransportRulePredicate -Name SubjectMatches | Format-List

For more information about pipelining, see Pipelining. For more information about how to work with the output of a command, see Working with Command Output.

EXAMPLE 3

This example returns the list of all transport rule predicates related to message attachments by filtering the output..

Copy Code
Get-TransportRulePredicate | Where {$_.Name -like '*Attachment*'}

For more information about how to work with the output of a command, see Working with Command Output

Detailed Description

The Get-TransportRulePredicate cmdlet displays a list of available rule predicates that you can use in transport rules.

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 "Transport rules" entry in the Messaging Policy and Compliance Permissions topic.

Parameters

Parameter Required Type Description

Name

Optional

System.String

The Name parameter specifies the predicate to display. For a list of values that can be used with this parameter on the server role that you're administering, see Transport Rule Predicates.

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.

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