Skip to content

Commit cdb96a6

Browse files
authored
Merge pull request #11863 from MicrosoftDocs/QuarAS-chrisda
QuarAS-chrisda to Main
2 parents 9cfef4c + 298e805 commit cdb96a6

File tree

5 files changed

+87
-18
lines changed

5 files changed

+87
-18
lines changed

exchange/exchange-ps/exchange/Get-QuarantineMessage.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Get-QuarantineMessage
3838
[-EndExpiresDate <System.DateTime>]
3939
[-EndReceivedDate <System.DateTime>]
4040
[-EntityType <Microsoft.Exchange.Management.FfoQuarantine.EntityType>]
41+
[-IncludeMessagesFromBlockedSenderAddress]
4142
[-MessageId <String>]
4243
[-MyItems]
4344
[-Page <Int32>]
@@ -214,6 +215,22 @@ Accept pipeline input: False
214215
Accept wildcard characters: False
215216
```
216217
218+
### -IncludeMessagesFromBlockedSenderAddress
219+
The IncludeMessagesFromBlockedSenderAddress switch specifies whether to include quarantined messages from blocked senders in the results. You don't need to specify a value with this switch.
220+
221+
```yaml
222+
Type: SwitchParameter
223+
Parameter Sets: Summary
224+
Aliases:
225+
Applicable: Exchange Online, Security & Compliance, Exchange Online Protection
226+
227+
Required: False
228+
Position: Named
229+
Default value: None
230+
Accept pipeline input: False
231+
Accept wildcard characters: False
232+
```
233+
217234
### -MessageId
218235
The MessageId parameter filters the results by the Message-ID header field of the message. This value is also known as the Client ID. The format of the Message-ID depends on the messaging server that sent the message. The value should be unique for each message. However, not all messaging servers create values for the Message-ID in the same way. Be sure to include the full Message ID string (which may include angle brackets) and enclose the value in quotation marks (for example, `"<d9683b4c-127b-413a-ae2e-fa7dfb32c69d@DM3NAM06BG401.Eop-nam06.prod.protection.outlook.com>"`).
219236

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ 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 EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets.
17+
**Note**: Instead of using this cmdlet to set quarantine policy permissions, we recommend using the EndUserQuarantinePermissionsValue parameter on the New-QuarantinePolicy and Set-QuarantinePolicy cmdlets.
18+
19+
Use the New-QuarantinePermissions cmdlet to create a variable that contains a quarantine permissions object to use with the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets in the same PowerShell session.
1820

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

@@ -47,25 +49,25 @@ $NoAccess = New-QuarantinePermissions
4749

4850
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`.
4951

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

5254
### Example 2
5355
```powershell
54-
$LimitedAccess = New-QuarantinePermissions -PermissionToBlockSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRequestRelease $true
56+
$LimitedAccess = New-QuarantinePermissions -PermissionToAllowSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRequestRelease $true
5557
```
5658

5759
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`.
5860

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

6163
### Example 3
6264
```powershell
63-
$FullAccess = New-QuarantinePermissions -PermissionToBlockSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRelease $true
65+
$FullAccess = New-QuarantinePermissions -PermissionToAllowSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRelease $true
6466
```
6567

6668
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`.
6769

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

7072
## PARAMETERS
7173

exchange/exchange-ps/exchange/New-QuarantinePolicy.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ New-QuarantinePolicy [-Name] <String>
3737
[-EndUserSpamNotificationLanguage <EsnLanguage>]
3838
[-EsnCustomSubject <MultiValuedProperty>]
3939
[-ESNEnabled <Boolean>]
40+
[-IncludeMessagesFromBlockedSenderAddress <Boolean>]
4041
[-MultiLanguageCustomDisclaimer <MultiValuedProperty>]
4142
[-MultiLanguageSenderName <MultiValuedProperty>]
4243
[-MultiLanguageSetting <MultiValuedProperty>]
@@ -194,7 +195,11 @@ Accept wildcard characters: False
194195
```
195196
196197
### -EndUserQuarantinePermissions
197-
This parameter is reserved for internal Microsoft use.
198+
**Note**: To set permissions in quarantine policies, we recommend using the EndUserQuarantinePermissionsValue parameter.
199+
200+
The EndUserQuarantinePermissions specifies the end-user permissions for the quarantine policy by using a variable from the output of a New-QuarantinePermissions or Set-QuarantinePermissions command.
201+
202+
For example, run the following command to store the required permissions in a variable: `$Perms = New-QuarantinePermissions <permissions>`. In the same PowerShell session, use the value `$Perms` for this parameter.
198203

199204
```yaml
200205
Type: QuarantinePermissions
@@ -216,7 +221,7 @@ This parameter uses a decimal value that's converted from a binary value. The bi
216221

