Get-AzureRmRoleDefinition
Get-AzureRmRoleDefinition
Gets all roles that are available in Azure Active Directory Role-based Access Control (RBAC).
Syntax
Parameter Set: Default
Get-AzureRmRoleDefinition [[-Name] <String> ] [-Custom] [ <CommonParameters>]
Detailed Description
The Get-AzureRmRoleDefinition comdlet gets definitions of RBAC roles. Specify a 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.
Parameters
-Custom
Indicates that this cmdlet uses the custom option. If specified, only the custom created roles in the directory are displayed.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the role definition to get.
Aliases |
none |
Required? |
false |
Position? |
0 |
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: Get a role definition by name
This command gets the role definition named Reader.
PS C:\> Get-AzureRmRoleDefinition -Name "Reader"
Example 2: Get all role definitions
This command gets all RBAC role definitions.
PS C:\> Get-AzureRmRoleDefinition