The workspaces/sqlPools resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.Synapse/workspaces/sqlPools resource, add the following JSON to your template.
{
"type": "Microsoft.Synapse/workspaces/sqlPools",
"apiVersion": "2021-06-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"properties": {
"collation": "string",
"createMode": "string",
"maxSizeBytes": "int",
"provisioningState": "string",
"recoverableDatabaseId": "string",
"restorePointInTime": "string",
"sourceDatabaseDeletionDate": "string",
"sourceDatabaseId": "string",
"storageAccountType": "string"
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.Synapse/workspaces/sqlPools' |
apiVersion | The resource api version | '2021-06-01' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) Character limit: 1-60 Valid characters: Can't contain <>*%&:\/?@- or control characters. Can't end with . or space. Can't contain reserved word. |
location | The geo-location where the resource lives | string (required) |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
sku | SQL pool SKU | Sku |
properties | SQL pool properties | SqlPoolResourceProperties |
Name | Description | Value |
---|---|---|
collation | Collation mode | string |
createMode | Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified. |
'Default' 'PointInTimeRestore' 'Recovery' 'Restore' |
maxSizeBytes | Maximum size in bytes | int |
provisioningState | Resource state | string |
recoverableDatabaseId | Backup database to restore from | string |
restorePointInTime | Snapshot time to restore | string |
sourceDatabaseDeletionDate | Specifies the time that the sql pool was deleted | string |
sourceDatabaseId | Source database to create from | string |
storageAccountType | The storage account type used to store backups for this sql pool. | 'GRS' 'LRS' |
Name | Description | Value |
---|---|---|
capacity | If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. | int |
name | The SKU name | string |
tier | The service tier | string |
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Azure Synapse Proof-of-Concept |
This template creates a proof of concept environment for Azure Synapse, including SQL Pools and optional Apache Spark Pools |