Get-TransportRulePredicate

 

Applies to: Exchange Online, Exchange Online Protection, Exchange Server 2016

Topic Last Modified: 2016-10-06

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-TransportRulePredicate cmdlet to view the predicates (conditions and exceptions) that are available for transport rules (mal flow rules).

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

Get-TransportRulePredicate [-Name <String>]

This example returns a summary list of all predicates.

Get-TransportRulePredicate

This example returns detailed information about the predicate named SubjectMatches.

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.

This example returns a summary list of all predicates that have Attachment in the name.

Get-TransportRulePredicate | Where {$_.Name -like "*Attachment*"}

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

Collectively, the conditions and exceptions in rules are known as predicates, because for every condition, there's a corresponding exception that uses the exact same settings and syntax. The only difference is conditions specify messages to include, while exceptions specify messages to exclude. That's why the output of this cmdlet doesn't list exceptions separately. Also, the names of some of the predicates that are returned by this cmdlet are different than the corresponding parameter names in the New-TransportRule and Set-TransportRule cmdlets.

In on-premises Exchange, the predicates that are available on Mailboxes servers and Edge Transports server are different.

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.

 

Parameter Required Type Description

Name

Optional

System.String

The Name parameter specifies the name of the predicate that you want to view. To see the list of available names, run the command Get-TransportRulePredicate.

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.

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.

 
Show: