Quickstart: Create an Azure Synapse Analytics dedicated SQL pool (formerly SQL DW) by using an ARM template

  • Article

This Azure Resource Manager template (ARM template) will create an dedicated SQL pool (formerly SQL DW) with Transparent Data Encryption enabled. Dedicated SQL pool (formerly SQL DW) refers to the enterprise data warehousing features that are generally available in Azure Synapse.

An Azure Resource Manager template is a JavaScript Object Notation (JSON) file that defines the infrastructure and configuration for your project. The template uses declarative syntax. You describe your intended deployment without writing the sequence of programming commands to create the deployment.

If your environment meets the prerequisites and you're familiar with using ARM templates, select the Deploy to Azure button. The template will open in the Azure portal.

Button to deploy the Resource Manager template to Azure.

Prerequisites

If you don't have an Azure subscription, create a trial account before you begin.

Review the template

The template used in this quickstart is from Azure Quickstart Templates.

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "sqlServerName": {
      "type": "string",
      "defaultValue": "[concat('sql', uniqueString(resourceGroup().id))]",
      "metadata": {
        "description": "The SQL Logical Server name."
      }
    },
    "sqlAdministratorLogin": {
      "type": "string",
      "metadata": {
        "description": "The administrator username of the SQL Server."
      }
    },
    "sqlAdministratorPassword": {
      "type": "securestring",
      "metadata": {
        "description": "The administrator password of the SQL Server."
      }
    },
    "dataWarehouseName": {
      "type": "string",
      "metadata": {
        "description": "The name of the Data Warehouse."
      }
    },
    "transparentDataEncryption": {
      "type": "string",
      "defaultValue": "Enabled",
      "allowedValues": [
        "Enabled",
        "Disabled"
      ],
      "metadata": {
        "description": "Enable/Disable Transparent Data Encryption"
      }
    },
    "serviceLevelObjective": {
      "type": "string",
      "defaultValue": "DW400c",
      "metadata": {
        "description": "Performance Level"
      }
    },
    "location": {
      "type": "string",
      "defaultValue": "[resourceGroup().location]",
      "metadata": {
        "description": "Resource location"
      }
    }
  },
  "variables": {},
  "resources": [
    {
      "type": "Microsoft.Sql/servers",
      "apiVersion": "2020-02-02-preview",
      "name": "[parameters('sqlServerName')]",
      "location": "[parameters('location')]",
      "properties": {
        "administratorLogin": "[parameters('sqlAdministratorLogin')]",
        "administratorLoginPassword": "[parameters('sqlAdministratorPassword')]",
        "version": "12.0"
      },
      "resources": [
        {
          "type": "databases",
          "apiVersion": "2020-02-02-preview",
          "name": "[parameters('dataWarehouseName')]",
          "location": "[parameters('location')]",
          "kind": "v12.0,user,datawarehouse",
          "dependsOn": [
            "[parameters('sqlServerName')]"
          ],
          "properties": {
            "edition": "DataWarehouse",
            "status": "Online",
            "requestedServiceObjectiveName": "[parameters('serviceLevelObjective')]",
            "collation": "SQL_Latin1_General_CP1_CI_AS",
            "readScale": "Disabled",
            "zoneRedundant": false,
            "isUpgradeRequested": false
          },
          "resources": [
            {
              "comments": "Transparent Data Encryption",
              "type": "transparentDataEncryption",
              "apiVersion": "2017-03-01-preview",
              "name": "current",
              "dependsOn": [
                "[parameters('dataWarehouseName')]"
              ],
              "properties": {
                "status": "[parameters('transparentDataEncryption')]"
              }
            }
          ]
        }
      ]
    }
  ]
}

The template defines one resource:

Deploy the template

  1. Select the following image to sign in to Azure and open the template. This template creates a dedicated SQL pool (formerly SQL DW).

    Button to deploy the Resource Manager template to Azure.

  2. Enter or update the following values:

    • Subscription: Select an Azure subscription.
    • Resource group: Select Create new and enter a unique name for the resource group and select OK. A new resource group will facilitate resource clean up.
    • Region: Select a region. For example, China East 2.
    • SQL Server name: Accept the default name or enter a name for the SQL Server name.
    • SQL Administrator login: Enter the administrator username for the SQL Server.
    • SQL Administrator password: Enter the administrator password for the SQL Server.
    • Data Warehouse Name: Enter a dedicated SQL pool name.
    • Transparent Data Encryption: Accept the default, enabled.
    • Service Level Objective: Accept the default, DW400c.
    • Location: Accept the default location of the resource group.
    • Review and Create: Select.
    • Create: Select.

Review deployed resources

You can either use the Azure portal to check the deployed resources, or use Azure CLI or Azure PowerShell script to list the deployed resources.

echo "Enter the resource group where your dedicated SQL pool (formerly SQL DW) exists:" &&
read resourcegroupName &&
az resource list --resource-group $resourcegroupName

Clean up resources

When no longer needed, delete the resource group by using Azure CLI or Azure PowerShell:

echo "Enter the Resource Group name:" &&
read resourceGroupName &&
az group delete --name $resourceGroupName &&
echo "Press [ENTER] to continue ..."

Next steps

In this quickstart, you created a dedicated SQL pool (formerly SQL DW) using an ARM template and validated the deployment. To learn more about Azure Synapse Analytics and Azure Resource Manager, see the articles below.