Web Apps - List Backups

Servicio:: App Service

Versión de la API:: 2025-03-01

Descripción de Obtiene copias de seguridad existentes de una aplicación.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre de la aplicación.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	BackupItemCollection	La operación de Azure se completó correctamente.
Other Status Codes	DefaultErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List web app backups

Solicitud de ejemplo

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


/**
 * Samples for WebApps ListBackups.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-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

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/AppService/stable/2025-03-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

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/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-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_2025-03-01"),
		// 				BlobName: to.Ptr("sitef6141_2025-03-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

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/AppService/stable/2025-03-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

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "name": "sitef6141",
      "type": "Microsoft.Web/sites",
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backups/12345",
      "properties": {
        "name": "sitef6141_2024-11-01",
        "blobName": "sitef6141_2024-11-01",
        "created": "2022-09-03T17:33:11.641Z",
        "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"
          }
        ],
        "finishedTimeStamp": "2022-09-05T17:33:11.641Z",
        "id": 12345,
        "lastRestoreTimeStamp": "2022-09-04T17:33:11.641Z",
        "log": "Succeeded",
        "scheduled": true,
        "sizeInBytes": 56091883,
        "status": "InProgress",
        "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
        "websiteSizeInBytes": 56091883
      }
    }
  ]
}

Definiciones

Nombre	Description
BackupItem	Descripción de la copia de seguridad.
BackupItemCollection	Colección de elementos de respaldo.
BackupItemStatus	Estado de la copia de seguridad.
createdByType	Tipo de identidad que creó el recurso.
DatabaseBackupSetting	Configuración de copia de seguridad de la base de datos.
DatabaseType	Tipo de base de datos (por ejemplo, SqlAzure /MySql).
DefaultErrorResponse	Respuesta de error de App Service.
DefaultErrorResponseError	Modelo de error.
DefaultErrorResponseErrorDetailsItem	Errores detallados.
systemData	Metadatos relativos a la creación y última modificación del recurso.

BackupItem

Objeto

Descripción de la copia de seguridad.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de recurso.
name	string	Nombre del recurso
properties.blobName	string	Nombre del blob que contiene datos para esta copia de seguridad.
properties.correlationId	string	Identificador único de correlación. Úselo junto con la marca de tiempo mientras se comunica con el soporte técnico de Azure.
properties.created	string (date-time)	Marca de tiempo de la creación de la copia de seguridad.
properties.databases	DatabaseBackupSetting[]	Lista de bases de datos incluidas en la copia de seguridad.
properties.finishedTimeStamp	string (date-time)	Marca de tiempo cuando finalizó esta copia de seguridad.
properties.id	integer (int32)	Identificador de la copia de seguridad.
properties.lastRestoreTimeStamp	string (date-time)	Marca de tiempo de una última operación de restauración que utilizó esta copia de seguridad.
properties.log	string	Detalles sobre esta copia de seguridad. Puede contener un mensaje de error.
properties.name	string	Nombre de esta copia de seguridad.
properties.scheduled	boolean	True si esta copia de seguridad se ha creado debido a que se ha activado una programación.
properties.sizeInBytes	integer (int64)	Tamaño de la copia de seguridad en bytes.
properties.status	BackupItemStatus	Estado de la copia de seguridad.
properties.storageAccountUrl	string	Dirección URL de SAS para el contenedor de la cuenta de almacenamiento que contiene esta copia de seguridad.
properties.websiteSizeInBytes	integer (int64)	Tamaño de la aplicación web original de la que se ha realizado una copia de seguridad.
systemData	systemData	Metadatos de Azure Resource Manager que contienen información createdBy y modifiedBy.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BackupItemCollection

Objeto

Colección de elementos de respaldo.

Nombre	Tipo	Description
nextLink	string (uri)	El enlace a la siguiente página de artículos
value	BackupItem[]	Los elementos de BackupItem en esta página

BackupItemStatus

Enumeración

Estado de la copia de seguridad.

Valor	Description
InProgress
Failed
Succeeded
TimedOut
Created
Skipped
PartiallySucceeded
DeleteInProgress
DeleteFailed
Deleted

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

DatabaseBackupSetting

Objeto

Configuración de copia de seguridad de la base de datos.

Nombre	Tipo	Description
connectionString	string	Contiene una cadena de conexión a una base de datos de la que se realiza una copia de seguridad o se restaura. Si la restauración debe producirse en una nueva base de datos, el nombre de la base de datos dentro es el nuevo.
connectionStringName	string	Contiene un nombre de cadena de conexión que está vinculado a SiteConfig.ConnectionStrings. Esto se usa durante la restauración con opciones de cadenas de conexión sobrescritura.
databaseType	DatabaseType	Tipo de base de datos (por ejemplo, SqlAzure /MySql).
name	string

DatabaseType

Enumeración

Tipo de base de datos (por ejemplo, SqlAzure /MySql).

Valor	Description
SqlAzure
MySql
LocalMySql
PostgreSql

DefaultErrorResponse

Objeto

Respuesta de error de App Service.

Nombre	Tipo	Description
error	DefaultErrorResponseError	Modelo de error.

DefaultErrorResponseError

Objeto

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar el error mediante programación.
details	DefaultErrorResponseErrorDetailsItem[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

DefaultErrorResponseErrorDetailsItem

Objeto

Errores detallados.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar el error mediante programación.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Compartir a través de

Web Apps - List Backups

Parámetros de identificador URI

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

List web app backups

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BackupItem

BackupItemCollection

BackupItemStatus

createdByType

DatabaseBackupSetting

DatabaseType

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

systemData