Web Apps - List Backups

서비스:

App Service

API 버전:

2023-12-01

앱의 기존 백업 가져오기에 대한 설명입니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
name	path	True	string	응용 프로그램의 이름입니다.
resourceGroupName	path	True	string	리소스가 속한 리소스 그룹의 이름입니다. regex 패턴: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Azure 구독 ID. GUID 형식 문자열입니다(예: 00000000-0000-0000-0000-0000-00000000000).
api-version	query	True	string	API 버전

응답

Name	형식	Description
200 OK	BackupItemCollection	정상
Other Status Codes	DefaultErrorResponse	오류 응답을 App Service.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
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=2023-12-01

Java

/**
 * Samples for WebApps ListBackups.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-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/2023-12-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/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/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_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-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");

/**
 * 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/2023-12-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 (let 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/2023-12-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_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
      }
    }
  ]
}

정의

Name	Description
BackupItem	백업 설명.
BackupItemCollection	백업 항목의 컬렉션입니다.
BackupItemStatus	백업 상태.
DatabaseBackupSetting	데이터베이스 백업 설정.
DatabaseType	데이터베이스 형식(예: SqlAzure/MySql).
DefaultErrorResponse	오류 응답을 App Service.
Details
Error	오류 모델.

BackupItem

백업 설명.

Name	형식	Description
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	백업된 원래 웹앱의 크기입니다.
type	string	리소스 종류.

BackupItemCollection

백업 항목의 컬렉션입니다.

Name	형식	Description
nextLink	string	리소스의 다음 페이지에 연결합니다.
value	BackupItem[]	리소스 컬렉션입니다.

BackupItemStatus

백업 상태.

Name	형식	Description
Created	string
DeleteFailed	string
DeleteInProgress	string
Deleted	string
Failed	string
InProgress	string
PartiallySucceeded	string
Skipped	string
Succeeded	string
TimedOut	string

DatabaseBackupSetting

데이터베이스 백업 설정.

Name	형식	Description
connectionString	string	백업 또는 복원 중인 데이터베이스에 대한 연결 문자열 포함합니다. 새 데이터베이스에 복원이 수행되어야 하는 경우 내부 데이터베이스 이름은 새 데이터베이스 이름입니다.
connectionStringName	string	SiteConfig.ConnectionStrings에 연결된 연결 문자열 이름을 포함합니다. 이는 연결 문자열 덮어쓰기 옵션과 함께 복원하는 동안 사용됩니다.
databaseType	DatabaseType	데이터베이스 형식(예: SqlAzure/MySql).
name	string

DatabaseType

데이터베이스 형식(예: SqlAzure/MySql).

Name	형식	Description
LocalMySql	string
MySql	string
PostgreSql	string
SqlAzure	string

DefaultErrorResponse

오류 응답을 App Service.

Name	형식	Description
error	Error	오류 모델.

Details

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.

Error

오류 모델.

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
details	Details[]	자세한 오류입니다.
innererror	string	디버그 오류에 대한 자세한 정보입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.