Share via

Microsoft.Web sites/slots/backups 2015-08-01

  • Article

Bicep resource definition

The sites/slots/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/slots/backups resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Web/sites/slots/backups@2015-08-01' = {
  kind: 'string'
  location: 'string'
  name: 'string'
  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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

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

Microsoft.Web/sites/slots/backups

Name Description Value
kind Kind of resource string
location Resource Location string (required)
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/slots
properties RestoreRequestPropertiesOrBackupItemProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

RestoreRequestPropertiesOrBackupItemProperties

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 Operation type 'Clone'
'Default'
'Relocation' (required)
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

ARM template resource definition

The sites/slots/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/slots/backups resource, add the following JSON to your template.

{
  "type": "Microsoft.Web/sites/slots/backups",
  "apiVersion": "2015-08-01",
  "name": "string",
  "kind": "string",
  "location": "string",
  "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

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

Microsoft.Web/sites/slots/backups

Name Description Value
apiVersion The api version '2015-08-01'
kind Kind of resource string
location Resource Location string (required)
name The resource name 'discover' (required)
properties RestoreRequestPropertiesOrBackupItemProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Web/sites/slots/backups'

ResourceTags

Name Description Value

RestoreRequestPropertiesOrBackupItemProperties

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 Operation type 'Clone'
'Default'
'Relocation' (required)
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

Terraform (AzAPI provider) resource definition

The sites/slots/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/slots/backups resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/slots/backups@2015-08-01"
  name = "string"
  kind = "string"
  location = "string"
  body = jsonencode({
    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"
    }
  })
  tags = {
    {customized property} = "string"
  }
}

Property values

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

Microsoft.Web/sites/slots/backups

Name Description Value
kind Kind of resource string
location Resource Location string (required)
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/slots
properties RestoreRequestPropertiesOrBackupItemProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Web/sites/slots/backups@2015-08-01"

ResourceTags

Name Description Value

RestoreRequestPropertiesOrBackupItemProperties

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 Operation type 'Clone'
'Default'
'Relocation' (required)
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