Skip to content

Commit 31bcf6a

Browse files
authored
Merge pull request MicrosoftDocs#11822 from MicrosoftDocs/chrisda
Quarantine permission updates
2 parents 390cbaf + 28f1d7c commit 31bcf6a

File tree

2 files changed

+41
-35
lines changed

2 files changed

+41
-35
lines changed

exchange/exchange-ps/exchange/New-QuarantinePermissions.md

Lines changed: 21 additions & 18 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 New-QuarantinePermissions cmdlet to create quarantine permissions objects to use with the New-QuarantinePolicy cmdlet.
17+
Use the New-QuarantinePermissions cmdlet to create quarantine permissions objects to use with the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets.
1818

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

@@ -45,7 +45,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
4545
$NoAccess = New-QuarantinePermissions
4646
```
4747

48-
This example creates the same permissions that are used by the No access permissions group in quarantine tags in the Security & Compliance. The permissions object is stored in the variable named `$NoAccess`.
48+
This example creates the same permissions that are used by the No access permissions group in quarantine policies. The permissions object is stored in the variable named `$NoAccess`.
4949

5050
In the same Windows PowerShell session, you can use `$NoAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command.
5151

@@ -54,7 +54,7 @@ In the same Windows PowerShell session, you can use `$NoAccess` for the _EndUser
5454
$LimitedAccess = New-QuarantinePermissions -PermissionToBlockSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRequestRelease $true
5555
```
5656

57-
This example creates the same permissions that are used by the Limited access permissions group in quarantine tags in the Security & Compliance. The permissions object is stored in the variable named `$LimitedAccess`.
57+
This example creates the same permissions that are used by the Limited access permissions group in quarantine policies. The permissions object is stored in the variable named `$LimitedAccess`.
5858

5959
In the same Windows PowerShell session, you can use `$LimitedAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command.
6060

@@ -63,14 +63,17 @@ In the same Windows PowerShell session, you can use `$LimitedAccess` for the _En
6363
$FullAccess = New-QuarantinePermissions -PermissionToBlockSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRelease $true
6464
```
6565

66-
This example creates the same permissions that are used by the Full access permissions group in quarantine tags in the Security & Compliance. The permissions object is stored in the variable named `$FullAccess`.
66+
This example creates the same permissions that are used by the Full access permissions group in quarantine policies. The permissions object is stored in the variable named `$FullAccess`.
6767

6868
In the same Windows PowerShell session, you can use `$FullAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command.
6969

7070
## PARAMETERS
7171

7272
### -PermissionToAllowSender
73-
{{ Fill PermissionToAllowSender Description }}
73+
The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are:
74+
75+
- $true: Allow sender is available for affected messages in quarantine.
76+
- $false: Allow sender isn't available for affected messages in quarantine. This is the default value.
7477

