Get-​Azure​Rm​Role​Assignment

Lists Azure RBAC role assignments at the specified scope. By default it lists all role assignments in the selected Azure subscription. Use respective parameters to list assignments to a specific user, or to list assignments on a specific resource group or resource.

Syntax

Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ObjectId <Guid>
   -ResourceGroupName <String>
   -ResourceName <String>
   -ResourceType <String>
   [-ParentResource <String>]
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ObjectId <Guid>
   [-ExpandPrincipalGroups]
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ObjectId <Guid>
   -ResourceGroupName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ObjectId <Guid>
   -Scope <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ResourceGroupName <String>
   -SignInName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ResourceGroupName <String>
   -ResourceName <String>
   -ResourceType <String>
   [-ParentResource <String>]
   -SignInName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -Scope <String>
   -SignInName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-ExpandPrincipalGroups]
   -SignInName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ResourceGroupName <String>
   -ServicePrincipalName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -Scope <String>
   -ServicePrincipalName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ResourceGroupName <String>
   -ResourceName <String>
   -ResourceType <String>
   [-ParentResource <String>]
   -ServicePrincipalName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ServicePrincipalName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ResourceGroupName <String>
   -ResourceName <String>
   -ResourceType <String>
   [-ParentResource <String>]
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -ResourceGroupName <String>
Get-AzureRmRoleAssignment
   [-RoleDefinitionName <String>]
   [-IncludeClassicAdministrators]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   -Scope <String>
Get-AzureRmRoleAssignment
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-ObjectId <Guid>]
   [-Scope <String>]
   -RoleDefinitionId <Guid>

Description

Use the Get-AzureRMRoleAssignment command to list all role assignments that are effective on a scope.

Without any parameters, this command returns all the role assignments made under the subscription. This list can be filtered using filtering parameters for principal, role and scope.

The subject of the assignment must be specified. To specify a user, use SignInName or Azure AD ObjectId parameters. To specify a security group, use Azure AD ObjectId parameter. And to specify an Azure AD application, use ServicePrincipalName or ObjectId parameters.

The role that is being assigned must be specified using the RoleDefinitionName parameter.

The scope at which access is being granted may be specified. It defaults to the selected subscription. The scope of the assignment can be specified using one of the following parameter combinations a. Scope - This is the fully qualified scope starting with /subscriptions/<subscriptionId>. This will filter assignments that are effective at that particular scope i.e. all assignments at that scope and above. b. ResourceGroupName - Name of any resource group under the subscription. This will filter assignments effective at the specified resource group c. ResourceName, ResourceType, ResourceGroupName and (optionally) ParentResource - Identifies a particular resource under the subscription and will filter assignments effective at that resource scope.

To determine what access a particular user has in the subscription, use the ExpandPrincipalGroups switch. This will list all roles assigned to the user, and to the groups that the user is member of.

Use the IncludeClassicAdministrators switch to also display the subscription admins and co-admins.

Examples

-------------------------- Example 1 --------------------------

@{paragraph=PS C:\>}

PS C:\> Get-AzureRmRoleAssignment

List all role assignments in the subscription

-------------------------- Example 2 --------------------------

@{paragraph=PS C:\>}

PS C:\> Get-AzureRmRoleAssignment -ResourceGroupName testRG -SignInName john.doe@contoso.com -ExpandPrincipalGroups

Gets all role assignments made to user john.doe@contoso.com, and the groups of which he is member, at the testRG scope or above.

-------------------------- Example 3 --------------------------

@{paragraph=PS C:\>}

PS C:\> Get-AzureRmRoleAssignment -ServicePrincipalName "http://testapp1.com"

Gets all role assignments of the specified service principal

-------------------------- Example 4 --------------------------

@{paragraph=PS C:\>}

PS C:\> Get-AzureRmRoleAssignment -Scope "/subscriptions/96231a05-34ce-4eb4-aa6a-70759cbb5e83/resourcegroups/rg1/providers/Microsoft.Web/sites/site1"

Gets role assignments at the 'site1' website scope.

Required Parameters

-ObjectId

The Azure AD ObjectId of the User, Group or Service Principal. Filters all assignments that are made to the specified principal.

Type:Guid
Aliases:Id, PrincipalId
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceGroupName

The resource group name. Lists role assignments that are effective at the specified resource group. When used in conjunction with ResourceName, ResourceType, and ParentResource parameters, the command lists assignments effective at resources within the resource group.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceName

The resource name. For e.g. storageaccountprod. Must be used in conjunction with ResourceGroupName, ResourceType, and (optionally)ParentResource parameters.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ResourceType

The resource type. For e.g. Microsoft.Network/virtualNetworks. Must be used in conjunction with ResourceGroupName, ResourceName, and (optionally)ParentResource parameters.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-RoleDefinitionId

Id of the Role that is assigned to the principal.

Type:Guid
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-ServicePrincipalName

The ServicePrincipalName of the service principal. Filters all assignments that are made to the specified Azure AD application.

Type:String
Aliases:SPN
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-SignInName

The email address or the user principal name of the user. Filters all assignments that are made to the specified user.

Type:String
Aliases:Email, UserPrincipalName
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-ExpandPrincipalGroups

If specified, returns roles directly assigned to the user and to the groups of which the user is a member (transitively). Supported only for a user principal.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IncludeClassicAdministrators

If specified, also lists subscription classic administrators (co-admins, service admins, etc.) role assignments.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ParentResource

The parent resource in the hierarchy of the resource specified using ResourceName parameter. Must be used in conjunction with ResourceGroupName, ResourceType, and ResourceName parameters.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-RoleDefinitionName

Role that is assigned to the principal i.e. Reader, Contributor, Virtual Network Administrator, etc.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Scope

The Scope of the role assignment. In the format of relative URI. For e.g. /subscriptions/9004a9fd-d58e-48dc-aeb2-4a4aec58606f/resourceGroups/TestRG. It must start with "/subscriptions/{id}". The command filters all assignments that are effective at that scope.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Notes

Keywords: azure, azurerm, arm, resource, management, manager, resource, group, template, deployment