Web Apps - Restore

Riferimento

Servizio:: App Service

Versione API:: 2024-04-01

Descrizione per Ripristina un backup specifico in un'altra app (o in uno slot di distribuzione, se specificato).

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
backupId	path	True	string	ID del backup.
name	path	True	string	Nome dell'app.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome del gruppo di risorse a cui appartiene la risorsa.
subscriptionId	path	True	string	ID sottoscrizione di Azure. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versione API

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.overwrite	True	boolean	`true` se l'operazione di ripristino può sovrascrivere l'app di destinazione; in caso contrario, `false`. `true` è necessario se si tenta di eseguire il ripristino su un'app esistente.
properties.storageAccountUrl	True	string	URL di firma di accesso condiviso al contenitore.
kind		string	Tipo di risorsa.
properties.adjustConnectionStrings		boolean	`true` se SiteConfig.ConnectionStrings deve essere impostato nella nuova app; in caso contrario, `false`.
properties.appServicePlan		string	Specificare il piano di servizio app che sarà proprietario del sito ripristinato.
properties.blobName		string	Nome di un BLOB che contiene il backup.
properties.databases		DatabaseBackupSetting[]	Raccolta di database da ripristinare. Questo elenco deve corrispondere all'elenco dei database inclusi nel backup.
properties.hostingEnvironment		string	Nome dell'ambiente del servizio app, se necessario (solo quando si ripristina un'app in un ambiente del servizio app).
properties.ignoreConflictingHostNames		boolean	Modifica una logica durante il ripristino di un'app con domini personalizzati. `true` rimuovere automaticamente i domini personalizzati. Se `false`, i domini personalizzati vengono aggiunti all'oggetto dell'app quando viene ripristinato, ma questo potrebbe non riuscire a causa di conflitti durante l'operazione.
properties.ignoreDatabases		boolean	Ignorare i database e ripristinare solo il contenuto del sito
properties.operationType		BackupRestoreOperationType	Tipo di operazione.
properties.siteName		string	Nome di un'app.

Risposte

Nome	Tipo	Descrizione
200 OK		Operazione di ripristino avviata.
202 Accepted		Operazione di ripristino avviata.
Other Status Codes	DefaultErrorResponse	Risposta di errore del servizio app.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Restore web app from backup

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 200

Codice di stato:: 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

Definizioni

Nome	Descrizione
BackupRestoreOperationType	Tipo di operazione.
DatabaseBackupSetting	Impostazioni di backup del database.
DatabaseType	Tipo di database (ad esempio SqlAzure/MySql).
DefaultErrorResponse	Risposta di errore del servizio app.
Details
Error	Modello di errore.
RestoreRequest	Descrizione di una richiesta di ripristino.

BackupRestoreOperationType

Enumerazione

Tipo di operazione.

Valore	Descrizione
Clone
CloudFS
Default
Relocation
Snapshot

DatabaseBackupSetting

Object

Impostazioni di backup del database.

Nome	Tipo	Descrizione
connectionString	string	Contiene una stringa di connessione a un database di cui viene eseguito il backup o il ripristino. Se il ripristino dovrebbe verificarsi in un nuovo database, il nome del database all'interno è quello nuovo.
connectionStringName	string	Contiene un nome di stringa di connessione collegato a SiteConfig.ConnectionStrings. Viene usato durante il ripristino con le opzioni sovrascrivere le stringhe di connessione.
databaseType	DatabaseType	Tipo di database (ad esempio SqlAzure/MySql).
name	string

DatabaseType

Enumerazione

Tipo di database (ad esempio SqlAzure/MySql).

Valore	Descrizione
LocalMySql
MySql
PostgreSql
SqlAzure

DefaultErrorResponse

Object

Risposta di errore del servizio app.

Nome	Tipo	Descrizione
error	Error	Modello di errore.

Details

Object

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

Error

Object

Modello di errore.

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
details	Details[]	Errori dettagliati.
innererror	string	Altre informazioni per eseguire il debug dell'errore.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

RestoreRequest

Object

Descrizione di una richiesta di ripristino.

Nome	Tipo	Valore predefinito	Descrizione
id	string		ID risorsa.
kind	string		Tipo di risorsa.
name	string		Nome risorsa.
properties.adjustConnectionStrings	boolean		`true` se SiteConfig.ConnectionStrings deve essere impostato nella nuova app; in caso contrario, `false`.
properties.appServicePlan	string		Specificare il piano di servizio app che sarà proprietario del sito ripristinato.
properties.blobName	string		Nome di un BLOB che contiene il backup.
properties.databases	DatabaseBackupSetting[]		Raccolta di database da ripristinare. Questo elenco deve corrispondere all'elenco dei database inclusi nel backup.
properties.hostingEnvironment	string		Nome dell'ambiente del servizio app, se necessario (solo quando si ripristina un'app in un ambiente del servizio app).
properties.ignoreConflictingHostNames	boolean	False	Modifica una logica durante il ripristino di un'app con domini personalizzati. `true` rimuovere automaticamente i domini personalizzati. Se `false`, i domini personalizzati vengono aggiunti all'oggetto dell'app quando viene ripristinato, ma questo potrebbe non riuscire a causa di conflitti durante l'operazione.
properties.ignoreDatabases	boolean	False	Ignorare i database e ripristinare solo il contenuto del sito
properties.operationType	BackupRestoreOperationType	Default	Tipo di operazione.
properties.overwrite	boolean		`true` se l'operazione di ripristino può sovrascrivere l'app di destinazione; in caso contrario, `false`. `true` è necessario se si tenta di eseguire il ripristino su un'app esistente.
properties.siteName	string		Nome di un'app.
properties.storageAccountUrl	string		URL di firma di accesso condiviso al contenitore.
type	string		Tipo di risorsa.