Microsoft.Web sites/slots/config 'backup' 2021-01-01

The sites/slots/config resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Options for name property

The sites/slots/config resource accepts different properties based on the value of the name property. This article shows the properties that are available when you set name: 'backup'.

For other options, see:

Template format

To create a Microsoft.Web/sites/slots/config resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.Web/sites/slots/config@2021-01-01' = {
  name: 'backup'
  kind: 'string'
  parent: parentSymbolicName
  properties: {
    backupName: 'string'
    backupSchedule: {
      frequencyInterval: int
      frequencyUnit: 'string'
      keepAtLeastOneBackup: bool
      retentionPeriodInDays: int
      startTime: 'string'
    databases: [
        connectionString: 'string'
        connectionStringName: 'string'
        databaseType: 'string'
        name: 'string'
    enabled: bool
    storageAccountUrl: 'string'

Property values


Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
kind Kind of resource. string
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
properties BackupRequest resource specific properties BackupRequestProperties


Name Description Value
backupName Name of the backup. string
backupSchedule Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. BackupSchedule
databases Databases included in the backup. DatabaseBackupSetting[]
enabled True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled. bool
storageAccountUrl SAS URL to the container. string (required)


Name Description Value
frequencyInterval 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) int (required)
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) 'Day'
keepAtLeastOneBackup True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. bool (required)
retentionPeriodInDays After how many days backups should be deleted. int (required)
startTime When the schedule should start working. string


Name Description Value
connectionString 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. string
connectionStringName 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). 'LocalMySql'
name string