Skip to content

Commit 0f90c79

Browse files
committed
ATOP/EOPProtectionPolicyRule cmdlet updates
1 parent 82bc0cc commit 0f90c79

12 files changed

+228
-114
lines changed

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

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

17-
Use the Disable-ATPProtectionPolicyRule cmdlet to
18-
19-
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Use the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
17+
Use the Disable-ATPProtectionPolicyRule and Disable-EOPProtectionPolicyRule cmdlets together to turn off the Standard preset security policy or the Strict preset security policy in organizations with Microsoft Defender for Office 365.
2018

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

@@ -30,21 +28,41 @@ Disable-ATPProtectionPolicyRule [-Identity] <RuleIdParameter>
3028
```
3129

3230
## 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:
32+
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.
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).
44+
3345
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).
3446

3547
## EXAMPLES
3648

3749
### Example 1
3850
```powershell
39-
{{ Add example code here }}
51+
Disable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"
4052
```
4153

42-
{{ Add example description here }}
54+
This example turns off the Standard preset security policy. The State value of both rules is now Disabled.
4355

4456
## PARAMETERS
4557

4658
### -Identity
47-
{{ Fill Identity Description }}
59+
The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example:
60+
61+
- Name
62+
- Distinguished name (DN)
63+
- GUID
64+
65+
By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy.
4866

4967
```yaml
5068
Type: RuleIdParameter
@@ -99,12 +117,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
99117
100118
## INPUTS
101119
102-
###
103-
104120
## OUTPUTS
105121
106-
###
107-
108122
## NOTES
109123
110124
## RELATED LINKS

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

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

17-
Use the Disable-EOPProtectionPolicyRule cmdlet to
18-
19-
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Use the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
17+
Use the Disable-EOPProtectionPolicyRule cmdlet to turn off 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 Disable-ATPProtectionPolicyRule cmdlet to turn off the policy.
2018

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

@@ -30,21 +28,47 @@ Disable-EOPProtectionPolicyRule [-Identity] <RuleIdParameter>
3028
```
3129

3230
## 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).
32+
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.
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).
43+
3344
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).
3445

3546
## EXAMPLES
3647

3748
### Example 1
3849
```powershell
39-
{{ Add example code here }}
50+
Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"
4051
```
4152

42-
{{ Add example description here }}
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.
54+
55+
### Example 2
56+
```powershell
57+
Disable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Disable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"
58+
```
59+
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.
4361

4462
## PARAMETERS
4563

4664
### -Identity
47-
{{ Fill Identity Description }}
65+
The Identity parameter specifies the rule that you want to disable. You can use any value that uniquely identifies the rule. For example:
66+
67+
- Name
68+
- Distinguished name (DN)
69+
- GUID
70+
71+
By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy.
4872

4973
```yaml
5074
Type: RuleIdParameter
@@ -99,12 +123,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
99123
100124
## INPUTS
101125
102-
###
103-
104126
## OUTPUTS
105127
106-
###
107-
108128
## NOTES
109129
110130
## RELATED LINKS

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

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

17-
Use the Enable-ATPProtectionPolicyRule cmdlet to
18-
19-
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Use the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
17+
Use the Enable-ATPProtectionPolicyRule and Enable-EOPProtectionPolicyRule cmdlets together to turn on the Standard preset security policy or the Strict preset security policy in organizations with Microsoft Defender for Office 365.
2018

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

@@ -30,21 +28,41 @@ Enable-ATPProtectionPolicyRule [-Identity] <RuleIdParameter>
3028
```
3129

3230
## 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:
32+
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).
44+
3345
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).
3446

3547
## EXAMPLES
3648

3749
### Example 1
3850
```powershell
39-
{{ Add example code here }}
51+
Enable-ATPProtectionPolicyRule -Identity "Standard Preset Security Policy"; Enable-EOPProtectionPolicyRule -Identity "Standard Preset Security Policy"
4052
```
4153

42-
{{ Add example description here }}
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.
4355

4456
## PARAMETERS
4557

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

4967
```yaml
5068
Type: RuleIdParameter
@@ -99,12 +117,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
99117
100118
## INPUTS
101119
102-
###
103-
104120
## OUTPUTS
105121
106-
###
107-
108122
## NOTES
109123
110124
## RELATED LINKS

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ This cmdlet is available only in the cloud-based service.
1616

