Microsoft.Web sites/config backup 2018-02-01

Template format

To create a Microsoft.Web/sites/config resource for app settings, add the following JSON to the resources section of your template.

{
  "name": "backup",
  "type": "Microsoft.Web/sites/config",
  "apiVersion": "2018-02-01",
  "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

The following tables describe the values you need to set in the schema.

Microsoft.Web/sites/config object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes backup
-or-
{site-name}/backup
type enum Yes For JSON - config
-or-
Microsoft.Web/sites/config

See Set name and type for child resources.
apiVersion enum Yes For JSON - 2018-02-01
properties object Yes Request resource specific properties - Backup object

Backup object

Name Type Required Value
backupName string No Name of the backup.
backupSchedule object No Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. - BackupSchedule object
databases array No Databases included in the backup. - Database object
enabled bool No True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.
storageAccountUrl string Yes SAS URL to the container.

BackupSchedule object

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

Database object

Name Type Required Value
connectionString string No 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 No Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.
databaseType string Yes Database type (e.g. SqlAzure / MySql). - LocalMySql, MySql, PostgreSql, SqlAzure
name string No