你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Web Apps - List Backup Status Secrets

参考

Service:: App Service

API Version:: 2023-12-01

获取可能正在进行的 Web 应用备份的状态的说明，包括与备份关联的机密，例如 Azure 存储 SAS URL。如果请求正文中传递了新的 URL，则还可用于更新备份的 SAS URL。

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

URI 参数

名称	在	必需	类型	说明
backupId	path	True	string	备份的 ID。
name	path	True	string	Web 应用的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure 订阅 ID。这是一个 GUID 格式的字符串， (例如 00000000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

请求正文

名称	必需	类型	说明
properties.storageAccountUrl	True	string	容器的 SAS URL。
kind		string	资源类型。
properties.backupName		string	备份的名称。
properties.backupSchedule		BackupSchedule	如果定期执行备份，则计划备份。
properties.databases		DatabaseBackupSetting[]	备份中包含的数据库。
properties.enabled		boolean	如果启用备份计划，则为 True (在这种情况下必须包含) ;如果应禁用备份计划，则为 false。

响应

名称	类型	说明
200 OK	BackupItem	确定
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Get web app backup with secrets

Sample Request

HTTP

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

{
  "properties": {
    "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
    "backupName": "abcdwe",
    "enabled": true,
    "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>]"
      }
    ],
    "backupSchedule": {
      "frequencyInterval": 7,
      "frequencyUnit": "Day",
      "keepAtLeastOneBackup": true,
      "retentionPeriodInDays": 30,
      "startTime": "2022-09-02T17:33:11.641Z"
    }
  }
}

Sample Response

Status code:: 200

{
  "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
  }
}

定义

名称	说明
BackupItem	备份说明。
BackupItemStatus	备份状态。
BackupRequest	将执行的备份的说明。
BackupSchedule	备份计划的说明。描述应执行备份的频率以及保留策略。
DatabaseBackupSetting	数据库备份设置。
DatabaseType	数据库类型 (例如 SqlAzure/MySql) 。
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
FrequencyUnit	备份执行频率的时间单位 (例如，每周备份应设置为 Day，FrequencyInterval 应设置为 7)

BackupItem

备份说明。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.blobName	string	包含此备份数据的 Blob 的名称。
properties.correlationId	string	唯一相关标识符。请在与Azure 支持通信时将此与时间戳一起使用。
properties.created	string	备份创建的时间戳。
properties.databases	DatabaseBackupSetting[]	备份中包含的数据库列表。
properties.finishedTimeStamp	string	此备份完成时的时间戳。
properties.id	integer	备份的 ID。
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	资源类型。

BackupItemStatus

备份状态。

名称	类型	说明
Created	string
DeleteFailed	string
DeleteInProgress	string
Deleted	string
Failed	string
InProgress	string
PartiallySucceeded	string
Skipped	string
Succeeded	string
TimedOut	string

BackupRequest

将执行的备份的说明。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.backupName	string	备份的名称。
properties.backupSchedule	BackupSchedule	如果定期执行备份，则计划备份。
properties.databases	DatabaseBackupSetting[]	备份中包含的数据库。
properties.enabled	boolean	如果启用备份计划，则为 True (在这种情况下必须包含) ;如果应禁用备份计划，则为 false。
properties.storageAccountUrl	string	容器的 SAS URL。
type	string	资源类型。

BackupSchedule

备份计划的说明。描述应执行备份的频率以及保留策略。

名称	类型	默认值	说明
frequencyInterval	integer	7	应 (执行备份的频率，例如，对于每周备份，应将其设置为 7，FrequencyUnit 应设置为 Day)
frequencyUnit	FrequencyUnit	Day	备份执行频率的时间单位 (例如，每周备份应设置为 Day，FrequencyInterval 应设置为 7)
keepAtLeastOneBackup	boolean	True	如此如果保留策略应始终在存储帐户中保留至少一个备份，而不管它有多旧;否则为 false。
lastExecutionTime	string		上次触发此计划的时间。
retentionPeriodInDays	integer	30	应在多少天后删除备份。
startTime	string		计划何时开始工作。

DatabaseBackupSetting

数据库备份设置。

名称	类型	说明
connectionString	string	包含正在备份或还原的数据库连接字符串。如果对新数据库进行还原，则内部的数据库名称为新数据库。
connectionStringName	string	包含链接到 SiteConfig.ConnectionStrings 的连接字符串名称。这在还原期间使用覆盖连接字符串选项。
databaseType	DatabaseType	数据库类型 (例如 SqlAzure/MySql) 。
name	string

DatabaseType

数据库类型 (例如 SqlAzure/MySql) 。

名称	类型	说明
LocalMySql	string
MySql	string
PostgreSql	string
SqlAzure	string

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

FrequencyUnit

备份执行频率的时间单位 (例如，每周备份应设置为 Day，FrequencyInterval 应设置为 7)

名称	类型	说明
Day	string
Hour	string