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/sqlPools 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/sqlPools resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Synapse/workspaces/sqlPools@2021-06-01' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
collation: 'string'
createMode: 'string'
maxSizeBytes: int
provisioningState: 'string'
recoverableDatabaseId: 'string'
restorePointInTime: 'string'
sourceDatabaseDeletionDate: 'string'
sourceDatabaseId: 'string'
storageAccountType: 'string'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Synapse/workspaces/sqlPools
| 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 | SQL pool properties | SqlPoolResourceProperties |
| sku | SQL pool SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
Sku
| 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 |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The workspaces/sqlPools 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/sqlPools resource, add the following JSON to your template.
{
"type": "Microsoft.Synapse/workspaces/sqlPools",
"apiVersion": "2021-06-01",
"name": "string",
"location": "string",
"properties": {
"collation": "string",
"createMode": "string",
"maxSizeBytes": "int",
"provisioningState": "string",
"recoverableDatabaseId": "string",
"restorePointInTime": "string",
"sourceDatabaseDeletionDate": "string",
"sourceDatabaseId": "string",
"storageAccountType": "string"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Synapse/workspaces/sqlPools
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2021-06-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string (required) |
| properties | SQL pool properties | SqlPoolResourceProperties |
| sku | SQL pool SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Synapse/workspaces/sqlPools' |
Sku
| 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 |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure 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 |
Terraform (AzAPI provider) resource definition
The workspaces/sqlPools 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/sqlPools resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
collation = "string"
createMode = "string"
maxSizeBytes = int
provisioningState = "string"
recoverableDatabaseId = "string"
restorePointInTime = "string"
sourceDatabaseDeletionDate = "string"
sourceDatabaseId = "string"
storageAccountType = "string"
}
sku = {
capacity = int
name = "string"
tier = "string"
}
}
}
Property Values
Microsoft.Synapse/workspaces/sqlPools
| 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 | SQL pool properties | SqlPoolResourceProperties |
| sku | SQL pool SKU | Sku |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Synapse/workspaces/sqlPools@2021-06-01" |
Sku
| 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 |
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' |
TrackedResourceTags
| Name | Description | Value |
|---|