Skip to content

Commit 9378e6f

Browse files
committed
BIP and preset security policy rule cmdlets
1 parent 29e4602 commit 9378e6f

17 files changed

+729
-154
lines changed

exchange/exchange-ps/exchange/Disable-ATPProtectionPolicyRule.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,9 @@ Disable-ATPProtectionPolicyRule [-Identity] <RuleIdParameter>
2828
```
2929

3030
## DESCRIPTION
31-
Organizations with Defender for Office 365 have up to four rules that are associated with the Standard preset security policy and the Strict preset security policy:
31+
The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled.
3232

33-
- Two rules for Exchange Online Protection (EOP) protections: The rule for the Standard Preset security policy and the rule for the Strict preset security policy control who the EOP protections in the policy (anti-malware, anti-spam, and anti-phishing) apply to (the recipient conditions and exceptions for EOP protections).
34-
- Two rules for Defender for Office 365 protections: The rule for the Standard Preset security policy and the rule for the Strict preset security policy control who the Defender for Office 365 protections in the policy (Safe Links and Safe Attachments) apply to (the recipient conditions and exceptions for Defender for Office 365 protections).
35-
36-
If the command `Get-ATPProtectionPolicyRule | Format-Table Name,State` returns a rule where the State property value is Enabled, you can use this cmdlet to disable the rule. However, the corresponding preset security policy isn't turned off until you also use the Disable-EOPProtectionPolicyRule cmdlet to disable the corresponding rule for EOP protections.
37-
38-
A rule that's associated with Defender for Office 365 protections in the Standard preset security policy or the Strict preset security policy already exists if either of the following statements are true:
39-
40-
- You previously turned on the Standard preset security policy or the Strict preset security policy in the Microsoft 365 Defender portal. Whether it's currently turned on after you initially turned it on doesn't matter (turning off the policy doesn't delete the rule).
41-
- You previously removed the rule using the Remove-ATPProtectionPolicyRule cmdlet, and then you recreated the rule using the New-ATPProtectionPolicyRule cmdlet.
42-
43-
For more information about preset security policies, see [Preset security policies in EOP and Microsoft Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies).
33+
For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell).
4434

4535
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](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
4636

@@ -51,7 +41,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
5141
Disable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"
5242
```
5343

54-
This example turns off the Standard preset security policy. The State value of both rules is now Disabled.
44+
In organizations with Defender for Office 365, this example turns off the Standard preset security policy. The State property value of both rules is now Disabled.
5545

5646
## PARAMETERS
5747

exchange/exchange-ps/exchange/Disable-EOPProtectionPolicyRule.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,9 @@ Disable-EOPProtectionPolicyRule [-Identity] <RuleIdParameter>
2828
```
2929

3030
## DESCRIPTION
31-
All Microsoft 365 organizations can have up to two rules that are associated with Exchange Online Protection (EOP) protections in preset security policies. The rule for the Standard Preset security policy and the rule for the Strict preset security policy controls who the EOP protections in the policy (anti-malware, anti-spam, and anti-phishing) apply to (the recipient conditions and exceptions for EOP protections).
31+
The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled.
3232

33-
In organizations that don't have Defender for Office 365, if the command `Get-EOPProtectionPolicyRule | Format-Table Name,State` returns a rule where the State property value is Enabled, you can use this cmdlet to disable the rule. This action also turns off the corresponding preset security policy.
34-
35-
But, if your organization has Defender for Office 365, there are two more rules that are associated with Defender for Office 365 protections in preset security policies. The rule for the Standard Preset security policy and the rule for the Strict preset security policy control who the Defender for Office 365 protections in the policy (Safe Links and Safe Attachments) apply to (the recipient conditions and exceptions for Defender for Office 365 protections). The corresponding preset security policy isn't turned off until you also use the Disable-AtPProtectionPolicyRule cmdlet to disable the corresponding rule for Defender for Office 365 protections.
36-
37-
A rule that's associated with EOP protections in the Standard preset security policy or the Strict preset security policy already exists if either of the following statements are true:
38-
39-
- You previously turned on the Standard preset security policy or the Strict preset security policy in the Microsoft 365 Defender portal. Whether it's currently turned on after you initially turned it on doesn't matter (turning off the policy doesn't delete the).
40-
- You previously removed the rule using the Remove-EOPProtectionPolicyRule cmdlet, and then you recreated the rule using the New-EOPProtectionPolicyRule cmdlet.
41-
42-
For more information about preset security policies, see [Preset security policies in EOP and Microsoft Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies).
33+
For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell).
4334

4435
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](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
4536

@@ -50,14 +41,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
5041
Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"
5142
```
5243

