Vaults - Update Access Policy

서비스:

Key Vault

API 버전:

2024-11-01

지정된 구독의 키 자격 증명 모음에서 액세스 정책을 업데이트합니다.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/accessPolicies/{operationKind}?api-version=2024-11-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
operationKind	path	True	AccessPolicyUpdateKind	작업 이름
resourceGroupName	path	True	string	자격 증명 모음이 속한 리소스 그룹의 이름입니다.
subscriptionId	path	True	string	Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명입니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다.
vaultName	path	True	string pattern: ^[a-zA-Z0-9-]{3,24}$	자격 증명 모음의 이름
api-version	query	True	string	클라이언트 API 버전입니다.

요청 본문

Name	필수	형식	Description
properties	True	VaultAccessPolicyProperties	액세스 정책의 속성

응답

Name	형식	Description
200 OK	VaultAccessPolicyParameters	업데이트된 액세스 정책
201 Created	VaultAccessPolicyParameters	업데이트된 액세스 정책
Other Status Codes	CloudError	작업이 실패한 이유를 설명하는 오류 응답입니다.

예제

Add an access policy, or update an access policy with new permissions

샘플 요청

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/add?api-version=2024-11-01

{
  "properties": {
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt"
          ],
          "secrets": [
            "get"
          ],
          "certificates": [
            "get"
          ]
        }
      }
    ]
  }
}

샘플 응답

상태 코드:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/",
  "type": "Microsoft.KeyVault/vaults/accessPolicies",
  "properties": {
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt"
          ],
          "secrets": [
            "get"
          ],
          "certificates": [
            "get"
          ]
        }
      }
    ]
  }
}

상태 코드:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/accessPolicies/",
  "type": "Microsoft.KeyVault/vaults/accessPolicies",
  "properties": {
    "accessPolicies": [
      {
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "objectId": "00000000-0000-0000-0000-000000000000",
        "permissions": {
          "keys": [
            "encrypt"
          ],
          "secrets": [
            "get"
          ],
          "certificates": [
            "get"
          ]
        }
      }
    ]
  }
}

정의

Name	Description
AccessPolicyEntry	키 자격 증명 모음에 액세스할 수 있는 ID입니다. 배열의 모든 ID는 키 자격 증명 모음의 테넌트 ID와 동일한 테넌트 ID를 사용해야 합니다.
AccessPolicyUpdateKind	작업 이름
CertificatePermissions	인증서에 대한 권한
CloudError	Key Vault 리소스 공급자의 오류 응답
CloudErrorBody	Key Vault 리소스 공급자의 오류 응답
KeyPermissions	키에 대한 권한
Permissions	ID가 키, 비밀, 인증서 및 스토리지에 대해 갖는 권한입니다.
SecretPermissions	비밀에 대한 권한
StoragePermissions	스토리지 계정에 대한 권한
VaultAccessPolicyParameters	볼트에서 액세스 정책을 업데이트하기 위한 매개변수
VaultAccessPolicyProperties	볼트 액세스 정책의 속성

AccessPolicyEntry

Object

키 자격 증명 모음에 액세스할 수 있는 ID입니다. 배열의 모든 ID는 키 자격 증명 모음의 테넌트 ID와 동일한 테넌트 ID를 사용해야 합니다.

Name	형식	Description
applicationId	string (uuid)	보안 주체를 대신하여 요청하는 클라이언트의 애플리케이션 ID
objectId	string	자격 증명 모음에 대한 Azure Active Directory 테넌트에 있는 사용자, 서비스 주체 또는 보안 그룹의 개체 ID입니다. 개체 ID는 액세스 정책 목록에서 고유해야 합니다.
permissions	Permissions	키, 비밀 및 인증서에 대해 ID에 있는 권한입니다.
tenantId	string (uuid)	키 자격 증명 모음에 대한 요청을 인증하는 데 사용해야 하는 Azure Active Directory 테넌트 ID입니다.

AccessPolicyUpdateKind

열거형

작업 이름

값	Description
add
replace
remove

CertificatePermissions

열거형

인증서에 대한 권한

값	Description
all
get
list
delete
create
import
update
managecontacts
getissuers
listissuers
setissuers
deleteissuers
manageissuers
recover
purge
backup
restore

CloudError

Object

Key Vault 리소스 공급자의 오류 응답

Name	형식	Description
error	CloudErrorBody	Key Vault 리소스 공급자의 오류 응답

CloudErrorBody

Object

Key Vault 리소스 공급자의 오류 응답

Name	형식	Description
code	string	오류 코드입니다. 이것은 프로그래밍 방식으로 사용할 수 있는 니모닉입니다.
message	string	사용자에게 친숙한 오류 메시지입니다. 메시지는 일반적으로 현지화되며 서비스 버전에 따라 다를 수 있습니다.

KeyPermissions

열거형

키에 대한 권한

값	Description
all
encrypt
decrypt
wrapKey
unwrapKey
sign
verify
get
list
create
update
import
delete
backup
restore
recover
purge
release
rotate
getrotationpolicy
setrotationpolicy

Permissions

Object

ID가 키, 비밀, 인증서 및 스토리지에 대해 갖는 권한입니다.

Name	형식	Description
certificates	CertificatePermissions[]	인증서에 대한 권한
keys	KeyPermissions[]	키에 대한 권한
secrets	SecretPermissions[]	비밀에 대한 권한
storage	StoragePermissions[]	스토리지 계정에 대한 권한

SecretPermissions

열거형

비밀에 대한 권한

값	Description
all
get
list
set
delete
backup
restore
recover
purge

StoragePermissions

열거형

스토리지 계정에 대한 권한

값	Description
all
get
list
delete
set
update
regeneratekey
recover
purge
backup
restore
setsas
listsas
getsas
deletesas

VaultAccessPolicyParameters

Object

볼트에서 액세스 정책을 업데이트하기 위한 매개변수

Name	형식	Description
id	string	액세스 정책의 리소스 ID입니다.
location	string	액세스 정책의 리소스 유형입니다.
name	string	액세스 정책의 리소스 이름입니다.
properties	VaultAccessPolicyProperties	액세스 정책의 속성
type	string	액세스 정책의 리소스 이름입니다.

VaultAccessPolicyProperties

Object

볼트 액세스 정책의 속성

Name	형식	Description
accessPolicies	AccessPolicyEntry[]	키 자격 증명 모음에 액세스할 수 있는 0~16개 ID의 배열입니다. 배열의 모든 ID는 키 자격 증명 모음의 테넌트 ID와 동일한 테넌트 ID를 사용해야 합니다.