Skip to content

Commit d9e6852

Browse files
committed
Quarantine tag to policy
1 parent bc27b56 commit d9e6852

File tree

6 files changed

+117
-109
lines changed

6 files changed

+117
-109
lines changed

exchange/exchange-ps/exchange/Get-QuarantineTag.md renamed to exchange/exchange-ps/exchange/Get-QuarantinePolicy.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3-
online version: https://docs.microsoft.com/powershell/module/exchange/get-quarantinetag
3+
online version: https://docs.microsoft.com/powershell/module/exchange/get-quarantinepolicy
44
applicable: Exchange Online, Exchange Online Protection
5-
title: Get-QuarantineTag
5+
title: Get-QuarantinePolicy
66
schema: 2.0.0
77
author: chrisda
88
ms.author: chrisda
99
ms.reviewer:
1010
---
1111

12-
# Get-QuarantineTag
12+
# Get-QuarantinePolicy
1313

1414
## SYNOPSIS
1515
This cmdlet is available only in the cloud-based service.
1616

17-
Use the Get-QuarantineTag cmdlet to view quarantine tags in your cloud-based organization.
17+
Use the Get-QuarantinePolicy cmdlet to view quarantine policies in your cloud-based organization.
1818

1919
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
2020

@@ -23,43 +23,43 @@ For information about the parameter sets in the Syntax section below, see [Excha
2323
## SYNTAX
2424

2525
```
26-
Get-QuarantineTag [[-Identity] <QuarantineTagIdParameter>]
27-
[-QuarantineTagType <QuarantineTagTypeEnum>]
26+
Get-QuarantinePolicy [[-Identity] <QuarantineTagIdParameter>]
27+
[-QuarantinePolicyType <QuarantinePolicyTypeEnum>]
2828
[<CommonParameters>]
2929
```
3030

3131
## DESCRIPTION
32-
Quarantine tags allow you to configure the allowed end-user actions on quarantined messages in supported features that quarantine messages.
32+
Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features). For more information, see [Quarantine policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies).
3333

3434
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).
3535

3636
## EXAMPLES
3737

3838
### Example 1
3939
```powershell
40-
Get-QuarantineTag | Format-Table Name
40+
Get-QuarantinePolicy | Format-Table Name
4141
```
4242

43-
This example returns as summary list of all quarantine tags.
43+
This example returns as summary list of all quarantine policies.
4444

4545
### Example 2
4646
```powershell
47-
Get-QuarantineTag -Identity NoAccess
47+
Get-QuarantinePolicy -Identity NoAccess
4848
```
4949

50-
This example returns detailed information about the quarantine tag named NoAccess.
50+
This example returns detailed information about the quarantine policy named NoAccess.
5151

5252
### Example 3
5353
```powershell
54-
Get-QuarantineTag -QuarantineTagType GlobalQuarantineTag
54+
Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy
5555
```
5656

57-
This example returns detailed information about the default quarantine tag named GlobalDefaultTag that controls the global end-user spam notification settings.
57+
This example returns detailed information about the default quarantine policy named GlobalDefaultTag that controls the global quarantine notification (formerly known as end-user spam notification) settings.
5858

5959
## PARAMETERS
6060

6161
### -Identity
62-
The Identity parameter specifies the quarantine tag you want to view. You can use any value that uniquely identifies the quarantine tag. For example:
62+
The Identity parameter specifies the quarantine policy you want to view. You can use any value that uniquely identifies the quarantine policy. For example:
6363

6464
- Name
6565
- Distinguished name (DN)
@@ -78,17 +78,17 @@ Accept pipeline input: True (ByPropertyName, ByValue)
7878
Accept wildcard characters: False
7979
```
8080
81-
### -QuarantineTagType
82-
The QuarantineTagType parameter filters the results by the specified quarantine tag type. Valid values are:
81+
### -QuarantinePolicyType
82+
The QuarantinePolicyType parameter filters the results by the specified quarantine policy type. Valid values are:
8383
84-
- PolicyQuarantineTag: This is the default value, and returns built-in and custom quarantine tags.
85-
- GlobalQuarantineTag: This value is required to return the global settings (end-user quarantine notification settings) in the quarantine tag named GlobalDefaultTag.
84+
- QuarantinePolicy: This is the default value, and returns built-in and custom quarantine policies.
85+
- GlobalQuarantinePolicy: This value is required to return the global settings (quarantine notification settings) in the quarantine policy named GlobalDefaultTag.
8686
8787
```yaml
88-
Type: QuarantineTagTypeEnum
88+
Type: QuarantinePolicyTypeEnum
8989
Parameter Sets: (All)
9090
Aliases:
91-
Accepted values: PolicyQuarantineTag, GlobalQuarantineTag
91+
Accepted values: QuarantinePolicy, GlobalQuarantinePolicy
9292
Applicable: Exchange Online, Exchange Online Protection
9393

9494
Required: False

