Delete Secret - Delete Secret

참조

Service:: Key Vault

API Version:: 7.4

지정된 키 자격 증명 모음에서 비밀을 삭제합니다.
DELETE 작업은 Azure 키 자격 증명 모음에 저장된 모든 암호에 적용됩니다. 개별 암호 버전에는 DELETE를 적용할 수 없습니다. 이 작업을 수행하려면 비밀/삭제 권한이 필요합니다.

DELETE {vaultBaseUrl}/secrets/{secret-name}?api-version=7.4

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
secret-name	path	True	string	비밀의 이름입니다.
vaultBaseUrl	path	True	string	자격 증명 모음 이름(예 https://myvault.vault.azure.net: )입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

응답

Name	형식	Description
200 OK	DeletedSecretBundle	삭제된 비밀 및 비밀 삭제 시기 및 삭제된 비밀을 복구하는 방법에 대한 정보입니다.
Other Status Codes	KeyVaultError	작업이 실패한 이유를 설명하는 오류 응답을 Key Vault.

예제

DeleteSecret

Sample Request

HTTP

DELETE https://myvault.vault.azure.net//secrets/GetDeletedSecretTest?api-version=7.4

Sample Response

Status code:: 200

{
  "recoveryId": "https://myvault.vault.azure.net/deletedsecrets/GetDeletedSecretTest",
  "deletedDate": 1493938433,
  "scheduledPurgeDate": 1501714433,
  "id": "https://myvault.vault.azure.net/secrets/GetDeletedSecretTest/b595353d9c39413d80626575b3b5d865",
  "attributes": {
    "enabled": true,
    "created": 1493938433,
    "updated": 1493938433,
    "recoveryLevel": "Recoverable+Purgeable"
  }
}

정의

Name	Description
DeletedSecretBundle	삭제된 비밀은 이전 ID, 특성 및 태그뿐만 아니라 제거될 시기에 대한 정보로 구성됩니다.
DeletionRecoveryLevel	현재 자격 증명 모음의 비밀에 대해 현재 적용 중인 삭제 복구 수준을 반영합니다. '제거 가능'이 포함된 경우 권한 있는 사용자가 비밀을 영구적으로 삭제할 수 있습니다. 그렇지 않으면 시스템에서만 보존 간격이 끝날 때 비밀을 제거할 수 있습니다.
Error	키 자격 증명 모음 서버 오류입니다.
KeyVaultError	키 자격 증명 모음 오류 예외입니다.
SecretAttributes	비밀 관리 특성입니다.

DeletedSecretBundle

삭제된 비밀은 이전 ID, 특성 및 태그뿐만 아니라 제거될 시기에 대한 정보로 구성됩니다.

Name	형식	Description
attributes	SecretAttributes	비밀 관리 특성입니다.
contentType	string	비밀의 콘텐츠 형식입니다.
deletedDate	integer	비밀이 삭제된 시간(UTC)
id	string	비밀 ID입니다.
kid	string	KV 인증서를 지원하는 비밀인 경우 이 필드는 KV 인증서를 지원하는 해당 키를 지정합니다.
managed	boolean	True이면 비밀의 수명이 키 자격 증명 모음에서 관리됩니다. 인증서를 지원하는 비밀인 경우 관리되는 것은 true입니다.
recoveryId	string	삭제된 비밀을 식별하고 복구하는 데 사용되는 복구 개체의 URL입니다.
scheduledPurgeDate	integer	비밀이 제거되도록 예약된 시간(UTC)
tags	object	키/값 쌍 형식의 애플리케이션 특정 메타데이터입니다.
value	string	비밀 값입니다.

DeletionRecoveryLevel

현재 자격 증명 모음의 비밀에 대해 현재 적용 중인 삭제 복구 수준을 반영합니다. '제거 가능'이 포함된 경우 권한 있는 사용자가 비밀을 영구적으로 삭제할 수 있습니다. 그렇지 않으면 시스템에서만 보존 간격이 끝날 때 비밀을 제거할 수 있습니다.

Name	형식	Description
CustomizedRecoverable	string	즉시 영구 삭제할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다(즉, 7<= SoftDeleteRetentionInDays < 90일 때 제거). 이 수준은 보존 간격 동안 및 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다.
CustomizedRecoverable+ProtectedSubscription	string	삭제가 복구 가능하고 즉시 영구 삭제(즉, 제거)가 허용되지 않으며 7<= SoftDeleteRetentionInDays < 90일 때 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 이 수준은 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장하며 구독 자체를 취소할 수 없다는 사실도 반영합니다.
CustomizedRecoverable+Purgeable	string	삭제를 복구할 수 있는 자격 증명 모음 상태를 표시하며 즉시 영구 삭제를 허용합니다(즉, 7<= SoftDeleteRetentionInDays < 90일 때 제거). 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격 동안 삭제된 엔터티의 복구 가능성을 보장합니다.
Purgeable	string	복구 가능성 없이 삭제가 되돌릴 수 없는 작업인 자격 증명 모음 상태를 표시합니다. 이 수준은 삭제 작업에 대해 사용할 수 있는 보호가 없음에 해당합니다. 엔터티 수준 이상(자격 증명 모음, 리소스 그룹, 구독 등)에서 삭제 작업을 수락하면 데이터가 돌이킬 수 없이 손실됩니다.
Recoverable	string	즉시 영구 삭제(즉, 제거)할 가능성 없이 삭제를 복구할 수 있는 자격 증명 모음 상태를 나타냅니다. 이 수준은 보존 간격(90일) 동안 및 구독을 계속 사용할 수 있는 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 복구되지 않은 경우 시스템은 90일 후에 영구적으로 삭제합니다.
Recoverable+ProtectedSubscription	string	보존 간격(90일) 내에 삭제를 복구할 수 있고, 즉시 영구 삭제(즉, 제거)가 허용되지 않으며, 구독 자체를 영구적으로 취소할 수 없는 자격 증명 모음 및 구독 상태를 나타냅니다. 복구되지 않은 경우 시스템은 90일 후에 영구적으로 삭제합니다.
Recoverable+Purgeable	string	삭제를 복구할 수 있고 즉시 영구 삭제(즉, 제거)도 허용하는 자격 증명 모음 상태를 나타냅니다. 이 수준은 제거 작업이 요청되거나 구독이 취소되지 않는 한 보존 간격(90일) 동안 삭제된 엔터티의 복구 가능성을 보장합니다. 복구되지 않은 경우 시스템은 90일 후에 영구적으로 삭제합니다.

Error

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

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

KeyVaultError

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

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

SecretAttributes

비밀 관리 특성입니다.

Name	형식	Description
created	integer	생성 시간(UTC)입니다.
enabled	boolean	개체를 사용할 수 있는지 여부를 확인합니다.
exp	integer	만료 날짜(UTC)입니다.
nbf	integer	UTC에서 날짜 이전이 아닙니다.
recoverableDays	integer	softDelete 데이터 보존 일수입니다. softDelete를 사용하도록 설정하면 값이 =7이고 <=90이어야 합니다. 그렇지 않으면 0입니다>.
recoveryLevel	DeletionRecoveryLevel	현재 자격 증명 모음의 비밀에 대해 현재 적용 중인 삭제 복구 수준을 반영합니다. '제거 가능'이 포함된 경우 권한 있는 사용자가 비밀을 영구적으로 삭제할 수 있습니다. 그렇지 않으면 시스템에서만 보존 간격이 끝날 때 비밀을 제거할 수 있습니다.
updated	integer	마지막으로 업데이트된 시간(UTC)입니다.

Share via