Skip to content

Commit 82cabf3

Browse files
committed
Updated docs to indicate that soft-delete is now enabled by default
1 parent a39cebd commit 82cabf3

File tree

1 file changed

+34
-41
lines changed

1 file changed

+34
-41
lines changed

articles/key-vault/key-vault-ovw-soft-delete.md

Lines changed: 34 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,38 +8,54 @@ manager: rkarlin
88
ms.date: 03/19/2019
99
---
1010

11-
# Azure Key Vault soft-delete overview
11+
# Azure Key Vault soft-delete and purge protection overview
1212

13-
Key Vault's soft delete feature allows recovery of the deleted vaults and vault objects, known as soft-delete. Specifically, we address the following scenarios:
13+
Key Vault's soft delete feature enables the recovery of deleted vaults and vault objects.
1414

15-
- Support for recoverable deletion of a key vault
16-
- Support for recoverable deletion of key vault objects (ex. keys, secrets, certificates)
15+
Azure Key Vaults are tracked resources, managed by Azure Resource Manager. Azure Resource Manager also specifies a well-defined behavior for deletion, which requires that a successful DELETE operation must result in that resource not being accessible anymore. The soft-delete feature addresses the recovery of the deleted object, whether the deletion was accidental or intentional
1716

18-
## Supporting interfaces
17+
In the typical scenario, a user may have inadvertently deleted a key vault or a key vault object; if that key vault or key vault object were to be recoverable for a predetermined period, the user may undo the deletion and recover their data.
1918

