Role Definitions - Create Or Update

服務:

Key Vault

API 版本:

7.4

建立或更新自定義角色定義。

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

URI 參數

名稱	位於	必要	類型	Description
roleDefinitionName	path	True	string	要建立或更新的角色定義名稱。 它可以是任何有效的 GUID。
scope	path	True	string	要建立或更新的角色定義範圍。 受控 HSM 僅支援 『/』。
vaultBaseUrl	path	True	string	儲存庫名稱，例如 https://myvault.vault.azure.net。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	必要	類型	Description
properties	True	RoleDefinitionProperties	角色定義屬性。

回應

名稱	類型	Description
201 Created	RoleDefinition	建立 - 傳回角色定義的相關信息。
Other Status Codes	KeyVaultError	金鑰保存庫 錯誤回應，描述作業失敗的原因。

範例

PutRoleDefinition

範例要求

HTTP

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

{
  "properties": {
    "roleName": "My custom role",
    "type": "CustomRole",
    "description": "Role description",
    "permissions": [
      {
        "dataActions": [
          "Microsoft.KeyVault/managedHsm/keys/sign/action"
        ]
      }
    ]
  }
}

範例回覆

狀態碼:

201

{
  "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"
}

定義

名稱	Description
DataAction	支援的數據動作許可權。
Error	金鑰儲存庫伺服器錯誤。
KeyVaultError	金鑰保存庫錯誤例外狀況。
Permission	角色定義許可權。
RoleDefinition	角色定義。
RoleDefinitionCreateParameters	角色定義建立參數。
RoleDefinitionProperties	角色定義屬性。
RoleDefinitionType	角色定義類型。
RoleScope	角色範圍。
RoleType	角色類型。

DataAction

支援的數據動作許可權。

名稱	類型	Description
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

金鑰儲存庫伺服器錯誤。

名稱	類型	Description
code	string	錯誤碼。
innererror	Error	金鑰儲存庫伺服器錯誤。
message	string	錯誤訊息。

KeyVaultError

金鑰保存庫錯誤例外狀況。

名稱	類型	Description
error	Error	金鑰儲存庫伺服器錯誤。

Permission

角色定義許可權。

名稱	類型	Description
actions	string[]	授與的動作許可權。
dataActions	DataAction[]	授與的數據動作許可權。
notActions	string[]	排除但未拒絕的動作許可權。 其他指派給主體的角色定義可能會授與這些角色定義。
notDataActions	DataAction[]	排除但未拒絕的數據動作許可權。 其他指派給主體的角色定義可能會授與這些角色定義。

RoleDefinition

角色定義。

名稱	類型	Description
id	string	角色定義識別碼。
name	string	角色定義名稱。
properties.assignableScopes	RoleScope[]	角色定義可指派的範圍。
properties.description	string	角色定義描述。
properties.permissions	Permission[]	角色定義許可權。
properties.roleName	string	角色名稱。
properties.type	RoleType	角色類型。
type	RoleDefinitionType	角色定義類型。

RoleDefinitionCreateParameters

角色定義建立參數。

名稱	類型	Description
properties	RoleDefinitionProperties	角色定義屬性。

RoleDefinitionProperties

角色定義屬性。

名稱	類型	Description
assignableScopes	RoleScope[]	角色定義可指派的範圍。
description	string	角色定義描述。
permissions	Permission[]	角色定義許可權。
roleName	string	角色名稱。
type	RoleType	角色類型。

RoleDefinitionType

角色定義類型。

名稱	類型	Description
Microsoft.Authorization/roleDefinitions	string

RoleScope

角色範圍。

名稱	類型	Description
/	string	全域範圍
/keys	string	索引鍵範圍

RoleType

角色類型。

名稱	類型	Description
AKVBuiltInRole	string	內建角色。
CustomRole	string	自訂角色。