Web Apps - Restore

서비스:

App Service

API 버전:

2023-12-01

다른 앱(또는 지정된 경우 배포 슬롯)에 대한 특정 백업 복원에 대한 설명입니다.

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

URI 매개 변수

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

요청 본문

Name	필수	형식	Description
properties.overwrite	True	boolean	true 복원 작업이 대상 앱을 덮어쓸 수 있으면 이고, 그렇지 않으면 입니다 false. true 은 기존 앱을 통해 복원하려는 경우 필요합니다.
properties.storageAccountUrl	True	string	컨테이너에 대한 SAS URL입니다.
kind		string	리소스 종류입니다.
properties.adjustConnectionStrings		boolean	true 새 앱에서 SiteConfig.ConnectionStrings를 설정해야 하면 이고, 그렇지 않으면 입니다 false.
properties.appServicePlan		string	복원된 사이트를 소유할 앱 서비스 계획을 지정합니다.
properties.blobName		string	백업을 포함하는 Blob의 이름입니다.
properties.databases		DatabaseBackupSetting[]	복원해야 하는 데이터베이스의 컬렉션입니다. 이 목록은 백업에 포함된 데이터베이스 목록과 일치해야 합니다.
properties.hostingEnvironment		string	필요한 경우(앱을 App Service Environment 복원할 때만) 이름을 App Service Environment.
properties.ignoreConflictingHostNames		boolean	사용자 지정 도메인을 사용하여 앱을 복원할 때 논리를 변경합니다. true 사용자 지정 도메인을 자동으로 제거합니다. 이면 false복원할 때 사용자 지정 도메인이 앱의 개체에 추가되지만 작업 중 충돌로 인해 실패할 수 있습니다.
properties.ignoreDatabases		boolean	데이터베이스를 무시하고 사이트 콘텐츠만 복원
properties.operationType		BackupRestoreOperationType	작업 유형입니다.
properties.siteName		string	앱의 이름입니다.

응답

Name	형식	Description
200 OK		복원 작업이 시작되었습니다.
202 Accepted		복원 작업이 시작되었습니다.
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	사용자 계정 가장

예제

Restore web app from backup

샘플 요청

HTTP

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

{
  "properties": {
    "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
    "overwrite": true,
    "siteName": "sitef6141",
    "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>]"
      }
    ]
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.RestoreRequestInner;
import com.azure.resourcemanager.appservice.models.DatabaseBackupSetting;
import com.azure.resourcemanager.appservice.models.DatabaseType;
import java.util.Arrays;

/**
 * Samples for WebApps Restore.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/RestoreWebAppBackup.json
     */
    /**
     * Sample code: Restore web app from backup.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void restoreWebAppFromBackup(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().restore("testrg123", "sitef6141", "123244",
            new RestoreRequestInner()
                .withStorageAccountUrl(
                    "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>")
                .withOverwrite(true).withSiteName("sitef6141")
                .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 restore_web_app_backup.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",
    )

    client.web_apps.begin_restore(
        resource_group_name="testrg123",
        name="sitef6141",
        backup_id="123244",
        request={
            "properties": {
                "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",
                    },
                ],
                "overwrite": True,
                "siteName": "sitef6141",
                "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
            }
        },
    ).result()


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/RestoreWebAppBackup.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/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/RestoreWebAppBackup.json
func ExampleWebAppsClient_BeginRestore() {
	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)
	}
	poller, err := clientFactory.NewWebAppsClient().BeginRestore(ctx, "testrg123", "sitef6141", "123244", armappservice.RestoreRequest{
		Properties: &armappservice.RestoreRequestProperties{
			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),
				}},
			Overwrite:         to.Ptr(true),
			SiteName:          to.Ptr("sitef6141"),
			StorageAccountURL: to.Ptr("DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	_, err = poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
}

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 Restores a specific backup to another app (or deployment slot, if specified).
 *
 * @summary Description for Restores a specific backup to another app (or deployment slot, if specified).
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/RestoreWebAppBackup.json
 */
async function restoreWebAppFromBackup() {
  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 = "123244";
  const request = {
    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",
      },
    ],
    overwrite: true,
    siteName: "sitef6141",
    storageAccountUrl:
      "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.beginRestoreAndWait(
    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

dotnet

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

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/RestoreWebAppBackup.json
// this example is just showing the usage of "WebApps_Restore" 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 SiteBackupResource created on azure
// for more information of creating SiteBackupResource, please refer to the document of SiteBackupResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
string backupId = "123244";
ResourceIdentifier siteBackupResourceId = SiteBackupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, backupId);
SiteBackupResource siteBackup = client.GetSiteBackupResource(siteBackupResourceId);

// invoke the operation
RestoreRequestInfo info = new RestoreRequestInfo()
{
    StorageAccountUri = new Uri("DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>"),
    CanOverwrite = true,
    SiteName = "sitef6141",
    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>]",
    }
    },
};
await siteBackup.RestoreAsync(WaitUntil.Completed, info);

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

상태 코드:

202

azure-asyncoperation: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/sites/sitef6141/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2023-12-01

정의

Name	Description
BackupRestoreOperationType	작업 유형입니다.
DatabaseBackupSetting	데이터베이스 백업 설정.
DatabaseType	데이터베이스 유형(예: SqlAzure/MySql).
DefaultErrorResponse	오류 응답을 App Service.
Details
Error	오류 모델.
RestoreRequest	복원 요청에 대한 설명입니다.

BackupRestoreOperationType

작업 유형입니다.

Name	형식	Description
Clone	string
CloudFS	string
Default	string
Relocation	string
Snapshot	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	자세한 오류 설명 및 디버깅 정보입니다.

RestoreRequest

복원 요청에 대한 설명입니다.

Name	형식	Default value	Description
id	string		리소스 ID입니다.
kind	string		리소스 종류입니다.
name	string		리소스 이름입니다.
properties.adjustConnectionStrings	boolean		true 새 앱에서 SiteConfig.ConnectionStrings를 설정해야 하면 이고, 그렇지 않으면 입니다 false.
properties.appServicePlan	string		복원된 사이트를 소유할 앱 서비스 계획을 지정합니다.
properties.blobName	string		백업을 포함하는 Blob의 이름입니다.
properties.databases	DatabaseBackupSetting[]		복원해야 하는 데이터베이스의 컬렉션입니다. 이 목록은 백업에 포함된 데이터베이스 목록과 일치해야 합니다.
properties.hostingEnvironment	string		필요한 경우(앱을 App Service Environment 복원할 때만) 이름을 App Service Environment.
properties.ignoreConflictingHostNames	boolean	False	사용자 지정 도메인을 사용하여 앱을 복원할 때 논리를 변경합니다. true 사용자 지정 도메인을 자동으로 제거합니다. 이면 false복원할 때 사용자 지정 도메인이 앱의 개체에 추가되지만 작업 중 충돌로 인해 실패할 수 있습니다.
properties.ignoreDatabases	boolean	False	데이터베이스를 무시하고 사이트 콘텐츠만 복원
properties.operationType	BackupRestoreOperationType	Default	작업 유형입니다.
properties.overwrite	boolean		true 복원 작업이 대상 앱을 덮어쓸 수 있으면 이고, 그렇지 않으면 입니다 false. true 은 기존 앱을 통해 복원하려는 경우 필요합니다.
properties.siteName	string		앱의 이름입니다.
properties.storageAccountUrl	string		컨테이너에 대한 SAS URL입니다.
type	string		리소스 종류.