Skip to content

Commit 2b2ac93

Browse files
committed
New/Set-QuarantinePermissions and EndUserQuarantinePermissions updates
1 parent 5306806 commit 2b2ac93

File tree

4 files changed

+22
-10
lines changed

4 files changed

+22
-10
lines changed

exchange/exchange-ps/exchange/New-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 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,7 +49,7 @@ $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
@@ -56,7 +58,7 @@ $LimitedAccess = New-QuarantinePermissions -PermissionToAllowSender $true -Permi
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
@@ -65,7 +67,7 @@ $FullAccess = New-QuarantinePermissions -PermissionToAllowSender $true -Permissi
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: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,11 @@ Accept wildcard characters: False
195195
```
196196
197197
### -EndUserQuarantinePermissions
198-
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.
199203

200204
```yaml
201205
Type: QuarantinePermissions

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: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,11 @@ Accept wildcard characters: False
213213
```
214214
215215
### -EndUserQuarantinePermissions
216-
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.
217221

218222
```yaml
219223
Type: QuarantinePermissions

0 commit comments

Comments
 (0)