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

Web Apps - Backup

服务:

App Service

API 版本:

2023-12-01

创建应用备份的说明。

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

URI 参数

名称	在	必需	类型	说明
name	path	True	string	应用的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 正则表达式模式: ^[-\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 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Backup web app

示例请求

HTTP

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backup?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"
    }
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.BackupRequestInner;
import com.azure.resourcemanager.appservice.models.BackupSchedule;
import com.azure.resourcemanager.appservice.models.DatabaseBackupSetting;
import com.azure.resourcemanager.appservice.models.DatabaseType;
import com.azure.resourcemanager.appservice.models.FrequencyUnit;
import java.time.OffsetDateTime;
import java.util.Arrays;

/**
 * Samples for WebApps Backup.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/BackupWebApp.json
     */
    /**
     * Sample code: Backup web app.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void backupWebApp(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().backupWithResponse("testrg123", "sitef6141",
            new BackupRequestInner().withBackupName("abcdwe").withEnabled(true)
                .withStorageAccountUrl(
                    "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>")
                .withBackupSchedule(new BackupSchedule().withFrequencyInterval(7).withFrequencyUnit(FrequencyUnit.DAY)
                    .withKeepAtLeastOneBackup(true).withRetentionPeriodInDays(30)
                    .withStartTime(OffsetDateTime.parse("2022-09-02T17:33:11.641Z")))
                .withDatabases(Arrays.asList(
                    new DatabaseBackupSetting().withDatabaseType(DatabaseType.SQL_AZURE).withName("backenddb")
                        .withConnectionStringName("backend").withConnectionString(
                            "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"),
                    new DatabaseBackupSetting().withDatabaseType(DatabaseType.SQL_AZURE).withName("statsdb")
                        .withConnectionStringName("stats").withConnectionString(
                            "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]"))),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python backup_web_app.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.backup(
        resource_group_name="testrg123",
        name="sitef6141",
        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/stable/2023-12-01/examples/BackupWebApp.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

Go

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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/BackupWebApp.json
func ExampleWebAppsClient_Backup() {
	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().Backup(ctx, "testrg123", "sitef6141", 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"),
	// 	Properties: &armappservice.BackupItemProperties{
	// 		Name: to.Ptr("sitef6141_2023-12-01"),
	// 		BlobName: to.Ptr("sitef6141_2023-12-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-02T17: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

JavaScript

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

/**
 * This sample demonstrates how to Description for Creates a backup of an app.
 *
 * @summary Description for Creates a backup of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/BackupWebApp.json
 */
async function backupWebApp() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  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.backup(resourceGroupName, name, 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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/BackupWebApp.json
// this example is just showing the usage of "WebApps_Backup" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
WebAppBackupInfo info = new WebAppBackupInfo()
{
    BackupName = "abcdwe",
    IsEnabled = true,
    StorageAccountUri = new Uri("DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>"),
    BackupSchedule = new WebAppBackupSchedule(7, BackupFrequencyUnit.Day, true, 30)
    {
        StartOn = DateTimeOffset.Parse("2022-09-02T17:33:11.641Z"),
    },
    Databases =
    {
    new AppServiceDatabaseBackupSetting(AppServiceDatabaseType.SqlAzure)
    {
    Name = "backenddb",
    ConnectionStringName = "backend",
    ConnectionString = "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
    },new AppServiceDatabaseBackupSetting(AppServiceDatabaseType.SqlAzure)
    {
    Name = "statsdb",
    ConnectionStringName = "stats",
    ConnectionString = "DSN=data-source-name[;SERVER=value] [;PWD=value] [;UID=value] [;<Attribute>=<value>]",
    }
    },
};
WebAppBackupData result = await webSite.BackupAsync(info);

// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {result.Id}");

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",
  "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-02T17: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