1717
Use the Enable-EOPProtectionPolicyRule cmdlet to
1818

19-
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Use the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
20-
2119
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2220

2321
## SYNTAX
@@ -99,12 +97,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9997
10098
## INPUTS
10199
102-
###
103-
104100
## OUTPUTS
105101
106-
###
107-
108102
## NOTES
109103
110104
## RELATED LINKS

exchange/exchange-ps/exchange/Get-ATPProtectionPolicyRule.md

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

17-
Use the Get-ATPProtectionPolicyRule cmdlet to
18-
19-
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Use the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
17+
Use the Get-ATPProtectionPolicyRule cmdlet to view rules that are associated with Microsoft Defender for Office 365 protections in preset security policies.
2018

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

@@ -29,21 +27,46 @@ Get-ATPProtectionPolicyRule [[-Identity] <RuleIdParameter>]
2927
```
3028

3129
## DESCRIPTION
30+
In organizations with Microsoft Defender for Office 365, the Standard preset security policy and the Strict preset security policy each have a rule that's associated with Defender for Office 365 protections. These rules are available to this cmdlet and control the following settings:
31+
32+
- Recipient conditions and exceptions that specify who the Defender for Office 365 protections in the policy (Safe Links and Safe Attachments) apply to. If the conditions and exceptions are blank, then no restrictions are placed on who the Defender for Office 365 protections in the policy apply to.
33+
- Whether the preset security policy is turned on or turned off (the State property value). To completely turn on or turn off the preset security policy, the State property value in the corresponding Exchange Online Protection (EOP) rule must match the State value of this rule (Enabled or Disabled).
34+
35+
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:
36+
37+
- 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.
38+
- You previously removed the rule using the Remove-ATPProtectionPolicyRule cmdlet, and then you recreated the rule using the New-ATPProtectionPolicyRule cmdlet.
39+
40+
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).
41+
3242
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).
3343

3444
## EXAMPLES
3545

3646
### Example 1
3747
```powershell
38-
{{ Add example code here }}
48+
Get-ATPProtectionPolicyRule | Format-Table Name,State
3949
```
4050

41-
{{ Add example description here }}
51+
This example returns a summary list of the rules that are associated with Defender for Office 365 protections in preset security policies.
52+
53+
### Example 2
54+
```powershell
55+
Get-ATPProtectionPolicyRule -Identity "Strict Preset Security Policy"
56+
```
57+
58+
This example returns detailed information about the rule named Strict Preset Security Policy.
4259

4360
## PARAMETERS
4461

4562
### -Identity
46-
{{ Fill Identity Description }}
63+
The Identity parameter specifies the rule that you want to view. You can use any value that uniquely identifies the rule. For example:
64+
65+
- Name
66+
- Distinguished name (DN)
67+
- GUID
68+
69+
By default, the available rules (if they exist) are named Standard Preset Security Policy and Strict Preset Security Policy.
4770

4871
```yaml
4972
Type: RuleIdParameter
@@ -59,7 +82,10 @@ Accept wildcard characters: False
5982
```
6083
6184
### -State
62-
The State parameter filters the results by the state of the rule. Valid values are Enabled and Disabled.
85+
The State parameter filters the results by the state of the rule. Valid values are:
86+
87+
- Enabled
88+
- Disabled
6389
6490
```yaml
6591
Type: RuleState
@@ -80,12 +106,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
80106
81107
## INPUTS
82108
83-
###
84-
85109
## OUTPUTS
86110
87-
###
88-
89111
## NOTES
90112
91113
## RELATED LINKS

exchange/exchange-ps/exchange/Get-EOPProtectionPolicyRule.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ This cmdlet is available only in the cloud-based service.
1616

1717
Use the Get-EOPProtectionPolicyRule cmdlet to
1818

19-
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Use the Exchange Online PowerShell V2 module](https://docs.microsoft.com/powershell/exchange/exchange-online-powershell-v2).
20-
2119
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
2220

2321
## SYNTAX
@@ -80,12 +78,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
8078
8179
## INPUTS
8280
83-
###
84-
8581
## OUTPUTS
8682
87-
###
88-
8983
## NOTES
9084
9185
## RELATED LINKS

0 commit comments

Comments
 (0)