20-
The soft-delete feature is initially available through the [REST](/rest/api/keyvault/), [CLI](key-vault-soft-delete-cli.md), [PowerShell](key-vault-soft-delete-powershell.md) and [.NET/C#](/dotnet/api/microsoft.azure.keyvault?view=azure-dotnet) interfaces.
19+
In a different scenario, a rogue user may attempt to delete a key vault or a key vault object, such as a key inside a vault, to cause a business disruption. Separating the deletion of the key vault or key vault object from the actual deletion of the underlying data can be used as a safety measure by, for instance, restricting permissions on data deletion to a different, trusted role. This approach effectively requires quorum for an operation which might otherwise result in an immediate data loss.
2120

22-
## Scenarios
21+
Unless purge protection is on, a user can permanently delete a soft-deleted key vault or key vault object by performing a purge operation on it. Purge operations are not allowed when purge protection is enabled.
2322

24-
Azure Key Vaults are tracked resources, managed by Azure Resource Manager. Azure Resource Manager also specifies a well-defined behavior for deletion, which requires that a successful DELETE operation must result in that resource not being accessible anymore. The soft-delete feature addresses the recovery of the deleted object, whether the deletion was accidental or intentional.
23+
## Soft-delete
2524

26-
1. In the typical scenario, a user may have inadvertently deleted a key vault or a key vault object; if that key vault or key vault object were to be recoverable for a predetermined period, the user may undo the deletion and recover their data.
25+
When soft-delete is enabled, resources marked as deleted are retained for a specified period (90 days by default). The service further provides a mechanism for recovering the deleted object, essentially undoing the deletion.
2726

28-
2. In a different scenario, a rogue user may attempt to delete a key vault or a key vault object, such as a key inside a vault, to cause a business disruption. Separating the deletion of the key vault or key vault object from the actual deletion of the underlying data can be used as a safety measure by, for instance, restricting permissions on data deletion to a different, trusted role. This approach effectively requires quorum for an operation which might otherwise result in an immediate data loss.
27+
When creating a new key vault through the portal, soft-delete is on by default; when creating a key vault through the [Azure CLI](key-vault-soft-delete-cli.md) or [Azure Powershell](key-vault-soft-delete-powershell.md), see [CLI: Enabling soft-delete](key-vault-soft-delete-cli.md#enabling-soft-delete) or [PowreShell: Enabling soft-delete](key-vault-soft-delete-powershell.md#enabling-soft-delete).
2928

30-
### Soft-delete behavior
29+
Once soft-delete is enabled on a key vault it cannot be disabled
3130

32-
With this feature, the DELETE operation on a key vault or key vault object is a soft-delete, effectively holding the resources for a given retention period (90 days), while giving the appearance that the object is deleted. The service further provides a mechanism for recovering the deleted object, essentially undoing the deletion.
31+
The default retention period is 90 days but, during key vault creation, it is possible to set the retention policy interval to a value from 7 to 90 days through the Azure portal. The purge protection retention policy uses the same interval. Once set, the retention policy interval cannot be changed.
3332

34-
Soft-delete is now on by default for newly created key vaults. It can be disabled through the [Azure CLI](key-vault-soft-delete-cli.md) or [Azure Powershell](key-vault-soft-delete-powershell.md).
33+
You cannot reuse the name of a key vault that has been soft-deleted until the retention period has passed.
3534

36-
The default retention period is 90 days, but it is possible to set the retention policy interval to a value from 7 to 90 days through the Azure portal. The purge protection retention policy uses the same interval.
35+
### Soft-delete retention period
36+
37+
Soft deleted resources are retained for a set period of time, 90 days. During the soft-delete retention interval, the following apply:
38+
39+
- You may list all of the key vaults and key vault objects in the soft-delete state for your subscription as well as access deletion and recovery information about them.
40+
- Only users with special permissions can list deleted vaults. We recommend that our users create a custom role with these special permissions for handling deleted vaults.
41+
- A key vault with the same name cannot be created in the same location; correspondingly, a key vault object cannot be created in a given vault if that key vault contains an object with the same name and which is in a deleted state
42+
- Only a specifically privileged user may restore a key vault or key vault object by issuing a recover command on the corresponding proxy resource.
43+
- The user, member of the custom role, who has the privilege to create a key vault under the resource group can restore the vault.
44+
- Only a specifically privileged user may forcibly delete a key vault or key vault object by issuing a delete command on the corresponding proxy resource.
3745

38-
Once soft-delete has been set on a key vault it cannot be disabled, and the retention policy interval cannot be changed.
46+
Unless a key vault or key vault object is recovered, at the end of the retention interval the service performs a purge of the soft-deleted key vault or key vault object and its content. Resource deletion may not be rescheduled.
47+
48+
## Recovery
49+
50+
Upon deleting a key vault, the service creates a proxy resource under the subscription, adding sufficient metadata for recovery. The proxy resource is a stored object, available in the same location as the deleted key vault.
51+
52+
### Key vault object recovery
3953

40-
You cannot reuse the name of a key vault that has been soft-deleted until the retention period has passed.
54+
Upon deleting a key vault object, such as a key, the service will place the object in a deleted state, making it inaccessible to any retrieval operations. While in this state, the key vault object can only be listed, recovered, or forcefully/permanently deleted.
55+
56+
At the same time, Key Vault will schedule the deletion of the underlying data corresponding to the deleted key vault or key vault object for execution after a predetermined retention interval. The DNS record corresponding to the vault is also retained for the duration of the retention interval.
4157

42-
### Purge protection
58+
## Purge protection
4359

4460
Purge protection is an optional Key Vault behavior and is **not enabled by default**. It can be turned on via [CLI](key-vault-soft-delete-cli.md#enabling-purge-protection) or [Powershell](key-vault-soft-delete-powershell.md#enabling-purge-protection).
4561

@@ -55,30 +71,7 @@ Exceptions are:
5571
- When the Azure subscription has been marked as *undeletable*. In this case, only the service may then perform the actual deletion, and does so as a scheduled process.
5672
- When the --enable-purge-protection flag is enabled on the vault itself. In this case, Key Vault will wait for 90 days from when the original secret object was marked for deletion to permanently delete the object.
5773

58-
### Key vault recovery
59-
60-
Upon deleting a key vault, the service creates a proxy resource under the subscription, adding sufficient metadata for recovery. The proxy resource is a stored object, available in the same location as the deleted key vault.
61-
62-
### Key vault object recovery
63-
64-
Upon deleting a key vault object, such as a key, the service will place the object in a deleted state, making it inaccessible to any retrieval operations. While in this state, the key vault object can only be listed, recovered, or forcefully/permanently deleted.
65-
66-
At the same time, Key Vault will schedule the deletion of the underlying data corresponding to the deleted key vault or key vault object for execution after a predetermined retention interval. The DNS record corresponding to the vault is also retained for the duration of the retention interval.
67-
68-
### Soft-delete retention period
69-
70-
Soft deleted resources are retained for a set period of time, 90 days. During the soft-delete retention interval, the following apply:
71-
72-
- You may list all of the key vaults and key vault objects in the soft-delete state for your subscription as well as access deletion and recovery information about them.
73-
- Only users with special permissions can list deleted vaults. We recommend that our users create a custom role with these special permissions for handling deleted vaults.
74-
- A key vault with the same name cannot be created in the same location; correspondingly, a key vault object cannot be created in a given vault if that key vault contains an object with the same name and which is in a deleted state
75-
- Only a specifically privileged user may restore a key vault or key vault object by issuing a recover command on the corresponding proxy resource.
76-
- The user, member of the custom role, who has the privilege to create a key vault under the resource group can restore the vault.
77-
- Only a specifically privileged user may forcibly delete a key vault or key vault object by issuing a delete command on the corresponding proxy resource.
78-
79-
Unless a key vault or key vault object is recovered, at the end of the retention interval the service performs a purge of the soft-deleted key vault or key vault object and its content. Resource deletion may not be rescheduled.
80-
81-
### Billing implications
74+
## Billing implications
8275

8376
In general, when an object (a key vault or a key or a secret) is in deleted state, there are only two operations possible: 'purge' and 'recover'. All the other operations will fail. Therefore, even though the object exists, no operations can be performed and hence no usage will occur, so no bill. However there are following exceptions:
8477

0 commit comments

Comments
 (0)