Role Assignments - Create

サービス:

Key Vault

API バージョン:

7.4

ロールの割り当てを作成します。

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

URI パラメーター

名前	/	必須	型	説明
roleAssignmentName	path	True	string	作成するロールの割り当ての名前。 任意の有効な GUID を指定できます。
scope	path	True	string	作成するロールの割り当てのスコープ。
vaultBaseUrl	path	True	string	コンテナー名 (https://myvault.vault.azure.netなど)。
api-version	query	True	string	クライアント API のバージョン。

要求本文

名前	必須	型	説明
properties	True	RoleAssignmentProperties	ロールの割り当てプロパティ。

応答

名前	型	説明
201 Created	RoleAssignment	作成済み - ロールの割り当てに関する情報を返します。
Other Status Codes	KeyVaultError	操作が失敗した理由を説明する Key Vault エラー応答。

例

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

定義

名前	説明
Error	キー コンテナー サーバー エラー。
KeyVaultError	キー コンテナーのエラー例外。
RoleAssignment	ロールの割り当て
RoleAssignmentCreateParameters	ロールの割り当てによってパラメーターが作成されます。
RoleAssignmentProperties	ロールの割り当てプロパティ。
RoleAssignmentPropertiesWithScope	スコープを持つロールの割り当てプロパティ。
RoleScope	ロール スコープ。

Error

Object

キー コンテナー サーバー エラー。

名前	型	説明
code	string	エラー コード。
innererror	Error	キー コンテナー サーバー エラー。
message	string	エラー メッセージ。

KeyVaultError

Object

キー コンテナーのエラー例外。

名前	型	説明
error	Error	キー コンテナー サーバー エラー。

RoleAssignment

Object

ロールの割り当て

名前	型	説明
id	string	ロールの割り当て ID。
name	string	ロールの割り当て名。
properties	RoleAssignmentPropertiesWithScope	ロールの割り当てプロパティ。
type	string	ロールの割り当ての種類。

RoleAssignmentCreateParameters

Object

ロールの割り当てによってパラメーターが作成されます。

名前	型	説明
properties	RoleAssignmentProperties	ロールの割り当てプロパティ。

RoleAssignmentProperties

Object

ロールの割り当てプロパティ。

名前	型	説明
principalId	string	ロールに割り当てられたプリンシパル ID。 これは Active Directory 内の ID にマップされます。 ユーザー、サービス プリンシパル、またはセキュリティ グループを指すことができます。
roleDefinitionId	string	ロールの割り当てで使用されるロール定義 ID。

RoleAssignmentPropertiesWithScope

Object

スコープを持つロールの割り当てプロパティ。

名前	型	説明
principalId	string	プリンシパル ID。
roleDefinitionId	string	ロール定義 ID。
scope	RoleScope	ロール スコープ。

RoleScope

列挙

ロール スコープ。

値	説明
/	グローバル スコープ
/keys	キースコープ