Get-AzureRmRoleDefinition

Lists all Azure RBAC roles that are available for assignment.

Syntax

Get-AzureRmRoleDefinition
   [[-Name] <String>]
   [-Scope <String>]
   [-AtScopeAndBelow]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmRoleDefinition
   -Id <Guid>
   [-Scope <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzureRmRoleDefinition
   [-Scope <String>]
   [-Custom]
   [-AtScopeAndBelow]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Use the Get-AzureRmRoleDefinition command with a particular role name to view its details. To inspect individual operations that a role grants access to, review the Actions and NotActions properties of the role.

Examples

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

PS C:\> Get-AzureRmRoleDefinition -Name Reader

Get the Reader role definition

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

PS C:\> Get-AzureRmRoleDefinition

Lists all RBAC role definitions

Required Parameters

-Custom

If specified, only displays the custom created roles in the directory.

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Id

Role definition Id.

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

Optional Parameters

-AtScopeAndBelow

If specified, displays all role definitions.

Type:System.Management.Automation.SwitchParameter
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Role definition name. For e.g. Reader, Contributor, Virtual Machine Contributor.

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

Role definition scope.

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

Inputs

String

Parameter 'Scope' accepts value of type 'String' from the pipeline

Outputs

System.Collections.Generic.List`1[Microsoft.Azure.Commands.Resources.Models.Authorization.PSRoleDefinition]

Notes

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