Web Apps - List Backups

Service:

App Service

API Version:

2023-12-01

取得應用程式現有備份的描述。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups?api-version=2023-12-01

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	應用程式的名稱。
resourceGroupName	path	True	string	資源所屬資源群組的名稱。 Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	您的 Azure 訂用帳戶識別碼。 這是 GUID 格式的字串 (例如 0000000000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

回應

名稱	類型	Description
200 OK	BackupItemCollection	確定
Other Status Codes	DefaultErrorResponse	App Service 錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List web app backups

Sample Request

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups?api-version=2023-12-01

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345",
      "name": "sitef6141",
      "type": "Microsoft.Web/sites",
      "properties": {
        "id": 12345,
        "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
        "blobName": "sitef6141_2023-12-01",
        "name": "sitef6141_2023-12-01",
        "status": "InProgress",
        "sizeInBytes": 56091883,
        "created": "2022-09-03T17:33:11.641Z",
        "log": "Succeeded",
        "databases": [
          {
            "databaseType": "SqlAzure",
            "name": "backenddb",
            "connectionStringName": "backend",
            "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"
          },
          {
            "databaseType": "SqlAzure",
            "name": "statsdb",
            "connectionStringName": "stats",
            "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"
          }
        ],
        "scheduled": true,
        "lastRestoreTimeStamp": "2022-09-04T17:33:11.641Z",
        "finishedTimeStamp": "2022-09-05T17:33:11.641Z",
        "websiteSizeInBytes": 56091883
      }
    }
  ]
}

定義

名稱	Description
BackupItem	備份描述。
BackupItemCollection	備份專案的集合。
BackupItemStatus	備份狀態。
DatabaseBackupSetting	資料庫備份設定。
DatabaseType	資料庫類型 (例如 SqlAzure / MySql) 。
DefaultErrorResponse	App Service 錯誤回應。
Details
Error	錯誤模型。

BackupItem

備份描述。

名稱	類型	Description
id	string	資源標識碼。
kind	string	資源種類。
name	string	資源名稱。
properties.blobName	string	包含此備份數據的 Blob 名稱。
properties.correlationId	string	唯一相互關聯標識碼。 請搭配與 Azure 支援 通訊時的時間戳一起使用。
properties.created	string	備份建立的時間戳。
properties.databases	DatabaseBackupSetting[]	備份中包含的資料庫清單。
properties.finishedTimeStamp	string	此備份完成時的時間戳。
properties.id	integer	備份的標識碼。
properties.lastRestoreTimeStamp	string	上次使用此備份之還原作業的時間戳。
properties.log	string	有關此備份的詳細數據。 可能包含錯誤訊息。
properties.name	string	此備份的名稱。
properties.scheduled	boolean	如果因為觸發排程而建立此備份，則為 True。
properties.sizeInBytes	integer	以位元組為單位的備份大小。
properties.status	BackupItemStatus	備份狀態。
properties.storageAccountUrl	string	包含此備份之記憶體帳戶容器的SAS URL。
properties.websiteSizeInBytes	integer	已備份的原始 Web 應用程式大小。
type	string	資源類型。

BackupItemCollection

備份專案的集合。

名稱	類型	Description
nextLink	string	連結至下一頁的資源。
value	BackupItem[]	資源的集合。

BackupItemStatus

備份狀態。

名稱	類型	Description
Created	string
DeleteFailed	string
DeleteInProgress	string
Deleted	string
Failed	string
InProgress	string
PartiallySucceeded	string
Skipped	string
Succeeded	string
TimedOut	string

DatabaseBackupSetting

資料庫備份設定。

名稱	類型	Description
connectionString	string	包含要備份或還原之資料庫的 連接字串。 如果還原應該發生在新的資料庫，內部的資料庫名稱就是新的資料庫名稱。
connectionStringName	string	包含連結至 SiteConfig.ConnectionStrings 的 連接字串 名稱。 這會在還原期間使用，並覆寫連接字串選項。
databaseType	DatabaseType	資料庫類型 (例如 SqlAzure / MySql) 。
name	string

DatabaseType

資料庫類型 (例如 SqlAzure / MySql) 。

名稱	類型	Description
LocalMySql	string
MySql	string
PostgreSql	string
SqlAzure	string

DefaultErrorResponse

App Service 錯誤回應。

名稱	類型	Description
error	Error	錯誤模型。

Details

名稱	類型	Description
code	string	標準化字串，以程序設計方式識別錯誤。
message	string	詳細的錯誤描述和偵錯資訊。
target	string	詳細的錯誤描述和偵錯資訊。

Error

錯誤模型。

名稱	類型	Description
code	string	標準化字串，以程序設計方式識別錯誤。
details	Details[]	詳細的錯誤。
innererror	string	偵錯錯誤的詳細資訊。
message	string	詳細的錯誤描述和偵錯資訊。
target	string	詳細的錯誤描述和偵錯資訊。