使用 REST API 管理 Azure VM 中的 SQL Server 資料庫

本文說明如何使用 REST API 管理及監視 Azure 備份 所備份的 SQL Server 資料庫。 您也可以使用 Azure CLI 和 Azure 入口網站 來管理 SQL 資料庫備份。

若要檢視我們今天支援的備份和還原案例,請參閱 支援矩陣。 常見問題請參見 常見問題。

監視工作

Azure 備份服務會觸發在背景執行的工作。 這包括觸發備份、還原作業和停用備份等情境。 您可以使用工作的識別碼進行追蹤。 深入瞭解 如何管理備份和還原作業。

從作業中擷取工作資訊

如觸發備份之類的作業,會在回應中傳回 jobID。

例如:觸發備份 REST API 作業的最後回應如下所示:

{
  "id": "cd2a3b13-d392-4e81-86ac-02ea91cc70b9",
  "name": "cd2a3b13-d392-4e81-86ac-02ea91cc70b9",
  "status": "Succeeded",
  "startTime": "2018-05-28T11:43:21.6516182Z",
  "endTime": "2018-05-28T11:43:21.6516182Z",
  "properties": {
    "objectType": "OperationStatusJobExtendedInfo",
    "jobId": "c22eca5d-0c1c-48a0-a40d-69bef708d92a"
  }
}

您可以透過 jobId 欄位識別備份作業,並使用 GET 要求依照本文所述內容追蹤。

追蹤工作

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}?api-version=2016-12-01

{jobName} 即是上面提及的 jobId。 回應為 200 (OK),其 [狀態] 欄位會指出作業的狀態。 當其為 [Completed] 或 [CompletedWithWarnings] 之後,[extendedInfo] 區段就會顯示出更多該工作的詳細資訊。

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/SQLServerSelfHost/providers/Microsoft.RecoveryServices/vaults/SQLServer2012/backupJobs/c22eca5d-0c1c-48a0-a40d-69bef708d92a?api-version=2016-12-01

回應

名稱 類型 描述
200 確定 JobResource 好的

回應範例

一旦提交 GET URI,就會傳回 200 回應。

HTTP/1.1 200 OK
Pragma: no-cache
X-Content-Type-Options: nosniff
x-ms-request-id: e057b496-8ceb-45b6-bd9e-367f7dd73d6d
x-ms-client-request-id: 1ffda117-b2c0-4a80-a9ba-43ba66eaec9b; 1ffda117-b2c0-4a80-a9ba-43ba66eaec9b
Strict-Transport-Security: max-age=31536000; includeSubDomains
x-ms-ratelimit-remaining-subscription-reads: 14999
x-ms-correlation-request-id: e057b496-8ceb-45b6-bd9e-367f7dd73d6d
x-ms-routing-request-id: SOUTHINDIA:20180528T115536Z:e057b496-8ceb-45b6-bd9e-367f7dd73d6d
Cache-Control: no-cache
Date: Mon, 28 May 2018 11:55:35 GMT
Server: Microsoft-IIS/8.0
X-Powered-By: ASP.NET

{
  "id": "/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/SQLServerSelfHost/providers/microsoft.recoveryservices/vaults/SQLServer2012/backupJobs/c22eca5d-0c1c-48a0-a40d-69bef708d92a",
  "name": "c22eca5d-0c1c-48a0-a40d-69bef708d92a",
  "type": "Microsoft.RecoveryServices/vaults/backupJobs",
  "properties": {
    "jobType": "AzureWorkloadJob",
    "workloadType": "SQLDataBase",
    "duration": "00:03:13.6439467",
    "actionsInfo": [
      1
    ],
    "errorDetails": [
      {
        "errorCode": 510008,
        "errorString": "Operation cancelled as a conflicting operation was already running on the same database.",
        "errorTitle": "OperationCancelledBecauseConflictingOperationRunningUserError",
        "recommendations": [
          "Please try again after sometime."
        ]
      }
    ],
    "extendedInfo": {
      "tasksList": [
        {
          "taskId": "Transfer data to vault",
          "status": "Failed"
        }
      ],
      "propertyBag": {
        "Data Transferred (in MB)": "0"
      }
    },
    "entityFriendlyName": "MSSQLSERVER/msDB [sqlserver-0.contoso.com]",
    "backupManagementType": "AzureWorkload",
    "operation": "Backup (Full)",
    "status": "Failed",
    "startTime": "2018-05-28T11:43:21.6516182Z",
    "endTime": "2018-05-28T11:46:35.2955649Z",
    "activityId": "6b033cf6-f875-4c03-8985-9add07ec2845"
  }
} 
}

列出受保護的 SQL 實例與資料庫

