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

Web Apps - List Backups

服务:

App Service

API 版本:

2024-04-01

获取应用的现有备份的说明。

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

URI 参数

名称	在	必需	类型	说明
name	path	True	string	应用的名称。
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 版本

响应

名称	类型	说明
200 OK	BackupItemCollection	还行
Other Status Codes	DefaultErrorResponse	应用服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

List web app backups

示例请求

HTTP

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

Java

/**
 * Samples for WebApps ListBackups.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppBackups.json
     */
    /**
     * Sample code: List web app backups.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listWebAppBackups(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().listBackups("testrg123", "sitef6141",
            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 azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_web_app_backups.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_backups(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppBackups.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"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppBackups.json
func ExampleWebAppsClient_NewListBackupsPager() {
	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)
	}
	pager := clientFactory.NewWebAppsClient().NewListBackupsPager("testrg123", "sitef6141", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.BackupItemCollection = armappservice.BackupItemCollection{
		// 	Value: []*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_2024-04-01"),
		// 				BlobName: to.Ptr("sitef6141_2024-04-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

JavaScript

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

/**
 * This sample demonstrates how to Description for Gets existing backups of an app.
 *
 * @summary Description for Gets existing backups of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppBackups.json
 */
async function listWebAppBackups() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.webApps.listBackups(resourceGroupName, name)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListWebAppBackups.json
// this example is just showing the usage of "WebApps_ListBackups" 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);

// get the collection of this SiteBackupResource
SiteBackupCollection collection = webSite.GetSiteBackups();

// invoke the operation and iterate over the result
await foreach (SiteBackupResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    WebAppBackupData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

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

示例响应

状态代码:

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_2024-04-01",
        "name": "sitef6141_2024-04-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	备份说明。
BackupItemCollection	备份项的集合。
BackupItemStatus	备份状态。
DatabaseBackupSetting	数据库备份设置。
DatabaseType	数据库类型（例如 SqlAzure/MySql）。
DefaultErrorResponse	应用服务错误响应。
Details
Error	错误模型。

BackupItem

Object

备份说明。

名称	类型	说明
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	如此 如果由于触发计划而创建了此备份。
properties.sizeInBytes	integer (int64)	备份的大小（以字节为单位）。
properties.status	BackupItemStatus	备份状态。
properties.storageAccountUrl	string	包含此备份的存储帐户容器的 SAS URL。
properties.websiteSizeInBytes	integer (int64)	已备份的原始 Web 应用的大小。
type	string	资源类型。

BackupItemCollection

Object

备份项的集合。

名称	类型	说明
nextLink	string	链接到下一页的资源。
value	BackupItem[]	资源集合。

BackupItemStatus

枚举

备份状态。

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

DatabaseBackupSetting

Object

数据库备份设置。

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

DatabaseType

枚举

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

值	说明
LocalMySql
MySql
PostgreSql
SqlAzure

DefaultErrorResponse

Object

应用服务错误响应。

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

Details

Object

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

Error

Object

错误模型。

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