Web Apps - List Backups

Gets existing backups of an app.
Description for Gets existing backups of an app.

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

URI Parameters

Name In Required Type Description
name
path True
  • string

Name of the app.

resourceGroupName
path True
  • string

Name of the resource group to which the resource belongs.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

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

OK

Other Status Codes

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

Definitions

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

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

Timestamp of the backup creation.

properties.databases

List of databases included in the backup.

properties.finishedTimeStamp
  • string

Timestamp when this backup finished.

properties.id
  • integer

Id of the backup.

properties.lastRestoreTimeStamp
  • string

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

Size of the backup in bytes.

properties.status

Backup status.

properties.storageAccountUrl
  • string

SAS URL for the storage account container which contains this backup.

properties.websiteSizeInBytes
  • integer

Size of the original web app which has been backed up.

type
  • string

Resource type.

BackupItemCollection

Collection of backup items.

Name Type Description
nextLink
  • string

Link to next page of resources.

value

Collection of resources.

BackupItemStatus

Backup status.

Name Type Description
Created
  • string
DeleteFailed
  • string
DeleteInProgress
  • string
Deleted
  • string
Failed
  • string
InProgress
  • string
PartiallySucceeded
  • string
Skipped
  • string
Succeeded
  • string
TimedOut
  • string

DatabaseBackupSetting

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

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

name
  • string

DatabaseType

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

Name Type Description
LocalMySql
  • string
MySql
  • string
PostgreSql
  • string
SqlAzure
  • string

DefaultErrorResponse

App Service error response.

Name Type Description
error

Error model.

Details

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

Error model.

Name Type Description
code
  • string

Standardized string to programmatically identify the error.

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.