Microsoft.Web sites/backups 2016-08-01

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

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

Template format

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

resource symbolicname 'Microsoft.Web/sites/backups@2016-08-01' = {
  name: 'discover'
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    adjustConnectionStrings: bool
    appServicePlan: 'string'
    blobName: 'string'
    databases: [
      {
        connectionString: 'string'
        connectionStringName: 'string'
        databaseType: 'string'
        name: 'string'
      }
    ]
    hostingEnvironment: 'string'
    ignoreConflictingHostNames: bool
    ignoreDatabases: bool
    operationType: 'string'
    overwrite: bool
    siteName: 'string'
    storageAccountUrl: 'string'
  }
}

Property values

sites/backups

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.Web/sites/backups'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2016-08-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
'discover'
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: sites
properties RestoreRequest resource specific properties RestoreRequestProperties

RestoreRequestProperties

Name Description Value
adjustConnectionStrings true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false. bool
appServicePlan Specify app service plan that will own restored site. string
blobName Name of a blob which contains the backup. string
databases Collection of databases which should be restored. This list has to match the list of databases included in the backup. DatabaseBackupSetting[]
hostingEnvironment App Service Environment name, if needed (only when restoring an app to an App Service Environment). string
ignoreConflictingHostNames Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to
the app's object when it is being restored, but that might fail due to conflicts during the operation.
bool
ignoreDatabases Ignore the databases and only restore the site content bool
operationType Type of the backup. 'Clone'
'Default'
'Relocation'
'Snapshot'
overwrite true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app. bool (required)
siteName Name of an app. string
storageAccountUrl SAS URL to the container. string (required)

DatabaseBackupSetting

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.
string
databaseType Database type (e.g. SqlAzure / MySql). 'LocalMySql'
'MySql'
'PostgreSql'
'SqlAzure'
name string