< Back
Get-AzureRmRoleDefinition
Post
NAME Get-AzureRmRoleDefinition
SYNOPSIS
Lists all Azure RBAC roles that are available for assignment.
SYNTAX
Get-AzureRmRoleDefinition [[-Name] <String>] [-AtScopeAndBelow] [-DefaultProfile <IAzureContextContainer>] [-Scope <String>] [<CommonParameters>]
Get-AzureRmRoleDefinition [-AtScopeAndBelow] -Custom [-DefaultProfile <IAzureContextContainer>] [-Scope <String>] [<CommonParameters>]
Get-AzureRmRoleDefinition [-DefaultProfile <IAzureContextContainer>] -Id <Guid> [-Scope <String>] [<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.
PARAMETERS
-AtScopeAndBelow [<SwitchParameter>]
If specified, displays all role definitions.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Custom [<SwitchParameter>]
If specified, only displays the custom created roles in the directory.
Required? true
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <Guid>
Role definition Id.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Role definition name. For e.g. Reader, Contributor, Virtual Machine Contributor.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Scope <String>
Role definition scope.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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
Example 1
PS C:\\> Get-AzureRmRoleDefinition -Name Reader
Get the Reader role definition
Example 2
PS C:\\> Get-AzureRmRoleDefinition
Lists all RBAC role definitions
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... definition
New-AzureRmRoleAssignment
Get-AzureRmRoleAssignment
New-AzureRmRoleDefinition
Remove-AzureRmRoleDefinition
SYNOPSIS
Lists all Azure RBAC roles that are available for assignment.
SYNTAX
Get-AzureRmRoleDefinition [[-Name] <String>] [-AtScopeAndBelow] [-DefaultProfile <IAzureContextContainer>] [-Scope <String>] [<CommonParameters>]
Get-AzureRmRoleDefinition [-AtScopeAndBelow] -Custom [-DefaultProfile <IAzureContextContainer>] [-Scope <String>] [<CommonParameters>]
Get-AzureRmRoleDefinition [-DefaultProfile <IAzureContextContainer>] -Id <Guid> [-Scope <String>] [<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.
PARAMETERS
-AtScopeAndBelow [<SwitchParameter>]
If specified, displays all role definitions.
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Custom [<SwitchParameter>]
If specified, only displays the custom created roles in the directory.
Required? true
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Id <Guid>
Role definition Id.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Role definition name. For e.g. Reader, Contributor, Virtual Machine Contributor.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Scope <String>
Role definition scope.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
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
Example 1
PS C:\\> Get-AzureRmRoleDefinition -Name Reader
Get the Reader role definition
Example 2
PS C:\\> Get-AzureRmRoleDefinition
Lists all RBAC role definitions
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... definition
New-AzureRmRoleAssignment
Get-AzureRmRoleAssignment
New-AzureRmRoleDefinition
Remove-AzureRmRoleDefinition