Get-ATPBuiltInProtectionRule
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
Default (Default)
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 article lists all parameters for the cmdlet, you might not have access to some parameters if they aren't 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
Applicable: Exchange Online
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.
Parameter properties
| Type: | DehydrateableRuleIdParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-State
Applicable: Exchange Online
The State parameter filters the results by the state of the rule. Valid values are:
- Disabled
- Enabled
The only rule is always enabled.
Parameter properties
| Type: | RuleState |
| Default value: | None |
| Accepted values: | Enabled, Disabled |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.