7578
```yaml
7679
Type: Boolean
@@ -88,8 +91,8 @@ Accept wildcard characters: False
8891
### -PermissionToBlockSender
8992
The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are:
9093
91-
- $true: The Block sender button is included in end-user quarantine notifications.
92-
- $false: The Block sender button is not included in end-user quarantine notifications. This is the default value.
94+
- $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine.
95+
- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This is the default value.
9396
9497
```yaml
9598
Type: Boolean
@@ -107,8 +110,8 @@ Accept wildcard characters: False
107110
### -PermissionToDelete
108111
The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are:
109112
110-
- $true: The Remove from quarantine button is included in the quarantined message details.
111-
- $false: The Remove from quarantine button is not included in the quarantined message details. This is the default value.
113+
- $true: Delete messages and Delete from quarantine are available for affected messages in quarantine.
114+
- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This is the default value.
112115
113116
```yaml
114117
Type: Boolean
@@ -129,7 +132,7 @@ The PermissionToDownload parameter specifies whether users are allowed to downlo
129132
- $true: The permission is enabled.
130133
- $false: The permission is disabled. This is the default value.
131134
132-
Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details.
135+
Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. End-users can't download quarantined messages.
133136
134137
```yaml
135138
Type: Boolean
@@ -147,8 +150,8 @@ Accept wildcard characters: False
147150
### -PermissionToPreview
148151
The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are:
149152
150-
- $true: The Preview message button is included in the quarantined message details.
151-
- $false: The Preview message button is not included in the quarantined message details. This is the default value.
153+
- $true: Preview message is available for affected messages in quarantine.
154+
- $false: Preview message isn't available for affected messages in quarantine. This is the default value.
152155
153156
```yaml
154157
Type: Boolean
@@ -164,10 +167,10 @@ Accept wildcard characters: False
164167
```
165168
166169
### -PermissionToRelease
167-
The PermissionToRelease parameter specifies whether users are allowed to directly release messages from quarantine. Valid values are:
170+
The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are:
168171
169-
- $true: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details.
170-
- $false: The Release button is not included in end-user spam notifications, and the Release message button is not included in the quarantined message details. This is the default value.
172+
- $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine.
173+
- $false: Release message isn't available in quarantine notifications for affected messages, and Release and Release email aren't available for affected messages in quarantine.
171174
172175
Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false.
173176
@@ -187,8 +190,8 @@ Accept wildcard characters: False
187190
### -PermissionToRequestRelease
188191
The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are:
189192
190-
- $true: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details.
191-
- $false: The Release button is not included in end-user spam notifications, and the Release message button is not included in the quarantined message details. This is the default value.
193+
- $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine.
194+
- $false: Request Release isn't available in quarantine notifications for affected messages, and Request release isn't available for affected messages in quarantine.
192195
193196
Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false.
194197
@@ -211,7 +214,7 @@ The PermissionToViewHeader parameter specifies whether users are allowed to view
211214
- $true: The permission is enabled.
212215
- $false: The permission is disabled. This is the default value.
213216
214-
Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details. The View message header button is always available in the quarantined message details.
217+
Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. View message header is always available for affected messages in quarantine.
215218
216219
```yaml
217220
Type: Boolean

exchange/exchange-ps/exchange/Set-QuarantinePermissions.md

Lines changed: 20 additions & 17 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 Set-QuarantinePermissions cmdlet to modify quarantine permissions objects that are used in quarantine tags (the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets). This cmdlet only works on permissions objects that were created by the New-QuarantinePermissions cmdlet and stored in a variable that's currently available in the Windows PowerShell session.
17+
Use the New-QuarantinePermissions cmdlet to modify quarantine permissions objects to use with the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets. This cmdlet works only on a permission object that was created by the New-QuarantinePermissions cmdlet and stored in a variable that's currently available in the Windows PowerShell session.
1818

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

@@ -34,7 +34,7 @@ Set-QuarantinePermissions -QuarantinePermissionsObject <QuarantinePermissions>
3434
```
3535

3636
## DESCRIPTION
37-
To see the current value of the permissions object that you want to modify, run the variable name as a command. For example, run the command `$Perms` to see the quarantine tag permissions stored in the `$Perms` variable.
37+
To see the current value of the permissions object that you want to modify, run the variable name as a command. For example, run the command `$Perms` to see the quarantine policy permissions stored in the `$Perms` variable.
3838

3939
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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
4040

