使用 REST API 更新 Azure 復原服務保存庫設定
本文說明如何使用 REST API 來更新 Azure 復原服務保存庫中的備份相關設定。
虛刪除狀態
刪除受保護項目的備份是必須監視的重要作業。 為了防止意外刪除,Azure 復原服務保存庫具有虛刪除功能。 這項功能可讓您在刪除後的一段時間內,視需要還原已刪除的備份。
但在某些情況下不需要這項功能。 如果 Azure 復原服務保存庫中有備份項目,則無法加以刪除,即使是虛刪除項目也一樣。 如果必須立即刪除保存庫,這可能會造成問題。 例如:部署作業通常會在相同的工作流程中清除已建立的資源。 部署可以建立保存庫、設定項目的備份、執行測試還原,然後繼續刪除備份項目和保存庫。 如果保存庫刪除失敗,則整個部署可能會失敗。 停用虛刪除是保證立即刪除的唯一方法。
因此,您必須仔細選擇根據案例停用特定保存庫的虛刪除功能。 深入瞭解 虛刪除。
使用 REST API 擷取虛刪除狀態
根據預設,任何新建立的復原服務保存庫都會啟用虛刪除狀態。 若要擷取/更新保存庫的虛刪除狀態,請利用備份保存庫設定的相關 REST API 文件
若要擷取保存庫的目前虛刪除狀態,請利用下列 GET 作業
GET https://management.azure.com/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.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testVaultRG/providers/Microsoft.RecoveryServices/vaults/testVault/backupconfig/vaultconfig?api-version=2019-06-15
回覆
'GET' 作業的成功回應如下所示:
名稱 | 類型 | 描述 |
---|---|---|
200 OK | BackupResourceVaultConfig | 確定 |
範例回應
提交 '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.azure.com/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.azure.com/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 | true | String | 資源位置 |
內容 | VaultProperties | 保存庫的屬性 | |
標記 | Object | 資源標籤 |
要求本文範例
使用下列範例,將虛刪除狀態更新為 'disabled'。
{
"properties": {
"enhancedSecurityState": "Enabled",
"softDeleteFeatureState": "Disabled"
}
}
PATCH 作業的回應
'PATCH' 作業的成功回應如下所示:
名稱 | 類型 | 描述 |
---|---|---|
200 OK | BackupResourceVaultConfig | 確定 |
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 的詳細資訊,請參閱下列文件:
- Azure 復原服務提供者 REST API
- Get started with Azure REST API (開始使用 Azure REST API)