Microsoft.Web sites/slots/config 'backup' 2015-08-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@2015-08-01' = {
name: 'backup'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
parent: resourceSymbolicName
properties: {
backupSchedule: {
frequencyInterval: int
frequencyUnit: 'string'
keepAtLeastOneBackup: bool
lastExecutionTime: 'string'
retentionPeriodInDays: int
startTime: 'string'
}
databases: [
{
connectionString: 'string'
connectionStringName: 'string'
databaseType: 'string'
name: 'string'
}
]
enabled: bool
name: 'string'
storageAccountUrl: 'string'
type: 'string'
}
}
Property values
sites/slots/config-backup
| Name | Description | Value |
|---|---|---|
| type | The resource type For Bicep, set this value in the resource declaration. |
'Microsoft.Web/sites/slots/config' |
| apiVersion | The resource api version For Bicep, set this value in the resource declaration. |
'2015-08-01' |
| name | The resource name See how to set names and types for child resources in Bicep or JSON ARM templates. |
'backup' |
| location | Resource Location | string (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in 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. |
Symbolic name for resource of type: slots |
| properties | BackupRequestProperties |
BackupRequestProperties
| Name | Description | Value |
|---|---|---|
| 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 |
| name | Name of the backup | string |
| storageAccountUrl | SAS URL to the container | string |
| type | Type of the backup | 'Clone' 'Default' 'Relocation' |
BackupSchedule
| Name | Description | Value |
|---|---|---|
| frequencyInterval | How often should be the backup executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) | int |
| frequencyUnit | How often should be the backup executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) | 'Day' 'Hour' |
| 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 |
| lastExecutionTime | The last time when this schedule was triggered | string |
| retentionPeriodInDays | After how many days backups should be deleted | int |
| startTime | When the schedule should start working | string |
DatabaseBackupSetting
| Name | Description | Value |
|---|---|---|
| connectionString | Contains a connection string to a database which is being backed up/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. |
string |
| databaseType | SqlAzure / MySql | string |
| name | string |