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 參數

名稱	位於	必要	類型	Description
scope	path	True	string	角色指派的範圍。
vaultBaseUrl	path	True	string (uri)	Key Vault 實例的基礎網址（例如 https://myvault.vault.azure.net/）
api-version	query	True	string minLength: 1	用於此作業的 API 版本。
$filter	query		string	要套用至作業的篩選條件。 使用 $filter=atScope（） 傳回範圍或範圍之上的所有角色指派。 使用 $filter=principalId eq {id} 傳回指定主體範圍、高於或下方的所有角色指派。

回應

名稱	類型	Description
200 OK	RoleAssignmentListResult	要求已成功。
Other Status Codes	KeyVaultError	未預期的錯誤回應。

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
    }
  ]
}

定義

名稱	Description
Error
KeyVaultError	金鑰保存庫錯誤例外狀況。
RoleAssignment	角色指派
RoleAssignmentListResult	角色指派清單作業結果。
RoleAssignmentPropertiesWithScope	具有範圍的角色指派屬性。
RoleScope	角色範圍。

Error

Object

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

KeyVaultError

Object

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

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

RoleAssignment

Object

角色指派

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

RoleAssignmentListResult

Object

角色指派清單作業結果。

名稱	類型	Description
nextLink	string	要用於取得下一組結果的URL。
value	RoleAssignment[]	角色指派清單。

RoleAssignmentPropertiesWithScope

Object

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

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

RoleScope

列舉型別

角色範圍。

值	Description
/	全域範圍
/keys	索引鍵範圍