217222
- PermissionToViewHeader: The value 0 doesn't hide the **View message header** action in quarantine. If the message is visible in quarantine, the action is always available for the message.
218223
- PermissionToDownload: This permission is not used (the value 0 or 1 does nothing).
219-
- PermissionToAllowSender: This permission is not used (the value 0 or 1 does nothing).
224+
- PermissionToAllowSender
220225
- PermissionToBlockSender
221226
- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0.
222227
- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead.
@@ -226,8 +231,8 @@ This parameter uses a decimal value that's converted from a binary value. The bi
226231
The values for the preset end-user permission groups are described in the following list:
227232

228233
- No access: Binary = 0000000, so use the decimal value 0.
229-
- Limited access: Binary = 00011011, so use the decimal value 27.
230-
- Full access: Binary = 00010111, so use the decimal value 23.
234+
- Limited access: Binary = 00101011, so use the decimal value 43.
235+
- Full access: Binary = 00100111, so use the decimal value 39.
231236

232237
For custom permissions, get the binary value that corresponds to the permissions you want. Convert the binary value to a decimal value to use. Don't use the binary value for this parameter.
233238

@@ -360,6 +365,25 @@ Accept pipeline input: False
360365
Accept wildcard characters: False
361366
```
362367

368+
### -IncludeMessagesFromBlockedSenderAddress
369+
The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send quarantine notifications for quarantined messages from blocked sender addresses. Valid values are:
370+
371+
- $true: Recipients get quarantine notifications for affected messages from blocked senders.
372+
- $false: Recipients don't get quarantine notifications for affected messages from blocked senders. This is the default value.
373+
374+
```yaml
375+
Type: Boolean
376+
Parameter Sets: (All)
377+
Aliases:
378+
Applicable: Exchange Online, Exchange Online Protection
379+
380+
Required: False
381+
Position: Named
382+
Default value: False
383+
Accept pipeline input: False
384+
Accept wildcard characters: False
385+
```
386+
363387
### -MultiLanguageCustomDisclaimer
364388
This parameter is reserved for internal Microsoft use.
365389

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

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

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.
17+
**Note**: Instead of using this cmdlet to set quarantine policy permissions, we recommend using the EndUserQuarantinePermissionsValue parameter on the New-QuarantinePolicy and Set-QuarantinePolicy cmdlets.
18+
19+
Use the Set-QuarantinePermissions cmdlet to modify quarantine permissions objects that were created by the New-QuarantinePermissions and stored as a variable in the current PowerShell session. You use the variable as a value for the EndUserQuarantinePermission parameter on the New-QuarantinePolicy or Set-QuarantinePolicy cmdlets in the same PowerShell session.
1820

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

@@ -45,14 +47,14 @@ You need to be assigned permissions before you can run this cmdlet. Although thi
4547
Set-QuarantinePermissions -QuarantinePermissionsObject $Perms -PermissionToRequestRelease $true -PermissionToRelease $false
4648
```
4749

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).
50+
This example modifies the quarantine policy permissions in the exiting `$Perms` variable that was previously created using the New-QuarantinePermissions cmdlet in the same PowerShell session (the `$Perms` variable is still available and populated).
4951

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

5254
## PARAMETERS
5355

5456
### -QuarantinePermissionsObject
55-
The QuarantinePermissionsObject parameter specifies the variable that contains quarantine permissions object that you want to modify. For example if you ran the command `$Perms = New-QuarantinePermissions <permissions>`, use the value `$Perms` for this parameter.
57+
The QuarantinePermissionsObject parameter specifies the existing variable that contains quarantine permissions that you want to modify. For example if you previously ran the command `$Perms = New-QuarantinePermissions <permissions>`, use the value `$Perms` for this parameter.
5658