exchange/exchange-ps/exchange/New-QuarantineTag.md renamed to exchange/exchange-ps/exchange/New-QuarantinePolicy.md

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3-
online version: https://docs.microsoft.com/powershell/module/exchange/new-quarantinetag
3+
online version: https://docs.microsoft.com/powershell/module/exchange/new-quarantinepolicy
44
applicable: Exchange Online, Exchange Online Protection
5-
title: New-QuarantineTag
5+
title: New-QuarantinePolicy
66
schema: 2.0.0
77
author: chrisda
88
ms.author: chrisda
99
ms.reviewer:
1010
---
1111

12-
# New-QuarantineTag
12+
# New-QuarantinePolicy
1313

1414
## SYNOPSIS
1515
This cmdlet is available only in the cloud-based service.
1616

17-
Use the New-QuarantineTag cmdlet to create quarantine tags in your cloud-based organization.
17+
Use the New-QuarantinePolicy cmdlet to create quarantine policies in your cloud-based organization.
1818

1919
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
2020

@@ -23,7 +23,7 @@ For information about the parameter sets in the Syntax section below, see [Excha
2323
## SYNTAX
2424

2525
```
26-
New-QuarantineTag [-Name] <String>
26+
New-QuarantinePolicy [-Name] <String>
2727
[-AdminDisplayName <String>]
2828
[-AdminNotificationFrequencyInDays <Int32>]
2929
[-AdminNotificationLanguage <EsnLanguage>]
@@ -41,41 +41,41 @@ New-QuarantineTag [-Name] <String>
4141
[-MultiLanguageSetting <MultiValuedProperty>]
4242
[-OrganizationBrandingEnabled <Boolean>]
4343
[-QuarantineRetentionDays <Int32>]
44-
[-QuarantineTagType <QuarantineTagTypeEnum>]
44+
[-QuarantinePolicyType <QuarantinePolicyTypeEnum>]
4545
[<CommonParameters>]
4646
```
4747

4848
## DESCRIPTION
49-
Quarantine tags allow you to configure the allowed end-user actions on quarantined messages in supported features that quarantine messages.
49+
Quarantine policies define what users are allowed to do to quarantined messages based on why the message was quarantined (for supported features). For more information, see [Quarantine policies](https://docs.microsoft.com/microsoft-365/security/office-365-security/quarantine-policies).
5050

5151
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).
5252

5353
## EXAMPLES
5454

5555
### Example 1
5656
```powershell
57-
New-QuarantineTag -Name ContosoTag -EndUserQuarantinePermissionsValue 0
57+
New-QuarantinePolicy -Name ContosoTag -EndUserQuarantinePermissionsValue 0
5858
```
5959

60-
This example creates a new quarantine tag named ContosoTag with the same permissions as the No access preset permissions group.
60+
This example creates a new quarantine policy named ContosoTag with the same permissions as the No access preset permissions group.
6161

6262
To assign Limited access permissions, use the value 106. To assign Full access permissions, use the value 236.
6363

6464
### Example 2
6565
```powershell
6666
$LimitedAccess = New-QuarantinePermissions -PermissionToBlockSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRequestRelease $true
6767
68-
New-QuarantineTag -Name LimitedAccess -EndUserQuarantinePermissions $LimitedAccess
68+
New-QuarantinePolicy -Name LimitedAccess -EndUserQuarantinePermissions $LimitedAccess
6969
```
7070

71-
This example creates a new quarantine tag named LimitedAccess with the same permissions as Limited access preset permissions group.
71+
This example creates a new quarantine policy named LimitedAccess with the same permissions as Limited access preset permissions group.
7272

7373
The first command uses the New-QuarantinePermissions cmdlet to store the permissions object in a variable. The second command uses the variable for the value of the EndUserQuarantinePermissions parameter.
7474

7575
## PARAMETERS
7676

7777
### -Name
78-
The Name parameter specifies a unique name for the quarantine tag. If the value contains spaces, enclose the value in quotation marks (").
78+
The Name parameter specifies a unique name for the quarantine policy. If the value contains spaces, enclose the value in quotation marks (").
7979

8080
```yaml
8181
Type: String
@@ -91,7 +91,7 @@ Accept wildcard characters: False
9191
```
9292
9393
### -AdminDisplayName
94-
The AdminDisplayName parameter specifies a description for the quarantine tag. If the value contains spaces, enclose the value in quotation marks (").
94+
The AdminDisplayName parameter specifies a description for the quarantine policy. If the value contains spaces, enclose the value in quotation marks (").
9595
9696
```yaml
9797
Type: String
@@ -203,24 +203,8 @@ Accept pipeline input: False
203203
Accept wildcard characters: False
204204
```
205205
206-
### -ESNEnabled
207-
This parameter is reserved for internal Microsoft use.
208-
209-
```yaml
210-
Type: Boolean
211-
Parameter Sets: (All)
212-
Aliases:
213-
Applicable: Exchange Online, Exchange Online Protection
214-
215-
Required: False
216-
Position: Named
217-
Default value: None
218-
Accept pipeline input: False
219-
Accept wildcard characters: False
220-
```
221-
222206
### -EndUserQuarantinePermissions
223-
The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine tag.
207+
The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy.
224208
225209
A value for this parameter requires the New-QuarantinePermissions cmdlet. Store the results of the New-QuarantinePermissions command in a variable (for example, `$Perms = New-QuarantinePermissions <permissions>`) and then use the variable name (`$Perms`) for this parameter. For more information, see [New-QuarantinePermissions](https://docs.microsoft.com/powershell/module/exchange/new-quarantinepermissions).
226210

@@ -240,7 +224,7 @@ Accept wildcard characters: False
240224
```
241225

242226
### -EndUserQuarantinePermissionsValue
243-
The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine tag.
227+
The EndUserQuarantinePermissionsValue parameter specifies the end-user permissions for the quarantine policy.
244228

245229
This parameter uses a decimal value that's converted from a binary value. The binary value corresponds to the list of available permissions in a specific order. For each permission, the value 1 equals True and the value 0 equals False. The required order is described in the following list:
246230

@@ -309,6 +293,25 @@ Accept pipeline input: False
309293
Accept wildcard characters: False
310294
```
311295

296+
### -ESNEnabled
297+
The ESNEnabled parameter specifies whether to enable quarantine notifications (formerly known as end-user spam notifications) for the policy. Valid values are:
298+
299+
- $true: Quarantine notifications are enabled.
300+
- $false: Quarantine notifications are disabled. User can only access quarantined messages in quarantine, not in email notifications. This is the default value.S
301+
302+
```yaml
303+
Type: Boolean
304+
Parameter Sets: (All)
305+
Aliases:
306+
Applicable: Exchange Online, Exchange Online Protection
307+
308+
Required: False
309+
Position: Named
310+
Default value: None
311+
Accept pipeline input: False
312+
Accept wildcard characters: False
313+
```
314+
312315
### -MultiLanguageCustomDisclaimer
313316
This parameter is reserved for internal Microsoft use.
314317

@@ -389,14 +392,14 @@ Accept pipeline input: False
389392
Accept wildcard characters: False
390393
```
391394

392-
### -QuarantineTagType
395+
### -QuarantinePolicyType
393396
This parameter is reserved for internal Microsoft use.
394397

395398
```yaml
396-
Type: QuarantineTagTypeEnum
399+
Type: QuarantinePolicyTypeEnum
397400
Parameter Sets: (All)
398401
Aliases:
399-
Accepted values: PolicyQuarantineTag, GlobalQuarantineTag
402+
Accepted values: QuarantinePolicy, GlobalQuarantinePolicy
400403
Applicable: Exchange Online, Exchange Online Protection
401404
402405
Required: False

exchange/exchange-ps/exchange/Remove-QuarantineTag.md renamed to exchange/exchange-ps/exchange/Remove-QuarantinePolicy.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3-
online version: https://docs.microsoft.com/powershell/module/exchange/remove-quarantinetag
3+
online version: https://docs.microsoft.com/powershell/module/exchange/remove-quarantinepolicy
44
applicable: Exchange Online, Exchange Online Protection
5-
title: Remove-QuarantineTag
5+
title: Remove-QuarantinePolicy
66
schema: 2.0.0
77
author: chrisda
88
ms.author: chrisda
99
ms.reviewer:
1010
---
1111

12-
# Remove-QuarantineTag
12+
# Remove-QuarantinePolicy
1313

1414
## SYNOPSIS
1515
This cmdlet is available only in the cloud-based service.
1616

17-
Use the Remove-QuarantineTag cmdlet to remove custom quarantine tags from your cloud-based organization.
17+
Use the Remove-QuarantinePolicy cmdlet to remove custom quarantine policies from your cloud-based organization.
1818

1919
**Note**: We recommend that you use the Exchange Online PowerShell V2 module to connect to Exchange Online PowerShell. For instructions, see [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/connect-to-exchange-online-powershell).
2020

@@ -23,29 +23,29 @@ For information about the parameter sets in the Syntax section below, see [Excha
2323
## SYNTAX
2424

2525
```
26-
Remove-QuarantineTag [-Identity] <QuarantineTagIdParameter>
26+
Remove-QuarantinePolicy [-Identity] <QuarantineTagIdParameter>
2727
[-DomainController <Fqdn>]
2828
[<CommonParameters>]
2929
```
3030

3131
## DESCRIPTION
32-
You can't remove built-in quarantine tags that start with "Default" in the name.
32+
You can't remove the built-in quarantine policies named AdminOnlyAccessPolicy or DefaultFullAccessPolicy.
3333

3434
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).
3535

3636
## EXAMPLES
3737

3838
### Example 1
3939
```powershell
40-
Remove-QuarantineTag -Identity "Contoso Engineering"
40+
Remove-QuarantinePolicy -Identity "Contoso Engineering"
4141
```
4242

43-
This example removes the quarantine tag named Contoso Engineering.
43+
This example removes the quarantine policy named Contoso Engineering.
4444

4545
## PARAMETERS
4646

4747
### -Identity
48-
The Identity parameter specifies the quarantine tag you want to remove. You can use any value that uniquely identifies the quarantine tag. For example:
48+
The Identity parameter specifies the quarantine policy you want to remove. You can use any value that uniquely identifies the quarantine policy. For example:
4949

5050
- Name
5151
- Distinguished name (DN)

0 commit comments

Comments
 (0)