Commands › Exchange Online

Set-AntiPhishRule

Exchange Online ExchangeOnlineManagement Set-*

Modify antiphish rules in your cloud-based organization.

Quick start script

# Set-AntiPhishRule — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-ExchangeOnline -CertificateThumbprint $thumb -AppId $appId -Organization $org

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-AntiPhishRule
$before | Format-List

# 3. Make the change (dry run first)
Set-AntiPhishRule -Identity <RuleIdParameter> -WhatIf
Set-AntiPhishRule -Identity <RuleIdParameter>

# 4. Verify and diff
$after = Get-AntiPhishRule
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Set-AntiPhishRule [-Identity] <RuleIdParameter>
 [-AntiPhishPolicy <AntiPhishPolicyIdParameter>]
 [-Comments <String>]
 [-Confirm]
 [-ExceptIfRecipientDomainIs <Word[]>]
 [-ExceptIfSentTo <RecipientIdParameter[]>]
 [-ExceptIfSentToMemberOf <RecipientIdParameter[]>]
 [-Name <String>]
 [-Priority <Int32>]
 [-RecipientDomainIs <Word[]>]
 [-SentTo <RecipientIdParameter[]>]
 [-SentToMemberOf <RecipientIdParameter[]>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (13)

Parameter	Type	Required	What it controls
-Identity	RuleIdParameter	yes	The Identity parameter specifies the antiphish rule that you want to modify. You can use any value that uniquely identifies the rule. For example:
-AntiPhishPolicy	AntiPhishPolicyIdParameter		The AntiPhishPolicy parameter specifies the antiphish policy that's associated with the antiphish rule. You can use any value that uniquely identifies the policy. For example:
-Comments	String		The Comments parameter specifies informative comments for the rule, such as what the rule is used for or how it has changed over time. The length of the comment can't exceed 1024 characters.
-Confirm	SwitchParameter		The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on whether the cmdlet requires confirmation before proceeding.
-ExceptIfRecipientDomainIs	Word[]		The ExceptIfRecipientDomainIs parameter specifies an exception that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas.
-ExceptIfSentTo	RecipientIdParameter[]		The ExceptIfSentTo parameter specifies an exception that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example:
-ExceptIfSentToMemberOf	RecipientIdParameter[]		The ExceptIfSentToMemberOf parameter specifies an exception that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that...
-Name	String		The Name parameter specifies a unique name for the antiphish rule. If the value contains spaces, enclose the value in quotation marks (").
-Priority	Int32		The Priority parameter specifies a priority value for the rule that determines the order of rule processing. A lower integer value indicates a higher priority, the value 0 is the highest priority, and rules can't...
-RecipientDomainIs	Word[]		The RecipientDomainIs parameter specifies a condition that looks for recipients with email addresses in the specified domains. You can specify multiple domains separated by commas.
-SentTo	RecipientIdParameter[]		The SentTo parameter specifies a condition that looks for recipients in messages. You can use any value that uniquely identifies the recipient. For example:
-SentToMemberOf	RecipientIdParameter[]		The SentToMemberOf parameter specifies a condition that looks for messages sent to members of distribution groups, mail-enabled security groups, or sent to Microsoft 365 Groups. You can use any value that uniquely...
-WhatIf	SwitchParameter		The WhatIf switch shows what the command does without making any changes. You don't need to specify a value with this switch.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.