Web Apps - List Site Backups

Service:: App Service

API Version:: 2025-03-01

Description for Gets existing backups of an app.

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

URI Parameters

Name	In	Required	Type	Description
name	path	True	string	Name of the app.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Name of the resource group to which the resource belongs.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	BackupItemCollection	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

List backups

Sample request

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_slot_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_site_backups(
        resource_group_name="testrg123",
        name="tests346",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/ListSlotBackups.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/ListSlotBackups.json
func ExampleWebAppsClient_NewListSiteBackupsSlotPager() {
	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().NewListSiteBackupsSlotPager("testrg123", "tests346", "staging", 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("tests346/staging"),
		// 			Type: to.Ptr("Microsoft.Web/sites/slots"),
		// 			ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging"),
		// 			Properties: &armappservice.BackupItemProperties{
		// 				BlobName: to.Ptr("blob1"),
		// 				Status: to.Ptr(armappservice.BackupItemStatusInProgress),
		// 				StorageAccountURL: to.Ptr("https://blobstorage.windows.net"),
		// 			},
		// 	}},
		// }
	}
}

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/ListSlotBackups.json
 */
async function listBackups() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "tests346";
  const slot = "staging";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.webApps.listSiteBackupsSlot(resourceGroupName, name, slot)) {
    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

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/tests346/slot/staging",
      "name": "tests346/staging",
      "type": "Microsoft.Web/sites/slots",
      "properties": {
        "storageAccountUrl": "https://blobstorage.windows.net",
        "blobName": "blob1",
        "status": "InProgress"
      }
    }
  ]
}

Definitions

Name	Description
BackupItem	Backup description.
BackupItemCollection	Collection of backup items.
BackupItemStatus	Backup status.
DatabaseBackupSetting	Database backup settings.
DatabaseType	Database type (e.g. SqlAzure / MySql).
DefaultErrorResponse	App Service error response.
Details
Error	Error model.

BackupItem

Object

Backup description.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.blobName	string	Name of the blob which contains data for this backup.
properties.correlationId	string	Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
properties.created	string (date-time)	Timestamp of the backup creation.
properties.databases	DatabaseBackupSetting[]	List of databases included in the backup.
properties.finishedTimeStamp	string (date-time)	Timestamp when this backup finished.
properties.id	integer (int32)	Id of the backup.
properties.lastRestoreTimeStamp	string (date-time)	Timestamp of a last restore operation which used this backup.
properties.log	string	Details regarding this backup. Might contain an error message.
properties.name	string	Name of this backup.
properties.scheduled	boolean	True if this backup has been created due to a schedule being triggered.
properties.sizeInBytes	integer (int64)	Size of the backup in bytes.
properties.status	BackupItemStatus	Backup status.
properties.storageAccountUrl	string	SAS URL for the storage account container which contains this backup.
properties.websiteSizeInBytes	integer (int64)	Size of the original web app which has been backed up.
type	string	Resource type.

BackupItemCollection

Object

Collection of backup items.

Name	Type	Description
nextLink	string	Link to next page of resources.
value	BackupItem[]	Collection of resources.

BackupItemStatus

Enumeration

Backup status.

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

DatabaseBackupSetting

Object

Database backup settings.

Name	Type	Description
connectionString	string	Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.
connectionStringName	string	Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
databaseType	DatabaseType	Database type (e.g. SqlAzure / MySql).
name	string

DatabaseType

Enumeration

Database type (e.g. SqlAzure / MySql).

Value	Description
SqlAzure
MySql
LocalMySql
PostgreSql

DefaultErrorResponse

Object

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Object

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Error

Object

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

Share via

Web Apps - List Site Backups

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List backups

Sample request

Sample response

Definitions

BackupItem

BackupItemCollection

BackupItemStatus

DatabaseBackupSetting

DatabaseType

DefaultErrorResponse

Details

Error