若要列出 SQL 實例及其資料庫以進行實例層級快照保護,請使用 API 版本 2024-01-31-preview。 用你的保險庫資料取代 URI 佔位符。 以下範例顯示了選取的回應欄位。

列出受保護的 SQL 實例

依 itemType eq 'SQLInstance' 篩選受保護項目:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems?api-version=2024-01-31-preview&$filter=backupManagementType eq 'AzureWorkload' and itemType eq 'SQLInstance'

回應包含一個 value 陣列。 每個實例包含其受保護的項目名稱、容器名稱、子資料庫及保護狀態。 例如:

{
  "value": [
    {
      "name": "SQLInstance;mssqlserver",
      "properties": {
        "childDBList": ["MSSQLSERVER;testdb", "MSSQLSERVER;testdb1", "MSSQLSERVER;testdb2"],
        "instanceProtectionReadiness": "Ready",
        "friendlyName": "mssqlserver",
        "serverName": "sqlserver-0",
        "protectedItemType": "AzureVmWorkloadSQLInstance",
        "backupManagementType": "AzureWorkload",
        "workloadType": "SQLInstance",
        "containerName": "VMAppContainer;Compute;SQLServerPMDemo;sqlserver-0",
        "protectionStatus": "Healthy",
        "protectionState": "IRPending",
        "protectedItemDataSourceId": "2265943933205758867"
      }
    }
  ]
}

將退回的容器和受保護的物品名稱保存,以備後續請求使用。 對於執行個體時間點還原查詢,也儲存protectedItemDataSourceId。

列出在實例下受保護的資料庫

列出保險庫中受保護的資料庫項目:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems?api-version=2024-01-31-preview&$filter=backupManagementType eq 'AzureWorkload' and itemType eq 'SQLDatabase'

在返回 value 的陣列中,識別將 protectionLevel 設為 DatabaseUnderInstance 的資料庫。 使用 parentProtectedItem,連同容器和伺服器細節,來識別父實例。 資料庫項目的屬性可以包括:

{
  "parentProtectedItem": "mssqlserver",
  "protectionLevel": "DatabaseUnderInstance",
  "friendlyName": "testdb",
  "serverName": "sqlserver-0",
  "parentName": "MSSQLSERVER",
  "protectedItemType": "AzureVmWorkloadSQLDatabase",
  "backupManagementType": "AzureWorkload",
  "workloadType": "SQLDataBase"
}

取得受保護的 SQL 執行個體

要取得一個實例,請使用其回傳的容器和受保護的項目名稱:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/Azure/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2024-01-31-preview

例如, {protectedItemName} 可以是 SQLInstance;mssqlserver。 回應包含 childDBList、 instanceProtectionReadiness、 和 protectionState。 如果項目排定為延遲刪除,請檢查 isScheduledForDeferredDelete、 deferredDeleteTimeInUTC以及 softDeleteRetentionPeriod 。

修改原則

若要變更資料庫的保護原則,請使用與啟用保護時相同的格式。 但是,請在請求主體中提供新的策略 ID,然後提交請求。 例如:若要將 testVM 的原則從 HourlyLogPolicy 變更為 ProdPolicy,請在要求本文中提供 ProdPolicy 識別碼。

{
  "properties": {
    "backupManagementType": "AzureWorkload",
    "workloadType": "SQLDataBase",
    "policyId": "/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/SQLServerSelfHost/providers/microsoft.recoveryservices/vaults/SQLServer2012/backupPolicies/ProdPolicy"
  },
  "location": "westcentralus"
}

回應會遵循如同啟用保護時所述的相同格式。

修改快照保護執行個體的原則

針對受保護的執行個體項目提交 PUT 要求,並提供新的快照原則 ID:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/Azure/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2024-01-31-preview
{
  "properties": {
    "backupManagementType": "AzureWorkload",
    "workloadType": "SQLInstance",
    "protectedItemType": "AzureVmWorkloadSQLInstance",
    "friendlyName": "MSSQLSERVER",
    "policyId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{newPolicyName}",
    "childDatabaseNameList": ["model"]
  }
}

替換 JSON 主體中的佔位符和 URI。 在 childDatabaseNameList 中使用實例中選取的資料庫名稱。

恢復 SQL 執行個體的備份

若要恢復備份,請向包含快照原則識別碼的執行個體受保護項目提交 PUT 要求。 以下範例使用空的 childDatabaseNameList 作為恢復操作:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/Azure/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2024-01-31-preview
{
  "properties": {
    "backupManagementType": "AzureWorkload",
    "workloadType": "SQLInstance",
    "protectedItemType": "AzureVmWorkloadSQLInstance",
    "friendlyName": "MSSQLSERVER",
    "policyId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/SQLInstanceSnapPolicy",
    "childDatabaseNameList": []
  }
}

