Role Assignments - Create

服務:

Key Vault

API 版本:

7.4

建立角色指派。

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

URI 參數

名稱	位於	必要	類型	Description
roleAssignmentName	path	True	string	要建立的角色指派名稱。 它可以是任何有效的 GUID。
scope	path	True	string	要建立的角色指派範圍。
vaultBaseUrl	path	True	string	儲存庫名稱，例如 https://myvault.vault.azure.net。
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	必要	類型	Description
properties	True	RoleAssignmentProperties	角色指派屬性。

回應

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

範例

PutRoleAssignments

範例要求

HTTP

PUT https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentName?api-version=7.4

{
  "properties": {
    "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
    "principalId": "principalId"
  }
}

範例回覆

狀態碼:

201

{
  "properties": {
    "roleDefinitionId": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
    "principalId": "principalId",
    "scope": "/keys"
  },
  "id": "/keys/providers/Microsoft.Authorization/roleAssignments/roleAssignmentId",
  "type": "Microsoft.Authorization/roleAssignments",
  "name": "roleAssignmentId"
}

定義

名稱	Description
Error	金鑰儲存庫伺服器錯誤。
KeyVaultError	金鑰保存庫錯誤例外狀況。
RoleAssignment	角色指派
RoleAssignmentCreateParameters	角色指派建立參數。
RoleAssignmentProperties	角色指派屬性。
RoleAssignmentPropertiesWithScope	具有範圍的角色指派屬性。
RoleScope	角色範圍。

Error

金鑰儲存庫伺服器錯誤。

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

KeyVaultError

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

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

RoleAssignment

角色指派

名稱	類型	Description
id	string	角色指派識別碼。
name	string	角色指派名稱。
properties	RoleAssignmentPropertiesWithScope	角色指派屬性。
type	string	角色指派類型。

RoleAssignmentCreateParameters

角色指派建立參數。

名稱	類型	Description
properties	RoleAssignmentProperties	角色指派屬性。

RoleAssignmentProperties

角色指派屬性。

名稱	類型	Description
principalId	string	指派給角色的主體標識碼。 這會對應至 Active Directory 內的標識碼。 它可以指向用戶、服務主體或安全組。
roleDefinitionId	string	角色指派中使用的角色定義標識碼。

RoleAssignmentPropertiesWithScope

具有範圍的角色指派屬性。

名稱	類型	Description
principalId	string	主體標識碼。
roleDefinitionId	string	角色定義識別碼。
scope	RoleScope	角色範圍。

RoleScope

角色範圍。

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