Export (0) Print
Expand All

Remove-ManagementRoleAssignment

 

Applies to: Exchange Server 2013, Exchange Online

Topic Last Modified: 2014-03-13

This cmdlet is available in on-premises Exchange Server 2013 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Remove-ManagementRoleAssignment cmdlet to remove management role assignments.

For information about the parameter sets in the Syntax section below, see Syntax.

Remove-ManagementRoleAssignment -Identity <RoleAssignmentIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-Force <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

This example removes the Recipients_Seattle Recipient Management role assignment.

Remove-ManagementRoleAssignment "Recipients_Seattle Recipient Management"

This example retrieves a list of role assignments that begin with the string "Detroit" and attempts to remove them with the Remove-ManagementRoleAssignment cmdlet. Because the WhatIf switch is included with the Remove-ManagementRoleAssignment command, the command displays the changes that would have occurred but doesn't commit any changes.

Get-ManagementRoleAssignment Detroit* | Remove-ManagementRoleAssignment -WhatIf

After the list of role assignments to be removed is confirmed, this command is used to remove the role assignments.

Get-ManagementRoleAssignment Detroit* | Remove-ManagementRoleAssignment

When you remove a role assignment, the management role group, management role assignment, user, or universal security group (USG) that was assigned the associated role can no longer access the cmdlets or parameters made available by the role. For more information about management role assignments, see Understanding management role assignments.

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 "Role assignments" entry in the Role management permissions topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.RoleAssignmentIdParameter

The Identity parameter specifies the name of the role assignment to remove. If the role assignment name contains spaces, enclose the name in quotation marks (").

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2013.

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft