You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/key-vault/general/customer-data.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ The following information identifies customer data within Azure Key Vault:
36
36
37
37
The same REST APIs, Portal experience, and SDKs used to create vaults, keys, secrets, certificates, and managed storage accounts, are also able to update and delete these objects.
38
38
39
-
Softdelete allows you to recover deleted data for 90 days after deletion. When using softdelete, the data may be permanently deleted prior to the 90 days retention period expires by performing a purge operation. If the vault or subscription has been configured to block purge operations, it is not possible to permanently delete data until the scheduled retention period has passed.
39
+
Soft-delete allows you to recover deleted data for 90 days after deletion. When using soft-delete, the data may be permanently deleted prior to the 90 days retention period expires by performing a purge operation. If the vault or subscription has been configured to block purge operations, it is not possible to permanently delete data until the scheduled retention period has passed.
Copy file name to clipboardExpand all lines: articles/key-vault/general/overview-soft-delete.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Azure Key Vault softdelete | Microsoft Docs
2
+
title: Azure Key Vault soft-delete | Microsoft Docs
3
3
description: Soft-delete in Azure Key Vault allows you to recover deleted key vaults and key vault objects, such as keys, secrets, and certificates.
4
4
ms.service: key-vault
5
5
ms.subservice: general
@@ -12,7 +12,7 @@ ms.date: 03/19/2019
12
12
13
13
# Azure Key Vault soft-delete overview
14
14
15
-
Key Vault's softdelete feature allows recovery of the deleted vaults and vault objects, known as soft-delete. Specifically, we address the following scenarios:
15
+
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:
16
16
17
17
- Support for recoverable deletion of a key vault
18
18
- Support for recoverable deletion of key vault objects (ex. keys, secrets, certificates)
@@ -33,15 +33,15 @@ Azure Key Vaults are tracked resources, managed by Azure Resource Manager. Azure
33
33
34
34
When soft-delete is enabled, resources marked as deleted resources 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.
35
35
36
-
When creating a new key vault, soft-delete is on by default. You can create a key vault without soft-delete through the [Azure CLI](soft-delete-cli.md) or [Azure Powershell](soft-delete-powershell.md). Once soft-delete is enabled on a key vault it cannot be disabled
36
+
When creating a new key vault, soft-delete is on by default. You can create a key vault without soft-delete through the [Azure CLI](soft-delete-cli.md) or [Azure PowerShell](soft-delete-powershell.md). Once soft-delete is enabled on a key vault it cannot be disabled
37
37
38
38
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.
39
39
40
40
You cannot reuse the name of a key vault that has been soft-deleted until the retention period has passed.
41
41
42
42
### Purge protection
43
43
44
-
Purge protection is an optional Key Vault behavior and is **not enabled by default**. It can be turned on via [CLI](soft-delete-cli.md#enabling-purge-protection) or [Powershell](soft-delete-powershell.md#enabling-purge-protection).
44
+
Purge protection is an optional Key Vault behavior and is **not enabled by default**. It can be turned on via [CLI](soft-delete-cli.md#enabling-purge-protection) or [PowerShell](soft-delete-powershell.md#enabling-purge-protection).
45
45
46
46
When purge protection is on, a vault or an object in the deleted state cannot be purged until the retention period has passed. Soft-deleted vaults and objects can still be recovered, ensuring that the retention policy will be followed.
47
47
@@ -53,7 +53,7 @@ Permanently deleting, purging, a key vault is possible via a POST operation on t
53
53
54
54
Exceptions are:
55
55
- 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.
56
-
- 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.
56
+
- 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.
57
57
58
58
### Key vault recovery
59
59
@@ -67,7 +67,7 @@ At the same time, Key Vault will schedule the deletion of the underlying data co
67
67
68
68
### Soft-delete retention period
69
69
70
-
Softdeleted resources are retained for a set period of time, 90 days. During the soft-delete retention interval, the following apply:
70
+
Soft-deleted resources are retained for a set period of time, 90 days. During the soft-delete retention interval, the following apply:
71
71
72
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
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.
**Guidance**: Use Managed Service Identity in conjunction with Azure Key Vault to simplify and secure secret management for your cloud applications. Ensure that Azure Key Vault softdelete is enabled.
1003
+
**Guidance**: Use Managed Service Identity in conjunction with Azure Key Vault to simplify and secure secret management for your cloud applications. Ensure that Azure Key Vault soft-delete is enabled.
1004
1004
1005
1005
How to integrate with Azure Managed Identities:
1006
1006
@@ -1176,7 +1176,7 @@ How to restore Key Vault Secrets: https://docs.microsoft.com/powershell/module/a
1176
1176
1177
1177
### 9.4: Ensure protection of backups and customer managed keys
1178
1178
1179
-
**Guidance**: Ensure that softdelete is enabled for Azure Key Vault. Softdelete allows recovery of deleted key vaults and vault objects such as keys, secrets, and certificates.
1179
+
**Guidance**: Ensure that soft-delete is enabled for Azure Key Vault. Soft-delete allows recovery of deleted key vaults and vault objects such as keys, secrets, and certificates.
Copy file name to clipboardExpand all lines: articles/key-vault/general/soft-delete-cli.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Azure Key Vault - How to use softdelete with CLI
2
+
title: Azure Key Vault - How to use soft-delete with CLI
3
3
description: Use case examples of soft-delete with CLI code snips
4
4
services: key-vault
5
5
author: msmbaldwin
@@ -13,7 +13,7 @@ ms.author: mbaldwin
13
13
---
14
14
# How to use Key Vault soft-delete with CLI
15
15
16
-
Azure Key Vault's softdelete feature allows recovery of deleted vaults and vault objects. Specifically, soft-delete addresses the following scenarios:
16
+
Azure Key Vault's soft-delete feature allows recovery of deleted vaults and vault objects. Specifically, soft-delete addresses the following scenarios:
17
17
18
18
- Support for recoverable deletion of a key vault
19
19
- Support for recoverable deletion of key vault objects; keys, secrets, and, certificates
@@ -41,7 +41,7 @@ For more information on permissions and access control, see [Secure your key vau
41
41
You enable "soft-delete" to allow recovery of a deleted key vault, or objects stored in a key vault.
42
42
43
43
> [!IMPORTANT]
44
-
> Enabling 'softdelete' on a key vault is an irreversible action. Once the soft-delete property has been set to "true", it cannot be changed or removed.
44
+
> Enabling 'soft-delete' on a key vault is an irreversible action. Once the soft-delete property has been set to "true", it cannot be changed or removed.
45
45
46
46
### Existing key vault
47
47
@@ -226,13 +226,13 @@ When purge protection is turned on, a vault or an object in deleted state cannot
226
226
227
227
You can enable purge protection only if soft-delete is also enabled.
228
228
229
-
To turn on both softdelete and purge protection when creating a vault, use the [az keyvault create](/cli/azure/keyvault?view=azure-cli-latest#az-keyvault-create) command:
229
+
To turn on both soft-delete and purge protection when creating a vault, use the [az keyvault create](/cli/azure/keyvault?view=azure-cli-latest#az-keyvault-create) command:
To add purge protection to an existing vault (that already has softdelete enabled), use the [az keyvault update](/cli/azure/keyvault?view=azure-cli-latest#az-keyvault-update) command:
235
+
To add purge protection to an existing vault (that already has soft-delete enabled), use the [az keyvault update](/cli/azure/keyvault?view=azure-cli-latest#az-keyvault-update) command:
236
236
237
237
```azurecli
238
238
az keyvault update --name ContosoVault --resource-group ContosoRG --enable-purge-protection true
Copy file name to clipboardExpand all lines: articles/key-vault/general/soft-delete-powershell.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ ms.author: mbaldwin
14
14
15
15
# How to use Key Vault soft-delete with PowerShell
16
16
17
-
Azure Key Vault's softdelete feature allows recovery of deleted vaults and vault objects. Specifically, soft-delete addresses the following scenarios:
17
+
Azure Key Vault's soft-delete feature allows recovery of deleted vaults and vault objects. Specifically, soft-delete addresses the following scenarios:
18
18
19
19
- Support for recoverable deletion of a key vault
20
20
- Support for recoverable deletion of key vault objects; keys, secrets, and, certificates
@@ -50,7 +50,7 @@ For more information on permissions and access control, see [Secure your key vau
50
50
You enable "soft-delete" to allow recovery of a deleted key vault, or objects stored in a key vault.
51
51
52
52
> [!IMPORTANT]
53
-
> Enabling 'softdelete' on a key vault is an irreversible action. Once the soft-delete property has been set to "true", it cannot be changed or removed.
53
+
> Enabling 'soft-delete' on a key vault is an irreversible action. Once the soft-delete property has been set to "true", it cannot be changed or removed.
54
54
55
55
### Existing key vault
56
56
@@ -266,13 +266,13 @@ When purge protection is turned on, a vault or an object in deleted state cannot
266
266
267
267
You can enable purge protection only if soft-delete is also enabled.
268
268
269
-
To turn on both softdelete and purge protection when creating a vault, use the [New-AzKeyVault](/powershell/module/az.keyvault/new-azkeyvault?view=azps-1.5.0) cmdlet:
269
+
To turn on both soft-delete and purge protection when creating a vault, use the [New-AzKeyVault](/powershell/module/az.keyvault/new-azkeyvault?view=azps-1.5.0) cmdlet:
To add purge protection to an existing vault (that already has softdelete enabled), use the [Get-AzKeyVault](/powershell/module/az.keyvault/Get-AzKeyVault?view=azps-1.5.0), [Get-AzResource](/powershell/module/az.resources/get-azresource?view=azps-1.5.0), and [Set-AzResource](/powershell/module/az.resources/set-azresource?view=azps-1.5.0) cmdlets:
275
+
To add purge protection to an existing vault (that already has soft-delete enabled), use the [Get-AzKeyVault](/powershell/module/az.keyvault/Get-AzKeyVault?view=azps-1.5.0), [Get-AzResource](/powershell/module/az.resources/get-azresource?view=azps-1.5.0), and [Set-AzResource](/powershell/module/az.resources/set-azresource?view=azps-1.5.0) cmdlets:
0 commit comments