Role Definitions - Get

Get role definition by name (GUID).

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}?api-version=2015-07-01

URI Parameters

Name In Required Type Description
roleDefinitionId
path True
  • string

The ID of the role definition.

scope
path True
  • string

The scope of the role definition.

api-version
query True
  • string

The API version to use for this operation.

Responses

Name Type Description
200 OK

OK - Returns information about the role definition.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get role definition by name

Sample Request

GET https://management.azure.com/scope/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId?api-version=2015-07-01

Sample Response

{
  "properties": {
    "roleName": "Role name",
    "type": "roletype",
    "description": "Role description",
    "assignableScopes": [
      "/subscriptions/subId"
    ],
    "permissions": [
      {
        "actions": [
          "action"
        ],
        "notActions": []
      }
    ]
  },
  "id": "/subscriptions/subID/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
  "type": "Microsoft.Authorization/roleDefinitions",
  "name": "roleDefinitionId"
}

Definitions

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

Permission

Role definition permissions.

RoleDefinition

Role definition.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info
  • object

The additional info.

type
  • string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

The error additional info.

code
  • string

The error code.

details

The error details.

message
  • string

The error message.

target
  • string

The error target.

ErrorResponse

Error response

Name Type Description
error

The error object.

Permission

Role definition permissions.

Name Type Description
actions
  • string[]

Allowed actions.

notActions
  • string[]

Denied actions.

RoleDefinition

Role definition.

Name Type Description
id
  • string

The role definition ID.

name
  • string

The role definition name.

properties.assignableScopes
  • string[]

Role definition assignable scopes.

properties.description
  • string

The role definition description.

properties.permissions

Role definition permissions.

properties.roleName
  • string

The role name.

properties.type
  • string

The role type.

type
  • string

The role definition type.