Compartilhar via

Web Apps - Backup

  • Reference
Service:
App Service
API Version:
2024-04-01

Description for Creates a backup of an app.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup?api-version=2024-04-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

Request Body

Name Required Type Description
properties.storageAccountUrl True

string

SAS URL to the container.
kind

string

Kind of resource.
properties.backupName

string

Name of the backup.
properties.backupSchedule

BackupSchedule

Schedule for the backup if it is executed periodically.
properties.databases

DatabaseBackupSetting[]

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.

Responses

Name Type Description
200 OK

BackupItem

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

Backup web app

Sample request

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/backup?api-version=2024-04-01

{
  "properties": {
    "storageAccountUrl": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=<account-key>",
    "backupName": "abcdwe",
    "enabled": true,
    "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>]"
      }
    ],
    "backupSchedule": {
      "frequencyInterval": 7,
      "frequencyUnit": "Day",
      "keepAtLeastOneBackup": true,
      "retentionPeriodInDays": 30,
      "startTime": "2022-09-02T17:33:11.641Z"
    }
  }
}

Sample response

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

Definitions

Name Description
BackupItem

Backup description.
BackupItemStatus

Backup status.
BackupRequest

Description of a backup which will be performed.
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).
DefaultErrorResponse

App Service error response.
Details
Error

Error model.
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

DatabaseBackupSetting[]

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

BackupItemStatus

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.backupName

string

Name of the backup.
properties.backupSchedule

BackupSchedule

Schedule for the backup if it is executed periodically.
properties.databases

DatabaseBackupSetting[]

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.storageAccountUrl

string

SAS URL to the container.
type

string

Resource type.

BackupSchedule

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

Name Type Default value Description
frequencyInterval

integer

7

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

FrequencyUnit

Day

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

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

30

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

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

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

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.

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