Remove-AzureRmRoleAssignment
Remove-AzureRmRoleAssignment
Removes a role assignment to the specified principal who is assigned to a particular role at a particular scope.
Syntax
Parameter Set: EmptyParameterSet
Remove-AzureRmRoleAssignment -ObjectId <Guid> -RoleDefinitionName <String> [-Force] [-PassThru] [-Scope <String> ] [ <CommonParameters>]
Parameter Set: ResourceGroupWithObjectIdParameterSet
Remove-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -RoleDefinitionName <String> [-Force] [-PassThru] [ <CommonParameters>]
Parameter Set: ResourceGroupWithSignInNameParameterSet
Remove-AzureRmRoleAssignment -ResourceGroupName <String> -RoleDefinitionName <String> -SignInName <String> [-Force] [-PassThru] [ <CommonParameters>]
Parameter Set: ResourceGroupWithSPNParameterSet
Remove-AzureRmRoleAssignment -ResourceGroupName <String> -RoleDefinitionName <String> -ServicePrincipalName <String> [-Force] [-PassThru] [ <CommonParameters>]
Parameter Set: ResourceWithObjectIdParameterSet
Remove-AzureRmRoleAssignment -ObjectId <Guid> -ResourceGroupName <String> -ResourceName <String> -ResourceType <String> -RoleDefinitionName <String> [-Force] [-ParentResource <String> ] [-PassThru] [ <CommonParameters>]
Parameter Set: ResourceWithSignInNameParameterSet
Remove-AzureRmRoleAssignment -ResourceGroupName <String> -ResourceName <String> -ResourceType <String> -RoleDefinitionName <String> -SignInName <String> [-Force] [-ParentResource <String> ] [-PassThru] [ <CommonParameters>]
Parameter Set: ResourceWithSPNParameterSet
Remove-AzureRmRoleAssignment -ResourceGroupName <String> -ResourceName <String> -ResourceType <String> -RoleDefinitionName <String> -ServicePrincipalName <String> [-Force] [-ParentResource <String> ] [-PassThru] [ <CommonParameters>]
Parameter Set: ScopeWithObjectIdParameterSet
Remove-AzureRmRoleAssignment -ObjectId <Guid> -RoleDefinitionName <String> [-Force] [-PassThru] [-Scope <String> ] [ <CommonParameters>]
Parameter Set: ScopeWithSignInNameParameterSet
Remove-AzureRmRoleAssignment -RoleDefinitionName <String> -SignInName <String> [-Force] [-PassThru] [-Scope <String> ] [ <CommonParameters>]
Parameter Set: ScopeWithSPNParameterSet
Remove-AzureRmRoleAssignment -RoleDefinitionName <String> -ServicePrincipalName <String> [-Force] [-PassThru] [-Scope <String> ] [ <CommonParameters>]
Detailed Description
Use the Remove-AzureRmRoleAssignment commandlet to revoke access to any principal at given scope and given role.
The object of the assignment i.e. the principal MUST be specified. The principal can be a user (use SignInName or ObjectId parameters to identify a user), security group (use ObjectId parameter to identify a group) or service principal (use ServicePrincipalName or ObjectId parameters to identify a ServicePrincipal.
The role that the principal is assigned to MUST be specified using the RoleDefinitionName parameter.
The scope of the assignment MAY be specified and if not specified, defaults to the subscription scope i.e. it will try to delete an assignment to the specified principal and role at the subscription scope. The scope of the assignment can be specified using one of the following parameters. a. Scope - This is the fully qualified scope starting with /subscriptions/<subscriptionId> b. ResourceGroupName - Name of any resource group under the subscription. c. ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - Identifies a particular resource under the subscription.
Parameters
-Force
If specified, the command does not prompt for a confirmation before deleting the role assignment.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ObjectId<Guid>
Azure AD ObjectId of the user, group or service principal.
Aliases |
Id,PrincipalId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ParentResource<String>
The parent resource in the hierarchy(of the resource specified using ResourceName parameter), if any. Must be used in conjunction with ResourceGroupName, ResourceType and ResourceName parameters to construct a hierarchical scope in the form of a relative URI that identifies the resource.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-PassThru
If specified, displays the deleted role assignment
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ResourceGroupName<String>
The resource group name that the role is assigned to. Attempts to delete an assignment at the specified resource group scope. When used in conjunction with ResourceName, ResourceType and (optionally)ParentResource parameters, the command constructs a hierarchical scope in the form of a relative URI that identifies a resource.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-ResourceName<String>
The resource name. For e.g. storageaccountprod. Must be used in conjunction with ResourceGroupName, ResourceType and (optionally)ParentResource parameters, to construct a hierarchical scope in the form of a relative URI that identifies the resource and delete an assignment at that scope.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-ResourceType<String>
The resource type. For e.g. Microsoft.Network/virtualNetworks. Must be used in conjunction with ResourceGroupName, ResourceName and (optionally)ParentResource parameters to construct a hierarchical scope in the form of a relative URI that identifies the resource and delete an assignment at that resource scope.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-RoleDefinitionName<String>
Name of the RBAC role for which the assignment needs to be deleted i.e. Reader, Contributor, Virtual Network Administrator, etc.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Scope<String>
The Scope of the role assignment to be deleted. In the format of relative URI. For e.g. "/subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG". If not specified, will attempt to delete the role at subscription level. If specified, it should start with "/subscriptions/{id}".
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ServicePrincipalName<String>
The ServicePrincipalName of the Azure AD application
Aliases |
SPN |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-SignInName<String>
The email address or the user principal name of the user.
Aliases |
Email,UserPrincipalName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
-------------- Example 1 -------------
Removes a role assignment for john.doe@contoso.com who is assigned to the Reader role at the rg1 resourcegroup scope.
PS C:\> Remove-AzureRmRoleAssignment -ResourceGroupName rg1 -SignInName john.doe@contoso.com -RoleDefinitionName Reader
-------------- Example 2 -------------
Removes the role assignment to the group principal identified by the ObjectId and assigned to the Reader role. Defaults to using the current subscription as the scope to find the assignment to be deleted.
PS C:\> Remove-AzureRmRoleAssignment -ObjectId 36f81fc3-b00f-48cd-8218-3879f51ff39f -RoleDefinitionName Reader
Related topics
New-AzureRmRoleAssignment
Get-AzureRmRoleAssignment
Get-AzureRmRoleDefinition