Skip to content

Commit 71f231c

Browse files
chrisdachrisda
authored
Merge branch 'master' into aljupudi-5443986-ExchangeServer
2 parents b0a1c1e + 562ac26 commit 71f231c

10 files changed

+1866
-14
lines changed

‎exchange/exchange-ps/exchange/Get-QuarantinePolicy.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
online version: https://docs.microsoft.com/powershell/module/exchange/get-quarantinepolicy
4+
applicable: Exchange Online, Exchange Online Protection
5+
title: Get-QuarantinePolicy
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-QuarantinePolicy
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Get-QuarantinePolicy cmdlet to view quarantine policies in your cloud-based organization.
18+
19+
**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).
20+
21+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
22+
23+
## SYNTAX
24+
25+
```
26+
Get-QuarantinePolicy [[-Identity] <QuarantineTagIdParameter>]
27+
[-QuarantinePolicyType <QuarantinePolicyTypeEnum>]
28+
[<CommonParameters>]
29+
```
30+
31+
## DESCRIPTION
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).
33+
34+
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).
35+
36+
## EXAMPLES
37+
38+
### Example 1
39+
```powershell
40+
Get-QuarantinePolicy | Format-Table Name
41+
```
42+
43+
This example returns as summary list of all quarantine policies.
44+
45+
### Example 2
46+
```powershell
47+
Get-QuarantinePolicy -Identity NoAccess
48+
```
49+
50+
This example returns detailed information about the quarantine policy named NoAccess.
51+
52+
### Example 3
53+
```powershell
54+
Get-QuarantinePolicy -QuarantinePolicyType GlobalQuarantinePolicy
55+
```
56+
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.
58+
59+
## PARAMETERS
60+
61+
### -Identity
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:
63+
64+
- Name
65+
- Distinguished name (DN)
66+
- GUID
67+
68+
```yaml
69+
Type: QuarantineTagIdParameter
70+
Parameter Sets: (All)
71+
Aliases:
72+
Applicable: Exchange Online, Exchange Online Protection
73+
74+
Required: False
75+
Position: 0
76+
Default value: None
77+
Accept pipeline input: True (ByPropertyName, ByValue)
78+
Accept wildcard characters: False
79+
```
80+
81+
### -QuarantinePolicyType
82+
The QuarantinePolicyType parameter filters the results by the specified quarantine policy type. Valid values are:
83+
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.
86+
87+
```yaml
88+
Type: QuarantinePolicyTypeEnum
89+
Parameter Sets: (All)
90+
Aliases:
91+
Accepted values: QuarantinePolicy, GlobalQuarantinePolicy
92+
Applicable: Exchange Online, Exchange Online Protection
93+
94+
Required: False
95+
Position: Named
96+
Default value: None
97+
Accept pipeline input: False
98+
Accept wildcard characters: False
99+
```
100+
101+
### CommonParameters
102+
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).
103+
104+
## INPUTS
105+
106+
###
107+
108+
## OUTPUTS
109+
110+
###
111+
112+
## NOTES
113+
114+
## RELATED LINKS

‎exchange/exchange-ps/exchange/New-HostedContentFilterPolicy.md

Lines changed: 122 additions & 6 deletions
Large diffs are not rendered by default.

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

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,249 @@
1+
---
2+
external help file: Microsoft.Exchange.TransportMailflow-Help.xml
3+
online version: https://docs.microsoft.com/powershell/module/exchange/new-quarantinepermissions
4+
applicable: Exchange Online, Exchange Online Protection
5+
title: New-QuarantinePermissions
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# New-QuarantinePermissions
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the New-QuarantinePermissions cmdlet to create quarantine permissions objects to use with the New-QuarantineTag cmdlet.
18+
19+
**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).
20+
21+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://docs.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
22+
23+
## SYNTAX
24+
25+
```
26+
New-QuarantinePermissions
27+
[-PermissionToAllowSender <Boolean>]
28+
[-PermissionToBlockSender <Boolean>]
29+
[-PermissionToDelete <Boolean>]
30+
[-PermissionToDownload <Boolean>]
31+
[-PermissionToPreview <Boolean>]
32+
[-PermissionToRelease <Boolean>]
33+
[-PermissionToRequestRelease <Boolean>]
34+
[-PermissionToViewHeader <Boolean>]
35+
[<CommonParameters>]
36+
```
37+
38+
## DESCRIPTION
39+
The default value for any parameters that you don't use is $false, so you only need to use parameters (permissions) that you want to set to $true.
40+
41+
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).
42+
43+
## EXAMPLES
44+
45+
### Example 1
46+
```powershell
47+
$NoAccess = New-QuarantinePermissions
48+
```
49+
50+
This example creates the same permissions that are used by the No access permissions group in quarantine tags in the Security & Compliance Center. The permissions object is stored in the variable named `$NoAccess`.
51+
52+
In the same Windows PowerShell session, you can use `$NoAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantineTag or Set-QuarantineTag command.
53+
54+
### Example 2
55+
```powershell
56+
$LimitedAccess = New-QuarantinePermissions -PermissionToBlockSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRequestRelease $true
57+
```
58+
59+
This example creates the same permissions that are used by the Limited access permissions group in quarantine tags in the Security & Compliance Center. The permissions object is stored in the variable named `$LimitedAccess`.
60+
61+
In the same Windows PowerShell session, you can use `$LimitedAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantineTag or Set-QuarantineTag command.
62+
63+
### Example 3
64+
```powershell
65+
$FullAccess = New-QuarantinePermissions -PermissionToAllowSender $true -PermissionToBlockSender $true -PermissionToDelete $true -PermissionToPreview $true -PermissionToRelease $true
66+
```
67+
68+
This example creates the same permissions that are used by the Full access permissions group in quarantine tags in the Security & Compliance Center. The permissions object is stored in the variable named `$FullAccess`.
69+
70+
In the same Windows PowerShell session, you can use `$FullAccess` for the _EndUserQuarantinePermissions_ parameter value in a New-QuarantineTag or Set-QuarantineTag command.
71+
72+
## PARAMETERS
73+
74+
### -PermissionToAllowSender
75+
The PermissionToAllowSender parameter specifies whether users are allowed to add the quarantined message sender to their Safe Senders list. Valid values are:
76+
77+
- $true: The permission is enabled.
78+
- $false: The permission is disabled. This is the default value.
79+
80+
Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details.
81+
82+
```yaml
83+
Type: Boolean
84+
Parameter Sets: (All)
85+
Aliases:
86+
Applicable: Exchange Online, Exchange Online Protection
87+
88+
Required: False
89+
Position: Named
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### -PermissionToBlockSender
96+
The PermissionToBlockSender parameter specifies whether users are allowed to add the quarantined message sender to their Blocked Senders list. Valid values are:
97+
98+
- $true: The Block sender button is included in end-user quarantine notifications.
99+
- $false: The Block sender button is not included in end-user quarantine notifications. This is the default value.
100+
101+
```yaml
102+
Type: Boolean
103+
Parameter Sets: (All)
104+
Aliases:
105+
Applicable: Exchange Online, Exchange Online Protection
106+
107+
Required: False
108+
Position: Named
109+
Default value: None
110+
Accept pipeline input: False
111+
Accept wildcard characters: False
112+
```
113+
114+
### -PermissionToDelete
115+
The PermissionToDelete parameter specifies whether users are allowed to delete messages from quarantine. Valid values are:
116+
117+
- $true: The Remove from quarantine button is included in the quarantined message details.
118+
- $false: The Remove from quarantine button is not included in the quarantined message details. This is the default value.
119+
120+
```yaml
121+
Type: Boolean
122+
Parameter Sets: (All)
123+
Aliases:
124+
Applicable: Exchange Online, Exchange Online Protection
125+
126+
Required: False
127+
Position: Named
128+
Default value: None
129+
Accept pipeline input: False
130+
Accept wildcard characters: False
131+
```
132+
133+
### -PermissionToDownload
134+
The PermissionToDownload parameter specifies whether users are allowed to download messages from quarantine. Valid values are:
135+
136+
- $true: The permission is enabled.
137+
- $false: The permission is disabled. This is the default value.
138+
139+
Currently, this value has no effect on the buttons that are included in end-user spam notifications or in quarantined message details.
140+
141+
```yaml
142+
Type: Boolean
143+
Parameter Sets: (All)
144+
Aliases:
145+
Applicable: Exchange Online, Exchange Online Protection
146+
147+
Required: False
148+
Position: Named
149+
Default value: None
150+
Accept pipeline input: False
151+
Accept wildcard characters: False
152+
```
153+
154+
### -PermissionToPreview
155+
The PermissionToPreview parameter specifies whether users are allowed to preview quarantined messages. Valid values are:
156+
157+
- $true: The Preview message button is included in the quarantined message details.
158+
- $false: The Preview message button is not included in the quarantined message details. This is the default value.
159+
160+
```yaml
161+
Type: Boolean
162+
Parameter Sets: (All)
163+
Aliases:
164+
Applicable: Exchange Online, Exchange Online Protection
165+
166+
Required: False
167+
Position: Named
168+
Default value: None
169+
Accept pipeline input: False
170+
Accept wildcard characters: False
171+
```
172+
173+
### -PermissionToRelease
174+
The PermissionToRelease parameter specifies whether users are allowed to directly release messages from quarantine. Valid values are:
175+
176+
- $true: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details.
177+
- $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.
178+
179+
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.
180+
181+
```yaml
182+
Type: Boolean
183+
Parameter Sets: (All)
184+
Aliases:
185+
Applicable: Exchange Online, Exchange Online Protection
186+
187+
Required: False
188+
Position: Named
189+
Default value: None
190+
Accept pipeline input: False
191+
Accept wildcard characters: False
192+
```
193+
194+
### -PermissionToRequestRelease
195+
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:
196+
197+
- $true: The Release button is included in end-user spam notifications, and the Release message button is included in the quarantined message details.
198+
- $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.
199+
200+
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.
201+
202+
```yaml
203+
Type: Boolean
204+
Parameter Sets: (All)
205+
Aliases:
206+
Applicable: Exchange Online, Exchange Online Protection
207+
208+
Required: False
209+
Position: Named
210+
Default value: None
211+
Accept pipeline input: False
212+
Accept wildcard characters: False
213+
```
214+
215+
### -PermissionToViewHeader
216+
The PermissionToViewHeader parameter specifies whether users are allowed to view the message headers of quarantined messages. Valid values are:
217+
218+
- $true: The permission is enabled.
219+
- $false: The permission is disabled. This is the default value.
220+
221+
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.
222+
223+
```yaml
224+
Type: Boolean
225+
Parameter Sets: (All)
226+
Aliases:
227+
Applicable: Exchange Online, Exchange Online Protection
228+
229+
Required: False
230+
Position: Named
231+
Default value: None
232+
Accept pipeline input: False
233+
Accept wildcard characters: False
234+
```
235+
236+
### CommonParameters
237+
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).
238+
239+
## INPUTS
240+
241+
###
242+
243+
## OUTPUTS
244+
245+
###
246+
247+
## NOTES
248+
249+
## RELATED LINKS

0 commit comments

Comments
 (0)