次の方法で共有


Role Definitions - Create Or Update

カスタム ロール定義を作成または更新します。

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

URI パラメーター

名前 / 必須 説明
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 バージョン。

要求本文

名前 必須 説明
properties True

RoleDefinitionProperties

ロール定義プロパティ。

応答

名前 説明
201 Created

RoleDefinition

作成済み - ロール定義に関する情報を返します。

Other Status Codes

KeyVaultError

操作Key Vault失敗した理由を説明するエラー応答です。

PutRoleDefinition

要求のサンプル

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

応答のサンプル

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

ロールの定義。

RoleDefinitionCreateParameters

ロール定義によってパラメーターが作成されます。

RoleDefinitionProperties

ロール定義プロパティ。

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

ロール定義の種類。

RoleDefinitionCreateParameters

ロール定義によってパラメーターが作成されます。

名前 説明
properties

RoleDefinitionProperties

ロール定義プロパティ。

RoleDefinitionProperties

ロール定義プロパティ。

名前 説明
assignableScopes

RoleScope[]

ロール定義の割り当て可能なスコープ。

description

string

ロール定義の説明。

permissions

Permission[]

ロール定義のアクセス許可。

roleName

string

ロール名。

type

RoleType

ロールの種類。

RoleDefinitionType

ロール定義の種類。

名前 説明
Microsoft.Authorization/roleDefinitions

string

RoleScope

ロールスコープ。

名前 説明
/

string

グローバル スコープ

/keys

string

キースコープ

RoleType

ロールの種類。

名前 説明
AKVBuiltInRole

string

組み込みのロール。

CustomRole

string

カスタム ロール。