Get-ATPBuiltInProtectionRule

Module:

ExchangePowerShell

Applies to:

Exchange Online

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

Use the Get-ATPBuiltInProtectionRule cmdlet to view 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.

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

Syntax

Get-ATPBuiltInProtectionRule
   [[-Identity] <DehydrateableRuleIdParameter>]
   [-State <RuleState>]
   [<CommonParameters>]

Description

For more information about preset security policies, see Preset security policies in EOP and Microsoft Defender for Office 365.

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-ATPBuiltInProtectionRule

This example shows the rule for the Built-in protection preset security policy.

Parameters

-Identity

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

• Name
• Distinguished name (DN)
• GUID

The name of the only rule is ATP Built-In Protection Rule.

Type:	DehydrateableRuleIdParameter
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False
Applies to:	Exchange Online

-State

The State parameter filters the results by the state of the rule. Valid values are:

• Disabled
• Enabled

The only rule is always enabled.

Type:	RuleState
Accepted values:	Enabled, Disabled
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False
Applies to:	Exchange Online