Web Apps - Get Backup Configuration

Gets the backup configuration of an app.
Description for Gets the backup configuration of an app.

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

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)

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

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

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.

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