你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Role Definitions - List

获取范围及更高范围内适用的所有角色定义。

GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleDefinitions?api-version=2022-04-01
GET https://management.azure.com/{scope}/providers/Microsoft.Authorization/roleDefinitions?$filter={$filter}&api-version=2022-04-01

URI 参数

名称 必需 类型 说明
scope
path True

string

角色定义的范围。

api-version
query True

string

要用于此操作的 API 版本。

$filter
query

string

要应用于操作的筛选器。 使用 atScopeAndBelow 筛选器在给定范围下方进行搜索。

响应

名称 类型 说明
200 OK

RoleDefinitionListResult

OK - 返回角色定义的数组。

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

权限

若要调用此 API,必须具备带有以下权限的角色。 有关详细信息,请参阅 Azure 内置角色

Microsoft.Authorization/roleDefinitions/read

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

List role definitions for scope

Sample Request

GET https://management.azure.com/scope/providers/Microsoft.Authorization/roleDefinitions?api-version=2022-04-01

Sample Response

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

定义

名称 说明
ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

Permission

角色定义权限。

RoleDefinition

角色定义。

RoleDefinitionListResult

角色定义列表操作结果。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

Permission

角色定义权限。

名称 类型 说明
actions

string[]

允许的操作。

dataActions

string[]

允许的数据操作。

notActions

string[]

拒绝的操作。

notDataActions

string[]

拒绝的数据操作。

RoleDefinition

角色定义。

名称 类型 说明
id

string

角色定义 ID。

name

string

角色定义名称。

properties.assignableScopes

string[]

角色定义可分配的范围。

properties.createdBy

string

创建分配的用户的 ID

properties.createdOn

string

创建时间

properties.description

string

角色定义说明。

properties.permissions

Permission[]

角色定义权限。

properties.roleName

string

角色名称。

properties.type

string

角色类型。

properties.updatedBy

string

更新分配的用户的 ID

properties.updatedOn

string

更新时间

type

string

角色定义类型。

RoleDefinitionListResult

角色定义列表操作结果。

名称 类型 说明
nextLink

string

用于获取下一组结果的 URL。

value

RoleDefinition[]

角色定义列表。