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

Web Apps - List Backup Status Secrets

服务:: App Service

API 版本:: 2025-03-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=2025-03-01

URI 参数

名称	在	必需	类型	说明
backupId	path	True	string	备份的 ID。
name	path	True	string	Web 应用的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	资源所属的资源组的名称。
subscriptionId	path	True	string	Azure 订阅 ID。这是 GUID 格式的字符串（例如 000000000-0000-0000-0000-00000000000000）。
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	应用服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Get web app backup with secrets

示例请求

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345/list?api-version=2025-03-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"
    }
  }
}

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python get_web_app_backup_with_secrets.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.list_backup_status_secrets(
        resource_group_name="testrg123",
        name="sitef6141",
        backup_id="12345",
        request={
            "properties": {
                "backupName": "abcdwe",
                "backupSchedule": {
                    "frequencyInterval": 7,
                    "frequencyUnit": "Day",
                    "keepAtLeastOneBackup": True,
                    "retentionPeriodInDays": 30,
                    "startTime": "2022-09-02T17:33:11.641Z",
                },
                "databases": [
                    {
                        "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
                        "connectionStringName": "backend",
                        "databaseType": "SqlAzure",
                        "name": "backenddb",
                    },
                    {
                        "connectionString": "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
                        "connectionStringName": "stats",
                        "databaseType": "SqlAzure",
                        "name": "statsdb",
                    },
                ],
                "enabled": True,
                "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetWebAppBackupWithSecrets.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetWebAppBackupWithSecrets.json
func ExampleWebAppsClient_ListBackupStatusSecrets() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().ListBackupStatusSecrets(ctx, "testrg123", "sitef6141", "12345", armappservice.BackupRequest{
		Properties: &armappservice.BackupRequestProperties{
			BackupName: to.Ptr("abcdwe"),
			BackupSchedule: &armappservice.BackupSchedule{
				FrequencyInterval:     to.Ptr[int32](7),
				FrequencyUnit:         to.Ptr(armappservice.FrequencyUnitDay),
				KeepAtLeastOneBackup:  to.Ptr(true),
				RetentionPeriodInDays: to.Ptr[int32](30),
				StartTime:             to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-02T17:33:11.641Z"); return t }()),
			},
			Databases: []*armappservice.DatabaseBackupSetting{
				{
					Name:                 to.Ptr("backenddb"),
					ConnectionString:     to.Ptr("DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"),
					ConnectionStringName: to.Ptr("backend"),
					DatabaseType:         to.Ptr(armappservice.DatabaseTypeSQLAzure),
				},
				{
					Name:                 to.Ptr("statsdb"),
					ConnectionString:     to.Ptr("DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"),
					ConnectionStringName: to.Ptr("stats"),
					DatabaseType:         to.Ptr(armappservice.DatabaseTypeSQLAzure),
				}},
			Enabled:           to.Ptr(true),
			StorageAccountURL: to.Ptr("DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BackupItem = armappservice.BackupItem{
	// 	Name: to.Ptr("sitef6141"),
	// 	Type: to.Ptr("Microsoft.Web/sites"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345"),
	// 	Properties: &armappservice.BackupItemProperties{
	// 		Name: to.Ptr("sitef6141_2025-03-01"),
	// 		BlobName: to.Ptr("sitef6141_2025-03-01"),
	// 		Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-03T17:33:11.641Z"); return t}()),
	// 		Databases: []*armappservice.DatabaseBackupSetting{
	// 			{
	// 				Name: to.Ptr("backenddb"),
	// 				ConnectionString: to.Ptr("DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"),
	// 				ConnectionStringName: to.Ptr("backend"),
	// 				DatabaseType: to.Ptr(armappservice.DatabaseTypeSQLAzure),
	// 			},
	// 			{
	// 				Name: to.Ptr("statsdb"),
	// 				ConnectionString: to.Ptr("DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"),
	// 				ConnectionStringName: to.Ptr("stats"),
	// 				DatabaseType: to.Ptr(armappservice.DatabaseTypeSQLAzure),
	// 		}},
	// 		FinishedTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-05T17:33:11.641Z"); return t}()),
	// 		BackupID: to.Ptr[int32](12345),
	// 		LastRestoreTimeStamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-09-04T17:33:11.641Z"); return t}()),
	// 		Log: to.Ptr("Succeeded"),
	// 		Scheduled: to.Ptr(true),
	// 		SizeInBytes: to.Ptr[int64](56091883),
	// 		Status: to.Ptr(armappservice.BackupItemStatusInProgress),
	// 		StorageAccountURL: to.Ptr("DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>"),
	// 		WebsiteSizeInBytes: to.Ptr[int64](56091883),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
 *
 * @summary Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/GetWebAppBackupWithSecrets.json
 */
async function getWebAppBackupWithSecrets() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const backupId = "12345";
  const request = {
    backupName: "abcdwe",
    backupSchedule: {
      frequencyInterval: 7,
      frequencyUnit: "Day",
      keepAtLeastOneBackup: true,
      retentionPeriodInDays: 30,
      startTime: new Date("2022-09-02T17:33:11.641Z"),
    },
    databases: [
      {
        name: "backenddb",
        connectionString:
          "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
        connectionStringName: "backend",
        databaseType: "SqlAzure",
      },
      {
        name: "statsdb",
        connectionString:
          "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
        connectionStringName: "stats",
        databaseType: "SqlAzure",
      },
    ],
    enabled: true,
    storageAccountUrl:
      "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.listBackupStatusSecrets(
    resourceGroupName,
    name,
    backupId,
    request,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 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_2025-03-01",
    "name": "sitef6141_2025-03-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	应用服务错误响应。
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 (date-time)	备份创建的时间戳。
properties.databases	DatabaseBackupSetting[]	备份中包含的数据库列表。
properties.finishedTimeStamp	string (date-time)	此备份完成时的时间戳。
properties.id	integer (int32)	备份的 ID。
properties.lastRestoreTimeStamp	string (date-time)	使用此备份的上次还原作的时间戳。
properties.log	string	有关此备份的详细信息。可能包含错误消息。
properties.name	string	此备份的名称。
properties.scheduled	boolean	如果此备份是由于触发计划而创建的，则为 True。
properties.sizeInBytes	integer (int64)	备份的大小（以字节为单位）。
properties.status	BackupItemStatus	备份状态。
properties.storageAccountUrl	string	包含此备份的存储帐户容器的 SAS URL。
properties.websiteSizeInBytes	integer (int64)	已备份的原始 Web 应用程序的大小。
type	string	资源类型。

BackupItemStatus

枚举

备份状态。

值	说明
InProgress
Failed
Succeeded
TimedOut
Created
Skipped
PartiallySucceeded
DeleteInProgress
DeleteFailed
Deleted

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 (int32)	7	应执行备份的频率（例如，对于每周备份，应将其设置为 7，FrequencyUnit 应设置为 Day）
frequencyUnit	FrequencyUnit	Day	执行备份的频率的时间单位（例如，对于每周备份，应将其设置为 Day，FrequencyInterval 应设置为 7）
keepAtLeastOneBackup	boolean	True	如此如果保留策略应始终在存储帐户中保留至少一个备份，而不考虑备份的年龄：否则为 false。
lastExecutionTime	string (date-time)		上次触发此计划的时间。
retentionPeriodInDays	integer (int32)	30	删除多少天备份后。
startTime	string (date-time)		计划何时应开始工作。

DatabaseBackupSetting

对象

数据库备份设置。

名称	类型	说明
connectionString	string	包含要备份或还原的数据库的连接字符串。如果还原应发生在新数据库，则内部的数据库名称为新数据库。
connectionStringName	string	包含链接到 SiteConfig.ConnectionStrings 的连接字符串名称。这在还原期间与覆盖连接字符串选项一起使用。
databaseType	DatabaseType	数据库类型（例如 SqlAzure/MySql）。
name	string

DatabaseType

枚举

数据库类型（例如 SqlAzure/MySql）。

值	说明
SqlAzure
MySql
LocalMySql
PostgreSql

DefaultErrorResponse

对象

应用服务错误响应。

名称	类型	说明
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
Hour

通过

Web Apps - List Backup Status Secrets

URI 参数

请求正文

响应

安全性

azure_auth

作用域

示例

Get web app backup with secrets

示例请求

示例响应

定义

BackupItem

BackupItemStatus

BackupRequest

BackupSchedule

DatabaseBackupSetting

DatabaseType

DefaultErrorResponse

Details

Error

FrequencyUnit