5759
```yaml
5860
Type: QuarantinePermissions

exchange/exchange-ps/exchange/Set-QuarantinePolicy.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ Set-QuarantinePolicy [-Identity] <QuarantineTagIdParameter>
3838
[-EsnCustomSubject <MultiValuedProperty>]
3939
[-ESNEnabled <Boolean>]
4040
[-IgnoreDehydratedFlag]
41+
[-IncludeMessagesFromBlockedSenderAddress <Boolean>]
4142
[-MultiLanguageCustomDisclaimer <MultiValuedProperty>]
4243
[-MultiLanguageSenderName <MultiValuedProperty>]
4344
[-MultiLanguageSetting <MultiValuedProperty>]
@@ -212,7 +213,11 @@ Accept wildcard characters: False
212213
```
213214
214215
### -EndUserQuarantinePermissions
215-
This parameter is reserved for internal Microsoft use.
216+
**Note**: To set permissions in quarantine policies, we recommend using the EndUserQuarantinePermissionsValue parameter.
217+
218+
The EndUserQuarantinePermissions specifies the end-user permissions for the quarantine policy by using a variable from the output of a New-QuarantinePermissions or Set-QuarantinePermissions command.
219+
220+
For example, run the following command to store the required permissions in a variable: `$Perms = New-QuarantinePermissions <permissions>`. In the same PowerShell session, use the value `$Perms` for this parameter.
216221

217222
```yaml
218223
Type: QuarantinePermissions
@@ -234,7 +239,7 @@ This parameter uses a decimal value that's converted from a binary value. The bi
234239

235240
- PermissionToViewHeader: The value 0 doesn't hide the **View message header** action in quarantine. If the message is visible in quarantine, the action is always available for the message.
236241
- PermissionToDownload: This permission is not used (the value 0 or 1 does nothing).
237-
- PermissionToAllowSender: This permission is not used (the value 0 or 1 does nothing).
242+
- PermissionToAllowSender
238243
- PermissionToBlockSender
239244
- PermissionToRequestRelease: Don't set this permission and PermissionToRelease to the value 1. Set one value to 1 and the other value to 0, or set both values to 0.
240245
- PermissionToRelease: Don't set this permission and PermissionToRequestRelease to value 1. Set one value to 1 and the other value to 0, or set both values to 0. This permission isn't honored for messages that were quarantined as malware or high confidence phishing. If the quarantine policy gives users this permission, users are allowed to request the release of their quarantined malware or high confidence phishing messages as if PermissionToRequestRelease was selected instead.
@@ -244,8 +249,8 @@ This parameter uses a decimal value that's converted from a binary value. The bi
244249
The values for the preset end-user permission groups are described in the following list:
245250

246251
- No access: Binary = 0000000, so use the decimal value 0.
247-
- Limited access: Binary = 00011011, so use the decimal value 27.
248-
- Full access: Binary = 00010111, so use the decimal value 23.
252+
- Limited access: Binary = 00101011, so use the decimal value 43.
253+
- Full access: Binary = 00100111, so use the decimal value 39.
249254

250255
For custom permissions, get the binary value that corresponds to the permissions you want. Convert the binary value to a decimal value to use. Don't use the binary value for this parameter.
251256

@@ -392,6 +397,25 @@ Accept pipeline input: False
392397
Accept wildcard characters: False
393398
```
394399

400+
### -IncludeMessagesFromBlockedSenderAddress
401+
The IncludeMessagesFromBlockedSenderAddress parameter specifies whether to send quarantine notifications for quarantined messages from blocked sender addresses. Valid values are:
402+
403+
- $true: Recipients get quarantine notifications for affected messages from blocked senders.
404+
- $false: Recipients don't get quarantine notifications for affected messages from blocked senders. This is the default value.
405+
406+
```yaml
407+
Type: Boolean
408+
Parameter Sets: (All)
409+
Aliases:
410+
Applicable: Exchange Online, Exchange Online Protection
411+
412+
Required: False
413+
Position: Named
414+
Default value: False
415+
Accept pipeline input: False
416+
Accept wildcard characters: False
417+
```
418+
395419
### -MultiLanguageCustomDisclaimer
396420
The MultiLanguageCustomDisclaimer parameter specifies the custom disclaimer text to use near the bottom of quarantine notifications. The localized text, **A disclaimer from your organization:** is always included first, followed by the text you specify for this parameter.
397421

0 commit comments

Comments
 (0)