使用 REST API 更新 Azure 恢复服务保管库配置
本文介绍如何使用 REST API 更新 Azure 恢复服务保管库中与备份相关的配置。
软删除状态
删除受保护项的备份是一项必须加以监视的重要操作。 为防止意外删除,Azure 恢复服务保管库具有软删除功能。 此功能允许你在删除备份后的某个时间段内还原已删除的备份(如有必要)。
但在某些情况下,不需要此功能。 如果 Azure 恢复服务保管库包含备份项,即使是软删除的备份项,也无法删除该保管库。 如果需要立即删除保管库,这可能会导致出现问题。 例如:部署操作通常会删除同一工作流中的已创建资源。 部署操作可以创建保管库,为项配置备份,执行测试还原,然后继续删除备份项和保管库。 如果保管库删除失败,则整个部署也可能会失败。 禁用软删除是确保立即删除的唯一方法。
因此,需要根据具体场景谨慎选择对特定保管库禁用软删除功能。 详细了解软删除。
使用 REST API 获取软删除状态
默认情况下,将为任何新建的恢复服务保管库启用软删除状态。 若要获取/更新保管库的软删除状态,请查看与备份保管库的配置相关的 REST API 文档
若要获取保管库的当前软删除状态,请使用以下 GET 操作
GET https://management.chinacloudapi.cn/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig?api-version=2019-06-15
GET URI 包含参数 {subscriptionId}
、{vaultName}
和 {vaultresourceGroupName}
。 在本示例中,{vaultName}
是“testVault”,{vaultresourceGroupName}
是“testVaultRG”。 由于 URI 中给出了所有必需的参数,因此不需要单独的请求正文。
GET https://management.chinacloudapi.cn/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testVaultRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupconfig/vaultconfig?api-version=2019-06-15
响应
GET 操作的成功响应如下所示:
名称 | Type | 说明 |
---|---|---|
200 正常 | BackupResourceVaultConfig | OK |
示例响应
提交 GET 请求后,将返回 200(成功)响应。
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvaultRG/providers/Microsoft.RecoveryServices/vaults/testvault/backupconfig/vaultconfig",
"name": "vaultconfig",
"type": "Microsoft.RecoveryServices/vaults/backupconfig",
"properties": {
"enhancedSecurityState": "Enabled",
"softDeleteFeatureState": "Enabled"
}
}
使用 REST API 更新软删除状态
若要使用 REST API 更新恢复服务保管库的软删除状态,请使用以下 PUT 操作
PUT https://management.chinacloudapi.cn/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig?api-version=2019-06-15
PUT URI 包含参数 {subscriptionId}
、{vaultName}
和 {vaultresourceGroupName}
。 在本示例中,{vaultName}
是“testVault”,{vaultresourceGroupName}
是“testVaultRG”。 如果将 URI 替换为上述值,则 URI 将如下所示。
PUT https://management.chinacloudapi.cn/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testVaultRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupconfig/vaultconfig?api-version=2019-06-15
创建请求正文
以下通用定义用于创建请求正文
有关详细信息,请参阅 REST API 文档
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
eTag | String | 可选的 eTag | |
location | 是 | String | 资源位置 |
properties | VaultProperties | 保管库的属性 | |
tags | Object | 资源标记 |
示例请求正文
使用以下示例,将软删除状态更新为“禁用”。
{
"properties": {
"enhancedSecurityState": "Enabled",
"softDeleteFeatureState": "Disabled"
}
}
PATCH 操作的响应
PATCH 操作的成功响应如下所示:
名称 | Type | 说明 |
---|---|---|
200 正常 | BackupResourceVaultConfig | OK |
PATCH 操作的响应示例
提交 PATCH 请求后,将返回 200 (成功)响应。
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testvaultRG/providers/Microsoft.RecoveryServices/vaults/testvault/backupconfig/vaultconfig",
"name": "vaultconfig",
"type": "Microsoft.RecoveryServices/vaults/backupconfig",
"properties": {
"enhancedSecurityState": "Enabled",
"softDeleteFeatureState": "Disabled"
}
}
后续步骤
有关 Azure REST API 的详细信息,请参阅以下文档: