Commands › Exchange Online

Set-ATPBuiltInProtectionRule

Exchange Online ExchangeOnlineManagement Set-*

Modify the rule for the Built-in protection preset security policy that effectively provides default policies for Safe Links and Safe Attachments in Microsoft Defender for Office 365. The rule specifies exceptions to the policy.

Quick start script

# Set-ATPBuiltInProtectionRule — 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-ATPBuiltInProtectionRule
$before | Format-List

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

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

Syntax

Set-ATPBuiltInProtectionRule [-Identity] <DehydrateableRuleIdParameter>
 [-Comments <String>]
 [-Confirm]
 [-ExceptIfRecipientDomainIs <Word[]>]
 [-ExceptIfSentTo <RecipientIdParameter[]>]
 [-ExceptIfSentToMemberOf <RecipientIdParameter[]>]
 [-WhatIf]
 [<CommonParameters>]

Parameters (7)

Parameter	Type	Required	What it controls
-Identity	DehydrateableRuleIdParameter	yes	The Identity parameter specifies the rule that you want to modify. You can use any value that uniquely identifies the rule. 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 groups. You can use any value that uniquely identifies the group. For example:
-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.