Microsoft.Synapse workspaces/sqlPools 2020-04-01-preview
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@2020-04-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
tier: 'string'
}
parent: resourceSymbolicName
properties: {
autoPauseTimer: int
autoResume: bool
maxServiceObjectiveName: '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 | The sql pool SKU. The list of SKUs may vary by region and support offer. | SkuV3 |
| 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. | SqlPoolProperties |
SqlPoolProperties
| Name | Description | Value |
|---|---|---|
| autoPauseTimer | The period of inactivity in minutes before automatically pausing the sql pool. | int |
| autoResume | Indicates whether the sql pool can automatically resume when connection attempts are made. | bool |
| maxServiceObjectiveName | The max service level objective name of the sql pool. | string |
SkuV3
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU, typically, a letter + Number code, e.g. P3. | string (required) |
| tier | The tier or edition of the particular SKU, e.g. Basic, Premium. | 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": "2020-04-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string",
"tier": "string"
},
"properties": {
"autoPauseTimer": "int",
"autoResume": "bool",
"maxServiceObjectiveName": "string"
}
}
Property values
workspaces/sqlPools
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Synapse/workspaces/sqlPools' |
| 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) 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 | The sql pool SKU. The list of SKUs may vary by region and support offer. | SkuV3 |
| properties | Resource properties. | SqlPoolProperties |
SqlPoolProperties
| Name | Description | Value |
|---|---|---|
| autoPauseTimer | The period of inactivity in minutes before automatically pausing the sql pool. | int |
| autoResume | Indicates whether the sql pool can automatically resume when connection attempts are made. | bool |
| maxServiceObjectiveName | The max service level objective name of the sql pool. | string |
SkuV3
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU, typically, a letter + Number code, e.g. P3. | string (required) |
| tier | The tier or edition of the particular SKU, e.g. Basic, Premium. | 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@2020-04-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
autoPauseTimer = int
autoResume = bool
maxServiceObjectiveName = "string"
}
sku = {
name = "string"
tier = "string"
}
})
}
Property values
workspaces/sqlPools
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Synapse/workspaces/sqlPools@2020-04-01-preview" |
| 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 | The sql pool SKU. The list of SKUs may vary by region and support offer. | SkuV3 |
| properties | Resource properties. | SqlPoolProperties |
SqlPoolProperties
| Name | Description | Value |
|---|---|---|
| autoPauseTimer | The period of inactivity in minutes before automatically pausing the sql pool. | int |
| autoResume | Indicates whether the sql pool can automatically resume when connection attempts are made. | bool |
| maxServiceObjectiveName | The max service level objective name of the sql pool. | string |
SkuV3
| Name | Description | Value |
|---|---|---|
| name | The name of the SKU, typically, a letter + Number code, e.g. P3. | string (required) |
| tier | The tier or edition of the particular SKU, e.g. Basic, Premium. | 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