Microsoft.Web sites/backups 2015-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@2015-08-01' = {
  name: 'discover'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  parent: parentSymbolicName
  properties: {
    adjustConnectionStrings: bool
    blobName: 'string'
    databases: [
      {
        connectionString: 'string'
        connectionStringName: 'string'
        databaseType: 'string'
        name: 'string'
      }
    ]
    hostingEnvironment: 'string'
    ignoreConflictingHostNames: 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.
'2015-08-01'
name The resource name

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

RestoreRequestProperties

Name Description Value
adjustConnectionStrings Gets or sets a flag showing if SiteConfig.ConnectionStrings should be set in new site bool
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 a site to an App Service Environment) string
ignoreConflictingHostNames Changes a logic when restoring a site with custom domains. If "true", custom domains are removed automatically. If "false", custom domains are added to
the site object when it is being restored, but that might fail due to conflicts during the operation.
bool
operationType Type of the backup 'Clone'
'Default'
'Relocation'
overwrite True if the restore operation can overwrite target site. "True" needed if trying to restore over an existing site. bool
siteName Name of a site (Web App) string
storageAccountUrl SAS URL to the container 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