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@2020-04-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
autoPauseTimer: int
autoResume: bool
maxServiceObjectiveName: 'string'
}
sku: {
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 | Resource properties. | SqlPoolProperties |
sku | The sql pool SKU. The list of SKUs may vary by region and support offer. | SkuV3 |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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 |
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 |
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": "2020-04-01-preview",
"name": "string",
"location": "string",
"properties": {
"autoPauseTimer": "int",
"autoResume": "bool",
"maxServiceObjectiveName": "string"
},
"sku": {
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Synapse/workspaces/sqlPools
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. | SqlPoolProperties |
sku | The sql pool SKU. The list of SKUs may vary by region and support offer. | SkuV3 |
tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
type | The resource type | 'Microsoft.Synapse/workspaces/sqlPools' |
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 |
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 |
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@2020-04-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
autoPauseTimer = int
autoResume = bool
maxServiceObjectiveName = "string"
}
sku = {
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 | Resource properties. | SqlPoolProperties |
sku | The sql pool SKU. The list of SKUs may vary by region and support offer. | SkuV3 |
tags | Resource tags | Dictionary of tag names and values. |
type | The resource type | "Microsoft.Synapse/workspaces/sqlPools@2020-04-01-preview" |
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 |
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 |
TrackedResourceTags
Name | Description | Value |
---|