Applies to: Exchange Server 2013, Exchange Online
Topic Last Modified: 2012-06-25
Use the Remove-ManagementRoleEntry cmdlet to remove existing management role entries.
For information about the parameter sets in the Syntax section below, see Syntax.
Syntax
Remove-ManagementRoleEntry -Identity
<RoleEntryIdParameter> [-Confirm [<SwitchParameter>]]
[-DomainController <Fqdn>] [-Force <SwitchParameter>]
[-WhatIf [<SwitchParameter>]]
|
Examples
EXAMPLE 1
This example removes the New-Mailbox role entry from the Tier 1 Help Desk role.
 Copy Code |
|
|---|---|
Remove-ManagementRoleEntry "Tier 1 Help Desk\New-Mailbox" |
|
EXAMPLE 2
This example removes all the role entries that have the
verb New on the Tier 1 Help Desk role by piping the
output of the Get-ManagementRoleEntry cmdlet to the
Remove-ManagementRoleEntry cmdlet. Because the WhatIf
switch has been specified along with the
Remove-ManagementRoleEntry cmdlet, the cmdlet lists what
changes would have been made but doesn't commit any changes.
| Copy Code |
|
|---|---|
Get-ManagementRoleEntry "Tier 1 Help Desk\New-*" | Remove-ManagementRoleEntry -WhatIf |
|
After you verify that the correct role entries will be removed, run the same command without the WhatIf switch to remove the role entries.
| Copy Code |
|
|---|---|
Get-ManagementRoleEntry "Tier 1 Help Desk\New-*" | Remove-ManagementRoleEntry |
|
Detailed Description
The Remove-ManagementRoleEntry cmdlet removes existing role entries. However, you can't remove role entries from built-in management roles.
For more information about management role entries, see Understanding Management Roles.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Management role entries" entry in the Role Management Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.RoleEntryIdParameter |
The Identity parameter specifies the role entry to remove. You must specify the value of the Identity parameter in the format, <management role>\<role entry name>, for example, ExampleRole\Set-Mailbox. For more information about how management role entries work, see Understanding Management Roles. If the role entry name contains spaces, enclose the name in quotation marks ("). |
|
Confirm |
Optional |
System.Management.Automation.SwitchParameter |
The Confirm switch can be used to suppress the
confirmation prompt that appears by default when this cmdlet is
run. To suppress the confirmation prompt, use the syntax
|
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory. |
|
Force |
Optional |
System.Management.Automation.SwitchParameter |
The Force switch specifies whether to suppress warning or confirmation messages. This switch can be used when the task is run programmatically and prompting for administrative input is inappropriate. If the Force switch isn't provided in the command, you're prompted for administrative input. You don't have to specify a value with this parameter. |
|
WhatIf |
Optional |
System.Management.Automation.SwitchParameter |
The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch. |
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.