Microsoft.Synapse workspaces/sqlDatabases

ARM template resource definition

The workspaces/sqlDatabases 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.Synapse/workspaces/sqlDatabases resource, add the following JSON to your template.

{
  "type": "Microsoft.Synapse/workspaces/sqlDatabases",
  "apiVersion": "2020-04-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "collation": "string",
    "dataRetention": {
      "dropRetentionPeriod": "string",
      "retentionPeriod": "string"
    },
    "storageRedundancy": "string"
  }
}

Property values

workspaces/sqlDatabases

Name Description Value
type The resource type 'Microsoft.Synapse/workspaces/sqlDatabases'
apiVersion The resource api version '2020-04-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
properties Resource properties. SqlDatabaseProperties

SqlDatabaseProperties

Name Description Value
collation The collation of the database. string
dataRetention Sql database data retention. SqlDatabaseDataRetention
storageRedundancy The storage redundancy of the database. 'Geo'
'GeoZone'
'Local'
'Zone'

SqlDatabaseDataRetention

Name Description Value
dropRetentionPeriod Specifies the dropped database retention period (ISO8601 format). string
retentionPeriod Specifies the data retention period (ISO8601 format). string