Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The workspaces/sqlDatabases resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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 Bicep to your template.
resource symbolicname 'Microsoft.Synapse/workspaces/sqlDatabases@2020-04-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
collation: 'string'
dataRetention: {
dropRetentionPeriod: 'string'
retentionPeriod: 'string'
}
storageRedundancy: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Synapse/workspaces/sqlDatabases
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (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: workspaces |
| properties | Resource properties. | SqlDatabaseProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
SqlDatabaseDataRetention
| Name | Description | Value |
|---|---|---|
| dropRetentionPeriod | Specifies the dropped database retention period (ISO8601 format). | string |
| retentionPeriod | Specifies the data retention period (ISO8601 format). | string |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The workspaces/sqlDatabases resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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",
"properties": {
"collation": "string",
"dataRetention": {
"dropRetentionPeriod": "string",
"retentionPeriod": "string"
},
"storageRedundancy": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Synapse/workspaces/sqlDatabases
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2020-04-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | Resource properties. | SqlDatabaseProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Synapse/workspaces/sqlDatabases' |
SqlDatabaseDataRetention
| Name | Description | Value |
|---|---|---|
| dropRetentionPeriod | Specifies the dropped database retention period (ISO8601 format). | string |
| retentionPeriod | Specifies the data retention period (ISO8601 format). | string |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The workspaces/sqlDatabases 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.Synapse/workspaces/sqlDatabases resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces/sqlDatabases@2020-04-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
collation = "string"
dataRetention = {
dropRetentionPeriod = "string"
retentionPeriod = "string"
}
storageRedundancy = "string"
}
}
}
Property Values
Microsoft.Synapse/workspaces/sqlDatabases
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
| properties | Resource properties. | SqlDatabaseProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Synapse/workspaces/sqlDatabases@2020-04-01-preview" |
SqlDatabaseDataRetention
| Name | Description | Value |
|---|---|---|
| dropRetentionPeriod | Specifies the dropped database retention period (ISO8601 format). | string |
| retentionPeriod | Specifies the data retention period (ISO8601 format). | string |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|