Get-AntiPhishRule

This cmdlet is available only in the cloud-based service.

Use the Get-AntiPhishRule cmdlet to view antiphish rules in your cloud-based organization.

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

Syntax

Get-AntiPhishRule
   [[-Identity] <RuleIdParameter>]
   [-State <RuleState>]
   [<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-AntiPhishRule | Format-Table Name,Priority,State

This example returns a summary list of all antiphish rules in your organization.

Example 2

Get-AntiPhishRule -Identity "Research Department Phishing Rule"

This example returns detailed information about the antiphish rule named Research Department Phishing Rule.

Parameters

-Identity

The Identity parameter specifies the antiphish rule that you want to view. You can use any value that uniquely identifies the rule. For example:

  • Name
  • Distinguished name (DN)
  • GUID
Type:RuleIdParameter
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Exchange Online Protection

-State

The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled.

Type:RuleState
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Exchange Online Protection