使用執行個體受保護項目名稱,例如SQLInstance;mssqlserver,並將原則識別碼的預留位置替換成您的保存庫詳細資料。 追蹤產生的作業和工作,如監控工作中所述。

停止保護並保留現有資料

若要從受保護的資料庫移除保護並保留已備份的資料,請在您用來啟用備份的要求主體中移除該原則,並提交要求。 移除與原則的關聯之後,便不會再次觸發備份,且不會建立任何新的復原點。

{
  "properties": {
    "protectedItemType": "AzureVmWorkloadSQLDatabase",
    "protectionState": "ProtectionStopped",
    "sourceResourceId":
"/subscriptions/00000000-0000-0000-0000-0000000000/resourceGroups/SQLServerPMDemo/providers/Microsoft.Compute/virtualMachines/sqlserver-0",
    "policyId": ""
  }
}

範例回覆

停止對資料庫的保護,屬於非同步作業。 此作業會建立另一項需要追蹤的作業。 該作業會傳回兩個回應:在建立另一項作業時傳回 202 (Accepted),並在該作業完成時傳回 200。

成功接受作業時的回應標頭:

Status Code:
OK

Headers:
Pragma                        : no-cache
X-Content-Type-Options        : nosniff
x-ms-request-id               : 388c9359-e237-4644-8f6c-38ae5eb0dfcb
x-ms-client-request-id        : 5ef896e6-d812-431a-ad58-9d9ee1bb8bb3,5ef896e6-d812-431a-ad58-9d9ee1bb8bb3
Strict-Transport-Security     : max-age=31536000; includeSubDomains
x-ms-ratelimit-remaining-subscription-resource-requests: 107
x-ms-correlation-request-id   : 388c9359-e237-4644-8f6c-38ae5eb0dfcb
x-ms-routing-request-id       : SOUTHINDIA:20211126T054036Z:388c9359-e237-4644-8f6c-38ae5eb0dfcb
Cache-Control                 : no-cache
Date                          : Fri, 26 Nov 2021 05:40:36 GMT
Server                        : Microsoft-IIS/10.0
X-Powered-By                  : ASP.NET

Body:
{
  "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "name": "TestOBJ",
  "status": "Succeeded",
  "startTime": "2021-11-26T05:36:36.5262731Z",
  "endTime": "2021-11-26T05:36:36.5262731Z",
  "properties": {
    "objectType": "OperationStatusJobExtendedInfo",
    "jobId": "68178d86-d564-460b-9643-829046aac1b1"
  }
}

接下來,請使用位置標頭或 Azure-AsyncOperation 標頭搭配 GET 命令,追蹤所產生的作業:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupoperations/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e?api-version=2016-12-01

回應主體

{
  "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "name": "TestOBJ",
  "status": "Succeeded",
  "startTime": "2021-11-26T05:36:36.5262731Z",
  "endTime": "2021-11-26T05:36:36.5262731Z",
  "properties": {
    "objectType": "OperationStatusJobExtendedInfo",
    "jobId": "68178d86-d564-460b-9643-829046aac1b1"
  }
}

停止執行個體下受保護資料庫的保護

對於透過實例快照政策保護的資料庫,請向 資料庫受保護項目提交 PUT 請求,而非實例項目:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/Azure/protectionContainers/{containerName}/protectedItems/SQLDatabase;MSSQLSERVER;tdb2?api-version=2024-01-31-preview

將 protectionState 設為 ProtectionStopped,並包含實例快照政策 ID:

{
  "properties": {
    "backupManagementType": "AzureWorkload",
    "workloadType": "SQLDataBase",
    "friendlyName": "MSSQLSERVER;tdb2",
    "protectedItemType": "AzureVmWorkloadSQLDatabase",
    "protectionState": "ProtectionStopped",
    "policyId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/SQLInstanceSnapPolicy"
  }
}

將樣本資料庫項目名稱替換成您的資料庫傳回的名稱,並替換原則識別碼預留位置。 此操作會停止保護,同時保留現有備份資料。 追蹤本節前述的非同步操作。

停止保護並刪除備份資料

若要移除受保護檔案共用上的保護,並且一併刪除備份資料,請執行刪除作業。

DELETE https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2019-05-13

參數 containerName 和 protectedItemName 的設定方式,如同本文章備份設定步驟所述。

回覆

刪除保護是非同步作業。 此作業會建立另一項需要個別追蹤的作業。 這會傳回兩個回應:在建立另一項作業時傳回 202 (Accepted),然後在該作業完成時傳回 204 (NoContent)。

下一步