Skip to content

Commit 6cf4350

Browse files
authored
Update Add-ManagementRoleEntry.md
Added on-prem only and Unscoped Role Management role only to UnScopedTopLevel parameter per Issue #1387
1 parent babe4ec commit 6cf4350

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

exchange/exchange-ps/exchange/role-based-access-control/Add-ManagementRoleEntry.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This example adds a new role entry for the Get-Mailbox cmdlet to the Recipient A
5050

5151
### -------------------------- Example 2 --------------------------
5252
```
53-
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox" -Parameters Identity, Anr, Server, Filter
53+
Add-ManagementRoleEntry "Recipient Administrators\Get-Mailbox" -Parameters "Identity","Anr","Server","Filter"
5454
```
5555

5656
This example adds a new role entry for the Get-Mailbox cmdlet to the Recipient Administrators role. Only the Identity, Anr, Server and Filter parameters are added to the new role entry.
@@ -64,10 +64,10 @@ This example uses the Get-ManagementRoleEntry cmdlet to retrieve a list of all t
6464

6565
### -------------------------- Example 4 --------------------------
6666
```
67-
Add-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters Department, Location -UnScopedTopLevel
67+
Add-ManagementRoleEntry "IT Scripts\MailboxAudit" -Parameters "Department","Location" -UnScopedTopLevel
6868
```
6969

70-
This example adds the MailboxAudit script with the Department and Location parameters to the IT Scripts unscoped top-level role.
70+
In on-premises Exchange, this example adds the MailboxAudit script with the Department and Location parameters to the IT Scripts unscoped top-level role. Note that the UnScopedTopLevel switch requires the UnScoped Role Management role, which isn't assigned to any role groups by default.
7171

7272
## PARAMETERS
7373

@@ -219,13 +219,19 @@ Accept wildcard characters: False
219219
```
220220
221221
### -UnScopedTopLevel
222-
The UnScopedTopLevel switch specifies that you're adding a custom script or non-Exchange cmdlet to an unscoped top-level management role. You can only use the UnScopedTopLevel switch when you add a role entry to an unscoped top-level role. If you use the UnScopedTopLevel switch, you can't use the ParentRoleEntry parameter.
222+
This parameter is available on in on-premises Exchange.
223+
224+
By default, this parameter is only available in the UnScoped Role Management role, and that role isn't assigned to any role groups. To use this parameter, you need to add the UnScoped Role Management role to a role group (for example, to the Organization Management role group). For more information, see the "Add a role to a role group" section in Manage role groups (https://technet.microsoft.com/library/jj657480.aspx).
225+
226+
The UnScopedTopLevel switch specifies that you're adding a custom script or non-Exchange cmdlet to an unscoped top-level management role. You don't need to specify a value with this switch.
227+
228+
You can only use this switch when you add a role entry to an unscoped top-level role. When you use this switch, you can't use the ParentRoleEntry parameter.
223229
224230
```yaml
225231
Type: SwitchParameter
226232
Parameter Sets: Set1
227233
Aliases:
228-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection
234+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016
229235
Required: False
230236
Position: Named
231237
Default value: None
@@ -249,13 +255,15 @@ Accept wildcard characters: False
249255
```
250256
251257
### -Force
252-
This parameter is reserved for internal Microsoft use.
258+
This parameter is available only in the cloud-based service.
259+
260+
The Force switch specifies whether to suppress warning or confirmation messages. You can use this switch to run tasks programmatically where prompting for administrative input is inappropriate. You don't need to specify a value with this switch.
253261
254262
```yaml
255263
Type: SwitchParameter
256264
Parameter Sets: (All)
257265
Aliases:
258-
Applicable: Exchange Server 2013, Exchange Server 2016, Exchange Online, Exchange Online Protection
266+
Applicable: Exchange Online, Exchange Online Protection
259267
Required: False
260268
Position: Named
261269
Default value: None

0 commit comments

Comments
 (0)