Role Definitions - List

참조

Service:: Key Vault

API Version:: 7.4

scope 이상에서 적용 가능한 모든 역할 정의를 가져옵니다.

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

With optional parameters:

GET {vaultBaseUrl}/{scope}/providers/Microsoft.Authorization/roleDefinitions?$filter={$filter}&api-version=7.4

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
scope	path	True	string	역할 정의의 scope.
vaultBaseUrl	path	True	string	자격 증명 모음 이름(예: https://myvault.vault.azure.net)입니다.
api-version	query	True	string	클라이언트 API 버전입니다.
$filter	query		string	작업에 적용할 필터입니다. atScopeAndBelow 필터를 사용하여 지정된 scope 아래에서도 검색합니다.

응답

Name	형식	Description
200 OK	RoleDefinitionListResult	확인 - 역할 정의의 배열을 반환합니다.
Other Status Codes	KeyVaultError	작업이 실패한 이유를 설명하는 오류 응답을 Key Vault.

예제

ListRoleDefinitions

Sample Request

HTTP

GET https://myvault.vault.azure.net//keys/providers/Microsoft.Authorization/roleDefinitions?api-version=7.4

Sample Response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "roleName": "Role name",
        "type": "roletype",
        "description": "Role description",
        "assignableScopes": [
          "/keys"
        ],
        "permissions": [
          {
            "actions": [
              "get"
            ],
            "notActions": []
          }
        ]
      },
      "id": "/keys/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId",
      "type": "Microsoft.Authorization/roleDefinitions",
      "name": "roleDefinitionId"
    }
  ]
}

정의

Name	Description
DataAction	데이터 작업에 대해 지원되는 권한입니다.
Error	키 자격 증명 모음 서버 오류입니다.
KeyVaultError	키 자격 증명 모음 오류 예외입니다.
Permission	역할 정의 권한.
RoleDefinition	역할 정의.
RoleDefinitionListResult	역할 정의 목록 작업 결과입니다.
RoleDefinitionType	역할 정의 형식입니다.
RoleScope	역할 scope.
RoleType	역할 유형입니다.

DataAction

데이터 작업에 대해 지원되는 권한입니다.

Name	형식	Description
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

키 자격 증명 모음 서버 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
innererror	Error	키 자격 증명 모음 서버 오류입니다.
message	string	오류 메시지입니다.

KeyVaultError

키 자격 증명 모음 오류 예외입니다.

Name	형식	Description
error	Error	키 자격 증명 모음 서버 오류입니다.

Permission

역할 정의 권한.

Name	형식	Description
actions	string[]	부여된 작업 권한입니다.
dataActions	DataAction[]	부여된 데이터 작업 권한입니다.
notActions	string[]	제외되었지만 거부되지 않은 작업 권한입니다. 보안 주체에 할당된 다른 역할 정의에 의해 부여될 수 있습니다.
notDataActions	DataAction[]	제외되었지만 거부되지 않은 데이터 작업 권한입니다. 보안 주체에 할당된 다른 역할 정의에 의해 부여될 수 있습니다.

RoleDefinition

역할 정의.

Name	형식	Description
id	string	역할 정의 ID입니다.
name	string	역할 정의 이름입니다.
properties.assignableScopes	RoleScope[]	역할 정의 할당 가능한 범위입니다.
properties.description	string	역할 정의 설명입니다.
properties.permissions	Permission[]	역할 정의 권한.
properties.roleName	string	역할 이름입니다.
properties.type	RoleType	역할 유형입니다.
type	RoleDefinitionType	역할 정의 형식입니다.

RoleDefinitionListResult

역할 정의 목록 작업 결과입니다.

Name	형식	Description
nextLink	string	다음 결과 집합을 가져오는 데 사용할 URL입니다.
value	RoleDefinition[]	역할 정의 목록입니다.

RoleDefinitionType

역할 정의 형식입니다.

Name	형식	Description
Microsoft.Authorization/roleDefinitions	string

RoleScope

역할 scope.

Name	형식	Description
/	string	전역 범위
/keys	string	키 scope

RoleType

역할 유형입니다.

Name	형식	Description
AKVBuiltInRole	string	기본 제공 역할.
CustomRole	string	사용자 지정 역할.

Role Definitions - List

URI 매개 변수

응답

예제

ListRoleDefinitions

Sample Request

Sample Response

정의

DataAction

Error

KeyVaultError

Permission

RoleDefinition

RoleDefinitionListResult

RoleDefinitionType

RoleScope

RoleType

추가 리소스