Role Assignments - List For Scope

サービス:

Key Vault

API バージョン:

2025-07-01

スコープのロール割り当てを取得します。

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleAssignments?api-version=2025-07-01

省略可能なパラメーターを含む:

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleAssignments?api-version=2025-07-01&$filter={$filter}

URI パラメーター

名前	/	必須	型	説明
scope	path	True	string	ロールの割り当ての範囲。
vaultBaseUrl	path	True	string (uri)	Key Vaultインスタンスの基本URL(例: https://myvault.vault.azure.net/)
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$filter	query		string	操作に適用するフィルター。 $filter=atScope() を使用して、スコープ以上のすべてのロールの割り当てを返します。 $filter=principalId eq {id} を使用して、指定したプリンシパルのスコープの上、上、または下のすべてのロール割り当てを返します。

応答

名前	型	説明
200 OK	RoleAssignmentListResult	要求は成功しました。
Other Status Codes	KeyVaultError	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://vault.azure.net/.default

例

Get role assignments for a scope

要求のサンプル

HTTP

GET https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleAssignments?api-version=2025-07-01

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "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	ロールの割り振り
RoleAssignmentListResult	ロール割り当てリストの操作結果。
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	ロールの割り当てタイプ。

RoleAssignmentListResult

Object

ロール割り当てリストの操作結果。

名前	型	説明
nextLink	string	次の結果セットの取得に使用する URL。
value	RoleAssignment[]	ロールの割り当てリスト。

RoleAssignmentPropertiesWithScope

Object

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

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

RoleScope

列挙

ロール スコープ。

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