Web Apps - Backup

Creates a backup of an app.

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

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).

resourceGroupName
path True
  • string

Name of the resource group to which the resource belongs.

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

name
path True
  • string

Name of the app.

api-version
query True
  • string

API Version

Request Body

Name Required Type Description
kind
  • string

Kind of resource.

properties.backupSchedule

Schedule for the backup if it is executed periodically.

properties.databases

Databases included in the backup.

properties.enabled
  • boolean

True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.

properties.name True
  • string

Name of the backup.

properties.storageAccountUrl True
  • string

SAS URL to the container.

properties.type

Type of the backup.

Responses

Name Type Description
200 OK

OK

Definitions

BackupItem

Backup description.

BackupItemStatus

Backup status.

BackupRequest

Description of a backup which will be performed.

BackupRestoreOperationType

Type of the backup.

BackupSchedule

Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.

DatabaseBackupSetting

Database backup settings.

DatabaseType

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

FrequencyUnit

The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)

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.

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

BackupRequest

Description of a backup which will be performed.

Name Type Description
id
  • string

Resource Id.

kind
  • string

Kind of resource.

name
  • string

Resource Name.

properties.backupSchedule

Schedule for the backup if it is executed periodically.

properties.databases

Databases included in the backup.

properties.enabled
  • boolean

True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.

properties.name
  • string

Name of the backup.

properties.storageAccountUrl
  • string

SAS URL to the container.

properties.type

Type of the backup.

type
  • string

Resource type.

BackupRestoreOperationType

Type of the backup.

Name Type Description
Clone
  • string
Default
  • string
Relocation
  • string
Snapshot
  • string

BackupSchedule

Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.

Name Type Description
frequencyInterval
  • integer

How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)

frequencyUnit

The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)

keepAtLeastOneBackup
  • boolean

True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.

lastExecutionTime
  • string

Last time when this schedule was triggered.

retentionPeriodInDays
  • integer

After how many days backups should be deleted.

startTime
  • string

When the schedule should start working.

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

FrequencyUnit

The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)

Name Type Description
Day
  • string
Hour
  • string