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

Role Definitions - Get

Service:

Key Vault

API Version:

7.4

获取指定的角色定义。

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

URI 参数

名称	在	必需	类型	说明
roleDefinitionName	path	True	string	要获取的角色定义的名称。
scope	path	True	string	要获取的角色定义的范围。 托管 HSM 仅支持“/”。
vaultBaseUrl	path	True	string	保管库名称，例如 https://myvault.vault.azure.net。
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	RoleDefinition	正常 - 返回有关角色定义的信息。
Other Status Codes	KeyVaultError	密钥保管库描述操作失败原因的错误响应。

示例

GetRoleAssignments

Sample Request

HTTP

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

Sample Response

Status code:

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/backup/start/action	string	启动 HSM 备份。
Microsoft.KeyVault/managedHsm/backup/status/action	string	读取 HSM 备份状态。
Microsoft.KeyVault/managedHsm/keys/backup/action	string	备份 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/create	string	创建 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/decrypt/action	string	使用 HSM 密钥解密。
Microsoft.KeyVault/managedHsm/keys/delete	string	删除 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/deletedKeys/delete	string	清除已删除的 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/deletedKeys/read/action	string	读取已删除的 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/deletedKeys/recover/action	string	恢复已删除的 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/encrypt/action	string	使用 HSM 密钥进行加密。
Microsoft.KeyVault/managedHsm/keys/export/action	string	导出 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/import/action	string	导入 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/read/action	string	读取 HSM 密钥元数据。
Microsoft.KeyVault/managedHsm/keys/release/action	string	使用安全密钥发布释放 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/restore/action	string	还原 HSM 密钥。
Microsoft.KeyVault/managedHsm/keys/sign/action	string	使用 HSM 密钥进行签名。
Microsoft.KeyVault/managedHsm/keys/unwrap/action	string	使用 HSM 密钥展开包装。
Microsoft.KeyVault/managedHsm/keys/verify/action	string	使用 HSM 密钥进行验证。
Microsoft.KeyVault/managedHsm/keys/wrap/action	string	使用 HSM 密钥换行。
Microsoft.KeyVault/managedHsm/keys/write/action	string	更新 HSM 密钥。
Microsoft.KeyVault/managedHsm/restore/start/action	string	启动 HSM 还原。
Microsoft.KeyVault/managedHsm/restore/status/action	string	读取 HSM 还原状态。
Microsoft.KeyVault/managedHsm/rng/action	string	生成随机数字。
Microsoft.KeyVault/managedHsm/roleAssignments/delete/action	string	删除角色分配。
Microsoft.KeyVault/managedHsm/roleAssignments/read/action	string	获取角色分配。
Microsoft.KeyVault/managedHsm/roleAssignments/write/action	string	创建或更新角色分配。
Microsoft.KeyVault/managedHsm/roleDefinitions/delete/action	string	删除角色定义。
Microsoft.KeyVault/managedHsm/roleDefinitions/read/action	string	获取角色定义。
Microsoft.KeyVault/managedHsm/roleDefinitions/write/action	string	创建或更新角色定义。
Microsoft.KeyVault/managedHsm/securitydomain/download/action	string	下载 HSM 安全域。
Microsoft.KeyVault/managedHsm/securitydomain/download/read	string	检查 HSM 安全域下载的状态。
Microsoft.KeyVault/managedHsm/securitydomain/transferkey/read	string	下载 HSM 安全域传输密钥。
Microsoft.KeyVault/managedHsm/securitydomain/upload/action	string	上传 HSM 安全域。
Microsoft.KeyVault/managedHsm/securitydomain/upload/read	string	检查 HSM 安全域交换文件的状态。

Error

密钥保管库服务器错误。

名称	类型	说明
code	string	错误代码。
innererror	Error	密钥保管库服务器错误。
message	string	错误消息。

KeyVaultError

密钥保管库错误异常。

名称	类型	说明
error	Error	密钥保管库服务器错误。

Permission

角色定义权限。

名称	类型	说明
actions	string[]	授予的操作权限。
dataActions	DataAction[]	授予的数据操作权限。
notActions	string[]	排除但未拒绝的操作权限。 它们可能由分配给主体的其他角色定义授予。
notDataActions	DataAction[]	排除但未拒绝的数据操作权限。 它们可能由分配给主体的其他角色定义授予。

RoleDefinition

角色定义。

名称	类型	说明
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	string

RoleScope

角色范围。

名称	类型	说明
/	string	全局范围
/keys	string	密钥范围

RoleType

角色类型。

名称	类型	说明
AKVBuiltInRole	string	内置角色。
CustomRole	string	自定义角色。