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
# Update Azure Recovery Services Vault configurations using REST API
9
9
10
+
This article describes how to update backup related configurations in Azure Recovery Services vault using REST API.
11
+
10
12
## Soft delete state
11
13
12
-
Deleting backups of a protected item is significant operation that has to be monitored. To protect against accidental deletions, Azure Recovery services vault has a soft-delete capability. This capability allows customers to restore deleted backups, if necessary, within a time period after the deletion.
14
+
Deleting backups of a protected item is a significant operation that has to be monitored. To protect against accidental deletions, Azure Recovery Services vault has a soft-delete capability. This capability allows customers to restore deleted backups, if necessary, within a time period after the deletion.
13
15
14
-
But there are scenarios in which this capability is not required. A Recovery Services vault cannot be deleted if there are backup items within it, even soft-deleted ones. This may pose a problem if the vault needs to be immediately deleted. For for example: often, deployment operations clean up the created resources in the same workflow. A deployment can create a vault, configure backups for an item, do a test restore and then proceed to delete the backup items and the vault. If the vault deletion fails, the entire deployment might fail. Disabling soft-delete is the only way to guarantee immediate deletion.
16
+
But there are scenarios in which this capability is not required. An Azure Recovery Services vault cannot be deleted if there are backup items within it, even soft-deleted ones. This may pose a problem if the vault needs to be immediately deleted. For for example: deployment operations often clean up the created resources in the same workflow. A deployment can create a vault, configure backups for an item, do a test restore and then proceed to delete the backup items and the vault. If the vault deletion fails, the entire deployment might fail. Disabling soft-delete is the only way to guarantee immediate deletion.
15
17
16
18
Hence, the customer needs to carefully choose whether or not to disable soft-delete for a particular vault depending on the scenario. For more information, see the [soft-delete article](backup-azure-security-feature-cloud.md#soft-delete).
17
19
18
20
### Fetch soft delete state using REST API
19
21
20
-
By default, the soft-delete state will be enabled for any newly created Recovery services vault. To fetch/update the state of soft-delete for a vault, use the backup vault's config related [REST API document](https://docs.microsoft.com/rest/api/backup/backupresourcevaultconfigs)
22
+
By default, the soft-delete state will be enabled for any newly created Recovery Services vault. To fetch/update the state of soft-delete for a vault, use the backup vault's config related [REST API document](https://docs.microsoft.com/rest/api/backup/backupresourcevaultconfigs)
21
23
22
24
To fetch the current state of soft-delete for a vault, use the following *GET* operation
23
25
24
26
```http
25
27
GET https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig?api-version=2019-05-13
26
28
```
27
29
28
-
The GET URI has `{subscriptionId}`, `{vaultName}`, `{vaultresourceGroupName}` parameters. Let us take an example, `{vaultName}` is "testVault" and `{vaultresourceGroupName}` is "testVaultRG". As all the required parameters are given in the URI, there is no need for a separate request body.
30
+
The GET URI has `{subscriptionId}`, `{vaultName}`, `{vaultresourceGroupName}` parameters. In this example, `{vaultName}` is "testVault" and `{vaultresourceGroupName}` is "testVaultRG". As all the required parameters are given in the URI, there is no need for a separate request body.
29
31
30
32
```http
31
33
GET https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testVaultRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupconfig/vaultconfig?api-version=2019-05-13
32
34
```
33
35
34
36
#### Responses
35
37
36
-
The successful responses for the 'GET' operation is shown below:
38
+
The successful response for the 'GET' operation is shown below:
37
39
38
40
|Name |Type |Description |
39
41
|---------|---------|---------|
@@ -63,7 +65,7 @@ To update the soft-delete state of the recovery services vault using REST API, u
The PATCH URI has `{subscriptionId}`, `{vaultName}`, `{vaultresourceGroupName}` parameters. Let us take an example, `{vaultName}` is "testVault" and `{vaultresourceGroupName}` is "testVaultRG". If we replace the URI with above values, then the URI will look like this.
68
+
The PATCH URI has `{subscriptionId}`, `{vaultName}`, `{vaultresourceGroupName}` parameters. In this example, `{vaultName}` is "testVault" and `{vaultresourceGroupName}` is "testVaultRG". If we replace the URI with the values above, then the URI will look like this.
0 commit comments