Microsoft.Synapse workspaces/sqlPools 2020-04-01-preview

• Latest
• 2021-06-01
• 2021-06-01-preview
• 2021-05-01
• 2021-04-01-preview
• 2021-03-01
• 2020-12-01
• 2020-04-01-preview
• 2019-06-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' = {
  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

Usage Examples

Terraform Samples

A basic example of deploying Synapse SQL Pool.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

variable "sql_administrator_login" {
  type        = string
  description = "The SQL administrator login name for the Synapse workspace"
}

variable "sql_administrator_login_password" {
  type        = string
  description = "The SQL administrator login password for the Synapse workspace"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

data "azapi_resource_action" "listKeys" {
  type                   = "Microsoft.Storage/storageAccounts@2022-09-01"
  resource_id            = azapi_resource.storageAccount.id
  action                 = "listKeys"
  response_export_values = ["*"]
}

data "azapi_resource" "blobService" {
  type      = "Microsoft.Storage/storageAccounts/blobServices@2022-09-01"
  parent_id = azapi_resource.storageAccount.id
  name      = "default"
}

resource "azapi_resource" "container" {
  type      = "Microsoft.Storage/storageAccounts/blobServices/containers@2022-09-01"
  name      = var.resource_name
  parent_id = data.azapi_resource.blobService.id
  body = {
    properties = {
      metadata = {
        key = "value"
      }
    }
  }
  response_export_values = ["*"]
}

resource "azapi_resource" "workspace" {
  type      = "Microsoft.Synapse/workspaces@2021-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      defaultDataLakeStorage = {
        accountUrl = azapi_resource.storageAccount.output.properties.primaryEndpoints.dfs
        filesystem = azapi_resource.container.name
      }

      managedVirtualNetwork         = ""
      publicNetworkAccess           = "Enabled"
      sqlAdministratorLogin         = var.sql_administrator_login
      sqlAdministratorLoginPassword = var.sql_administrator_login_password
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlPool" {
  type      = "Microsoft.Synapse/workspaces/sqlPools@2021-06-01"
  parent_id = azapi_resource.workspace.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      createMode = "Default"
    }
    sku = {
      name = "DW100c"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}