53-
In organizations without Defender for Office 365, this example turns off the Standard preset security policy. The State value of the rule is now Disabled.
44+
In organizations without Defender for Office 365, this example turns off the Standard preset security policy. The State property value of the rule is now Disabled.
5445

5546
### Example 2
5647
```powershell
5748
Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Disable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"
5849
```
5950

60-
In organizations with Defender for Office 365, this example turns off the Standard preset security policy. The State value of both rules is now Disabled.
51+
In organizations with Defender for Office 365, this example turns off the Standard preset security policy. The State property value of both rules is now Disabled.
6152

6253
## PARAMETERS
6354

exchange/exchange-ps/exchange/Enable-ATPProtectionPolicyRule.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,9 @@ Enable-ATPProtectionPolicyRule [-Identity] <RuleIdParameter>
2828
```
2929

3030
## DESCRIPTION
31-
Organizations with Defender for Office 365 have up to four rules that are associated with the Standard preset security policy and the Strict preset security policy:
31+
The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled.
3232

33-
- Two rules for Exchange Online Protection (EOP) protections: The rule for the Standard Preset security policy and the rule for the Strict preset security policy control who the EOP protections in the policy (anti-malware, anti-spam, and anti-phishing) apply to (the recipient conditions and exceptions for EOP protections).
34-
- Two rules for Defender for Office 365 protections: The rule for the Standard Preset security policy and the rule for the Strict preset security policy control who the Defender for Office 365 protections in the policy (Safe Links and Safe Attachments) apply to (the recipient conditions and exceptions for Defender for Office 365 protections).
35-
36-
If the command `Get-ATPProtectionPolicyRule | Format-Table Name,State` returns a rule where the State value is Disabled, you can use this cmdlet to enable the rule. However, the corresponding preset security policy isn't turned on until you also use the Enable-EOPProtectionPolicyRule cmdlet to enable the corresponding rule.
37-
38-
A rule that's associated with the Defender for Office 365 protections in the Standard preset security policy or the Strict preset security policy exists in organizations with Defender for Office 365 if either of the following statements are true:
39-
40-
- You previously turned on the Standard preset security policy or the Strict preset security policy in the Microsoft 365 Defender portal. Whether it's currently turned on after you initially turned it on doesn't matter.
41-
- You previously removed the rule using the Remove-ATPProtectionPolicyRule cmdlet, and then you recreated the rule using the New-ATPProtectionPolicyRule cmdlet.
42-
43-
For more information about preset security policies, see [Preset security policies in EOP and Microsoft Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies).
33+
For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell).
4434

4535
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](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
4636

@@ -51,7 +41,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
5141
Enable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"
5242
```
5343

54-
This example turns on the Standard preset security policy in the Microsoft 365 Defender portal. The State value of both rules is now Enabled.
44+
In organizations with Defender for Office 365, this example turns on the Standard preset security policy. The State value of both rules is now Enabled.
5545

5646
## PARAMETERS
5747

exchange/exchange-ps/exchange/Enable-EOPProtectionPolicyRule.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.reviewer:
1414
## SYNOPSIS
1515
This cmdlet is available only in the cloud-based service.
1616

