通过

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

Role Definitions - Get

服务:
Key Vault
API 版本:
2025-07-01

获取指定的角色定义。

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionName}?api-version=2025-07-01

URI 参数

名称 在 必需 类型 说明
roleDefinitionName
 path True

string

要获取的角色定义的名称。
scope
 path True

string

要获取的角色定义的范围。 托管 HSM 仅支持“/”。
vaultBaseUrl
 path True

string (uri)

api-version
 query True

string

minLength: 1

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

RoleDefinition

请求已成功。
Other Status Codes

KeyVaultError

意外的错误响应。

安全性

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
https://vault.azure.net/.default

示例

Get the specified role definition

示例请求

GET https://myvault.vault.azure.net////providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000?api-version=2025-07-01

示例响应

状态代码:
200 
{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "assignableScopes": [
      "/"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  },
  "id": "Microsoft.KeyVault/providers/Microsoft.Authorization/roleDefinitions/00000000-0000-0000-0000-000000000000",
  "type": "Microsoft.Authorization/roleDefinitions",
  "name": "00000000-0000-0000-0000-000000000000"
}

定义

名称 说明
DataAction

支持数据作的权限。
Error
KeyVaultError

密钥保管库错误异常。
Permission

角色定义权限。
RoleDefinition

角色定义。
RoleDefinitionType

角色定义类型。
RoleScope

角色范围。
RoleType

角色类型。

DataAction

枚举

支持数据作的权限。

值 说明
Microsoft.KeyVault/managedHsm/keys/read/action

读取 HSM 密钥元数据。
Microsoft.KeyVault/managedHsm/keys/write/action

更新 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action

读取已删除的 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action

恢复已删除的 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/backup/action

备份 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/restore/action

还原 HSM 密钥。
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action

删除角色分配。
Microsoft.KeyVault/managedHsm/roleAssignments/read/action

获取角色分配。
Microsoft.KeyVault/managedHsm/roleAssignments/write/action

创建或更新角色分配。
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action

获取角色定义。
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action

创建或更新角色定义。
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action

删除角色定义。
Microsoft.KeyVault/managedHsm/keys/encrypt/action

使用 HSM 密钥进行加密。
Microsoft.KeyVault/managedHsm/keys/decrypt/action

使用 HSM 密钥解密。
Microsoft.KeyVault/managedHsm/keys/wrap/action

使用 HSM 密钥进行包装。
Microsoft.KeyVault/managedHsm/keys/unwrap/action

使用 HSM 密钥展开包装。
Microsoft.KeyVault/managedHsm/keys/sign/action

使用 HSM 密钥进行签名。
Microsoft.KeyVault/managedHsm/keys/verify/action

使用 HSM 密钥进行验证。
Microsoft.KeyVault/managedHsm/keys/create

创建 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/delete

删除 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/export/action

导出 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/release/action

使用安全密钥释放释放 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/import/action

导入 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete

清除已删除的 HSM 密钥。
Microsoft.KeyVault/managedHsm/securitydomain/download/action

下载 HSM 安全域。
Microsoft.KeyVault/managedHsm/securitydomain/download/read

检查 HSM 安全域下载的状态。
Microsoft.KeyVault/managedHsm/securitydomain/upload/action

上传 HSM 安全域。
Microsoft.KeyVault/managedHsm/securitydomain/upload/read

检查 HSM 安全域交换文件的状态。
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read

下载 HSM 安全域转移密钥。
Microsoft.KeyVault/managedHsm/backup/start/action

启动 HSM 备份。
Microsoft.KeyVault/managedHsm/restore/start/action

启动 HSM 还原。
Microsoft.KeyVault/managedHsm/backup/status/action

读取 HSM 备份状态。
Microsoft.KeyVault/managedHsm/restore/status/action

读取 HSM 还原状态。
Microsoft.KeyVault/managedHsm/rng/action

生成随机数。

Error

Object
名称 类型 说明
code

string

错误代码。
innererror

Error

密钥保管库服务器错误。
message

string

错误消息。

KeyVaultError

Object

密钥保管库错误异常。

名称 类型 说明
error

Error

密钥保管库服务器错误。

Permission

Object

角色定义权限。

名称 类型 说明
actions

string[]

授予的作权限。
dataActions

DataAction[]

授予的数据作权限。
notActions

string[]

已排除但未拒绝的作权限。 它们可能由分配给主体的其他角色定义授予。
notDataActions

DataAction[]

已排除但未拒绝的数据作权限。 它们可能由分配给主体的其他角色定义授予。

RoleDefinition

Object

角色定义。

名称 类型 说明
id

string

角色定义 ID。
name

string

角色定义名称。
properties.assignableScopes

RoleScope[]

角色定义可分配范围。
properties.description

string

角色定义说明。
properties.permissions

Permission[]

角色定义权限。
properties.roleName

string

角色名称。
properties.type

RoleType

角色类型。
type

RoleDefinitionType

角色定义类型。

RoleDefinitionType

枚举

角色定义类型。

值 说明
Microsoft.Authorization/roleDefinitions

Microsoft 定义的角色定义。

RoleScope

枚举

角色范围。

值 说明
/

全局范围
/keys

键范围

RoleType

枚举

角色类型。

值 说明
AKVBuiltInRole

内置角色。
CustomRole

自定义角色。