Web Apps - Restore

Referens

Tjänst:: App Service

API-version:: 2024-04-01

Beskrivning för Återställer en specifik säkerhetskopia till en annan app (eller distributionsfack, om det anges).

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
backupId	path	True	string	ID för säkerhetskopian.
name	path	True	string	Namnet på appen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Namnet på resursgruppen som resursen tillhör.
subscriptionId	path	True	string	Ditt Azure-prenumerations-ID. Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-version

Begärandetext

Name	Obligatorisk	Typ	Description
properties.overwrite	True	boolean	`true` om återställningsåtgärden kan skriva över målappen. annars `false`. `true` behövs om du försöker återställa över en befintlig app.
properties.storageAccountUrl	True	string	SAS-URL till containern.
kind		string	Typ av resurs.
properties.adjustConnectionStrings		boolean	`true` om SiteConfig.ConnectionStrings ska anges i den nya appen. annars `false`.
properties.appServicePlan		string	Ange en apptjänstplan som ska äga en återställd webbplats.
properties.blobName		string	Namnet på en blob som innehåller säkerhetskopian.
properties.databases		DatabaseBackupSetting[]	Samling databaser som ska återställas. Den här listan måste matcha listan över databaser som ingår i säkerhetskopian.
properties.hostingEnvironment		string	App Service Environment-namn om det behövs (endast när du återställer en app till en App Service-miljö).
properties.ignoreConflictingHostNames		boolean	Ändrar en logik när du återställer en app med anpassade domäner. `true` för att ta bort anpassade domäner automatiskt. Om `false`läggs anpassade domäner till i appens objekt när det återställs, men det kan misslyckas på grund av konflikter under åtgärden.
properties.ignoreDatabases		boolean	Ignorera databaserna och återställ endast webbplatsinnehållet
properties.operationType		BackupRestoreOperationType	Åtgärdstyp.
properties.siteName		string	Namnet på en app.

Svar

Name	Typ	Description
200 OK		Återställningsåtgärden har startats.
202 Accepted		Återställningsåtgärden har startats.
Other Status Codes	DefaultErrorResponse	App Service-felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Restore web app from backup

Exempelbegäran

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


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/2024-04-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

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/2024-04-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

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/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/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

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

/**
 * 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/2024-04-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

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/2024-04-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

Exempelsvar

Statuskod:: 200

Statuskod:: 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=2024-04-01

Definitioner

Name	Description
BackupRestoreOperationType	Åtgärdstyp.
DatabaseBackupSetting	Inställningar för databassäkerhetskopiering.
DatabaseType	Databastyp (t.ex. SqlAzure/MySql).
DefaultErrorResponse	App Service-felsvar.
Details
Error	Felmodell.
RestoreRequest	Beskrivning av en återställningsbegäran.

BackupRestoreOperationType

Uppräkning

Åtgärdstyp.

Värde	Description
Clone
CloudFS
Default
Relocation
Snapshot

DatabaseBackupSetting

Objekt

Inställningar för databassäkerhetskopiering.

Name	Typ	Description
connectionString	string	Innehåller en anslutningssträng till en databas som säkerhetskopieras eller återställs. Om återställningen ska ske till en ny databas är databasnamnet inuti det nya.
connectionStringName	string	Innehåller ett namn på anslutningssträngen som är länkat till SiteConfig.ConnectionStrings. Detta används vid återställning med alternativ för att skriva över anslutningssträngar.
databaseType	DatabaseType	Databastyp (t.ex. SqlAzure/MySql).
name	string

DatabaseType

Uppräkning

Databastyp (t.ex. SqlAzure/MySql).

Värde	Description
LocalMySql
MySql
PostgreSql
SqlAzure

DefaultErrorResponse

Objekt

App Service-felsvar.

Name	Typ	Description
error	Error	Felmodell.

Details

Objekt

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

Error

Objekt

Felmodell.

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
details	Details[]	Detaljerade fel.
innererror	string	Mer information om felsökningsfel.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

RestoreRequest

Objekt

Beskrivning av en återställningsbegäran.

Name	Typ	Standardvärde	Description
id	string		Resurs-ID.
kind	string		Typ av resurs.
name	string		Resursnamn.
properties.adjustConnectionStrings	boolean		`true` om SiteConfig.ConnectionStrings ska anges i den nya appen. annars `false`.
properties.appServicePlan	string		Ange en apptjänstplan som ska äga en återställd webbplats.
properties.blobName	string		Namnet på en blob som innehåller säkerhetskopian.
properties.databases	DatabaseBackupSetting[]		Samling databaser som ska återställas. Den här listan måste matcha listan över databaser som ingår i säkerhetskopian.
properties.hostingEnvironment	string		App Service Environment-namn om det behövs (endast när du återställer en app till en App Service-miljö).
properties.ignoreConflictingHostNames	boolean	False	Ändrar en logik när du återställer en app med anpassade domäner. `true` för att ta bort anpassade domäner automatiskt. Om `false`läggs anpassade domäner till i appens objekt när det återställs, men det kan misslyckas på grund av konflikter under åtgärden.
properties.ignoreDatabases	boolean	False	Ignorera databaserna och återställ endast webbplatsinnehållet
properties.operationType	BackupRestoreOperationType	Default	Åtgärdstyp.
properties.overwrite	boolean		`true` om återställningsåtgärden kan skriva över målappen. annars `false`. `true` behövs om du försöker återställa över en befintlig app.
properties.siteName	string		Namnet på en app.
properties.storageAccountUrl	string		SAS-URL till containern.
type	string		Resurstyp.