@@ -45,7 +45,7 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
4545
Set-QuarantinePermissions -QuarantinePermissionsObject $Perms -PermissionToRequestRelease $true -PermissionToRelease $false
4646
```
4747

48-
This example modifies the specified quarantine tag permissions in the exiting `$Perms` permissions object that was created previously in the same Windows PowerShell session (the `$Perms` variable is still available and populated).
48+
This example modifies the specified quarantine policy permissions in the exiting `$Perms` permissions object that was created previously in the same Windows PowerShell session (the `$Perms` variable is still available and populated).
4949

5050
In the same Windows PowerShell session, you can use `$Perms` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantinePolicy or Set-QuarantinePolicy command.
5151

@@ -68,7 +68,10 @@ Accept wildcard characters: False
6868
```
6969
7070
### -PermissionToAllowSender
71-
{{ Fill PermissionToAllowSender Description }}
71+
The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are:
72+
73+
- $true: Allow sender is available for affected messages in quarantine.
74+
- $false: Allow sender isn't available for affected messages in quarantine. This is the default value.
7275
7376
```yaml
7477
Type: Boolean
@@ -86,8 +89,8 @@ Accept wildcard characters: False
8689
### -PermissionToBlockSender
8790
The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are:
8891
89-
- $true: The Block sender button is included in end-user quarantine notifications.
90-
- $false: The Block sender button is not included in end-user quarantine notifications. This is the default value.
92+
- $true: Block sender is available in quarantine notifications for affected messages, and Block sender is available for affected messages in quarantine.
93+
- $false: Block sender isn't available in quarantine notifications for affected messages, and Block sender isn't available for affected messages in quarantine. This is the default value.
9194
9295
```yaml
9396
Type: Boolean
@@ -105,8 +108,8 @@ Accept wildcard characters: False
105108
### -PermissionToDelete
106109
The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are:
107110
108-
- $true: The Remove from quarantine button is included in the quarantined message details.
109-
- $false: The Remove from quarantine button is not included in the quarantined message details. This is the default value.
111+
- $true: Delete messages and Delete from quarantine are available for affected messages in quarantine.
112+
- $false: Delete messages and Delete from quarantine aren't available for affected messages in quarantine. This is the default value.
110113
111114
```yaml
112115
Type: Boolean
@@ -127,7 +130,7 @@ The PermissionToDownload parameter specifies whether users are allowed to downlo
127130
- $true: The permission is enabled.
128131
- $false: The permission is disabled. This is the default value.
129132
130-
Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details.
133+
Currently, this value has no effect on the available actions in quarantine notifications or quarantine for affected messages. End-users can't download quarantined messages.
131134
132135
```yaml
133136
Type: Boolean
@@ -145,8 +148,8 @@ Accept wildcard characters: False
145148
### -PermissionToPreview
146149
The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are:
147150
148-
- $true: The Preview message button is included in the quarantined message details.
149-
- $false: The Preview message button is not included in the quarantined message details. This is the default value.
151+
- $true: Preview message is available for affected messages in quarantine.
152+
- $false: Preview message isn't available for affected messages in quarantine. This is the default value.
150153
151154
```yaml
152155
Type: Boolean
@@ -162,10 +165,10 @@ Accept wildcard characters: False
162165
```
163166
164167
### -PermissionToRelease
165-
The PermissionToRelease parameter specifies whether users are allowed to directly release messages from quarantine. Valid values are:
168+
The PermissionToRelease parameter specifies whether users are allowed to directly release affected messages from quarantine. Valid values are:
166169
167-
- $true: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details.
168-
- $false: The Release button is not included in end-user spam notifications, and the Release message button is not included in the quarantined message details. This is the default value.
170+
- $true: Release is available in quarantine notifications for affected messages, and Release (Release email) is available for affected messages in quarantine.
171+
- $false: Release message isn't available in quarantine notifications for affected messages, and Release and Release email aren't available for affected messages in quarantine.
169172
170173
Don't set this parameter and the _PermissionToRequestRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false.
171174
@@ -185,8 +188,8 @@ Accept wildcard characters: False
185188
### -PermissionToRequestRelease
186189
The PermissionToRequestRelease parameter specifies whether users are allowed to request messages to be released from quarantine. The request must be approved by an admin. Valid values are:
187190
188-
- $true: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details.
189-
- $false: The Release button is not included in end-user spam notifications, and the Release message button is not included in the quarantined message details. This is the default value.
191+
- $true: Request Release is available in quarantine notifications for affected messages, and Request release is available for affected messages in quarantine.
192+
- $false: Request Release isn't available in quarantine notifications for affected messages, and Request release isn't available for affected messages in quarantine.
190193
191194
Don't set this parameter and the _PermissionRelease_ parameter to $true. Set one parameter to $true and the other to $false, or set both parameters to $false.
192195
@@ -209,7 +212,7 @@ The PermissionToViewHeader parameter specifies whether users are allowed to view
209212
- $true: The permission is enabled.
210213
- $false: The permission is disabled. This is the default value.
211214
212-
Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details. The View message header button is always available in the quarantined message details.
215+
Currently, this value has no effect on available actions in quarantine notifications or quarantine for affected messages. View message header is always available for affected messages in quarantine.
213216
214217
```yaml
215218
Type: Boolean

0 commit comments

Comments
 (0)