Share via

Microsoft.Web sites/backups 2016-08-01

  • Article

Bicep resource definition

The sites/backups resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

resource symbolicname 'Microsoft.Web/sites/backups@2016-08-01' = {
  kind: 'string'
  name: 'string'
  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

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' (required)
name string

Microsoft.Web/sites/backups

Name Description Value
kind Kind of resource. string
name The resource name 'discover' (required)
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 RestoreRequestPropertiesOrBackupItemProperties

RestoreRequestPropertiesOrBackupItemProperties

Name Description Value
adjustConnectionStrings <code>true</code> if SiteConfig.ConnectionStrings should be set in new app; otherwise, <code>false</code>. 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. <code>true</code> to remove custom domains automatically. If <code>false</code>, 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 Operation type. 'Clone'
'Default'
'Relocation'
'Snapshot'
overwrite <code>true</code> if the restore operation can overwrite target app; otherwise, <code>false</code>. <code>true</code> 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)

ARM template resource definition

The sites/backups resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

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

{
  "type": "Microsoft.Web/sites/backups",
  "apiVersion": "2016-08-01",
  "name": "string",
  "kind": "string",
  "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

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' (required)
name string

Microsoft.Web/sites/backups

Name Description Value
apiVersion The api version '2016-08-01'
kind Kind of resource. string
name The resource name 'discover' (required)
properties RestoreRequest resource specific properties RestoreRequestPropertiesOrBackupItemProperties
type The resource type 'Microsoft.Web/sites/backups'

RestoreRequestPropertiesOrBackupItemProperties

Name Description Value
adjustConnectionStrings <code>true</code> if SiteConfig.ConnectionStrings should be set in new app; otherwise, <code>false</code>. 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. <code>true</code> to remove custom domains automatically. If <code>false</code>, 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 Operation type. 'Clone'
'Default'
'Relocation'
'Snapshot'
overwrite <code>true</code> if the restore operation can overwrite target app; otherwise, <code>false</code>. <code>true</code> 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)

Terraform (AzAPI provider) resource definition

The sites/backups resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/backups@2016-08-01"
  name = "string"
  kind = "string"
  body = jsonencode({
    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

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' (required)
name string

Microsoft.Web/sites/backups

Name Description Value
kind Kind of resource. string
name The resource name 'discover' (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: sites
properties RestoreRequest resource specific properties RestoreRequestPropertiesOrBackupItemProperties
type The resource type "Microsoft.Web/sites/backups@2016-08-01"

RestoreRequestPropertiesOrBackupItemProperties

Name Description Value
adjustConnectionStrings <code>true</code> if SiteConfig.ConnectionStrings should be set in new app; otherwise, <code>false</code>. 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. <code>true</code> to remove custom domains automatically. If <code>false</code>, 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 Operation type. 'Clone'
'Default'
'Relocation'
'Snapshot'
overwrite <code>true</code> if the restore operation can overwrite target app; otherwise, <code>false</code>. <code>true</code> 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)