Microsoft.Synapse workspaces/sqlPools 2021-03-01
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-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
capacity: int
name: 'string'
tier: 'string'
}
parent: resourceSymbolicName
properties: {
collation: 'string'
createMode: 'string'
creationDate: 'string'
maxSizeBytes: int
provisioningState: 'string'
recoverableDatabaseId: 'string'
restorePointInTime: 'string'
sourceDatabaseId: 'string'
status: 'string'
storageAccountType: 'string'
}
}
Property values
workspaces/sqlPools
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
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 |
| 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 |
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' |
| creationDate | Date the SQL pool was created | string |
| maxSizeBytes | Maximum size in bytes | int |
| provisioningState | Resource state | string |
| recoverableDatabaseId | Backup database to restore from | string |
| restorePointInTime | Snapshot time to restore | string |
| sourceDatabaseId | Source database to create from | string |
| status | Resource status | string |
| storageAccountType | The storage account type used to store backups for this sql pool. | 'GRS' 'LRS' 'ZRS' |
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 |
Quickstart templates
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 |
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-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"capacity": "int",
"name": "string",
"tier": "string"
},
"properties": {
"collation": "string",
"createMode": "string",
"creationDate": "string",
"maxSizeBytes": "int",
"provisioningState": "string",
"recoverableDatabaseId": "string",
"restorePointInTime": "string",
"sourceDatabaseId": "string",
"status": "string",
"storageAccountType": "string"
}
}
Property values
workspaces/sqlPools
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Synapse/workspaces/sqlPools' |
| apiVersion | The resource api version | '2021-03-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 |
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' |
| creationDate | Date the SQL pool was created | string |
| maxSizeBytes | Maximum size in bytes | int |
| provisioningState | Resource state | string |
| recoverableDatabaseId | Backup database to restore from | string |
| restorePointInTime | Snapshot time to restore | string |
| sourceDatabaseId | Source database to create from | string |
| status | Resource status | string |
| storageAccountType | The storage account type used to store backups for this sql pool. | 'GRS' 'LRS' 'ZRS' |
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 |
Quickstart templates
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 |
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-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
collation = "string"
createMode = "string"
creationDate = "string"
maxSizeBytes = int
provisioningState = "string"
recoverableDatabaseId = "string"
restorePointInTime = "string"
sourceDatabaseId = "string"
status = "string"
storageAccountType = "string"
}
sku = {
capacity = int
name = "string"
tier = "string"
}
})
}
Property values
workspaces/sqlPools
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Synapse/workspaces/sqlPools@2021-03-01" |
| name | The resource name | 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) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: workspaces |
| tags | Resource tags. | Dictionary of tag names and values. |
| sku | SQL pool SKU | Sku |
| properties | SQL pool properties | SqlPoolResourceProperties |
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" |
| creationDate | Date the SQL pool was created | string |
| maxSizeBytes | Maximum size in bytes | int |
| provisioningState | Resource state | string |
| recoverableDatabaseId | Backup database to restore from | string |
| restorePointInTime | Snapshot time to restore | string |
| sourceDatabaseId | Source database to create from | string |
| status | Resource status | string |
| storageAccountType | The storage account type used to store backups for this sql pool. | "GRS" "LRS" "ZRS" |
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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for