17-
Use the Enable-EOPProtectionPolicyRule cmdlet to
17+
Use the Enable-EOPProtectionPolicyRule cmdlet to turn on the Standard preset security policy or the Strict preset security policy. If your organization has Defender for Office 365, you also need to use the Enable-ATPProtectionPolicyRule cmdlet to turn on the policy.
1818

1919
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2020

@@ -28,21 +28,38 @@ Enable-EOPProtectionPolicyRule [-Identity] <RuleIdParameter>
2828
```
2929

3030
## DESCRIPTION
31+
The State property in rules that are associated with preset security policies indicates whether the rule is Enabled or Disabled.
32+
33+
For more information about preset security policies in PowerShell, see [Preset security policies in Exchange Online PowerShell](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies#preset-security-policies-in-exchange-online-powershell).
34+
3135
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](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
3236

3337
## EXAMPLES
3438

3539
### Example 1
3640
```powershell
37-
{{ Add example code here }}
41+
Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"
42+
```
43+
44+
In organizations without Defender for Office 365, this example turns off the Standard preset security policy. The State property value of the rule is now Enabled.
45+
46+
### Example 2
47+
```powershell
48+
Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Enable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"
3849
```
3950

40-
{{ Add example description here }}
51+
In organizations with Defender for Office 365, this example turns off the Standard preset security policy. The State property value of both rules is now Enabled.
4152

4253
## PARAMETERS
4354

4455
### -Identity
45-
{{ Fill Identity Description }}
56+
The Identity parameter specifies the rule that you want to enable. You can use any value that uniquely identifies the rule. For example:
57+
58+
- Name
59+
- Distinguished name (DN)
60+
- GUID
61+
62+
By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy.
4663

4764
```yaml
4865
Type: RuleIdParameter
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
online version: https://docs.microsoft.com/powershell/module/exchange/get-atpbuiltinprotectionrule
4+
applicable: Exchange Online, Exchange Online Protection
5+
title: Get-ATPBuiltInProtectionRule
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-ATPBuiltInProtectionRule
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
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.
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Get-ATPBuiltInProtectionRule [[-Identity] <DehydrateableRuleIdParameter>] [-State <RuleState>] [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
For more information about preset security policies, see [Preset security policies in EOP and Microsoft Defender for Office 365](https://docs.microsoft.com/microsoft-365/security/office-365-security/preset-security-policies).
29+
30+
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](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
```powershell
36+
Get-ATPBuiltInProtectionRule
37+
```
38+
39+
This example shows the rule for the Built-in protection preset security policy.
40+
41+
## PARAMETERS
42+
43+
### -Identity
44+
The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example:
45+
46+
- Name
47+
- Distinguished name (DN)
48+
- GUID
49+
50+
The name of the only rule is ATP Built-In Protection Rule.
51+
52+
```yaml
53+
Type: DehydrateableRuleIdParameter
54+
Parameter Sets: (All)
55+
Aliases:
56+
Applicable: Exchange Online, Exchange Online Protection
57+
58+
Required: False
59+
Position: 0
60+
Default value: None
61+
Accept pipeline input: True (ByPropertyName, ByValue)
62+
Accept wildcard characters: False
63+
```
64+
65+
### -State
66+
The State parameter filters the results by the state of the rule. Valid values are:
67+
68+
- Disabled
69+
- Enabled
70+
71+
The only rule is always enabled.
72+
73+
```yaml
74+
Type: RuleState
75+
Parameter Sets: (All)
76+
Aliases:
77+
Accepted values: Enabled, Disabled
78+
Applicable: Exchange Online, Exchange Online Protection
79+
80+
Required: False
81+
Position: Named
82+
Default value: None
83+
Accept pipeline input: False
84+
Accept wildcard characters: False
85+
```
86+
87+
### CommonParameters
88+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
89+
90+
## INPUTS
91+
92+
###
93+
94+
## OUTPUTS
95+
96+
###
97+
98+
## NOTES
99+
100+
## RELATED LINKS

0 commit comments

Comments
 (0)