Deploy SQL Server big data cluster with Azure Data Studio notebook

Applies to: SQL Server 2019 (15.x)


The Microsoft SQL Server 2019 Big Data Clusters add-on will be retired. Support for SQL Server 2019 Big Data Clusters will end on February 28, 2025. All existing users of SQL Server 2019 with Software Assurance will be fully supported on the platform and the software will continue to be maintained through SQL Server cumulative updates until that time. For more information, see the announcement blog post and Big data options on the Microsoft SQL Server platform.

SQL Server provides an extension for Azure Data Studio that includes deployment notebooks. A deployment notebook includes documentation and code that you can use in Azure Data Studio to create a SQL Server big data cluster.

Implemented initially as an open-source project, notebooks have been implemented into Azure Data Studio. You can use markdown for text in the text cells and one of the available kernels to write code in the code cells.

You can use notebooks to deploy SQL Server Big Data Clusters.


Following prerequisites are required to also launch the notebook:

In addition to above, deploying a big data cluster also requires:

Launch the notebook

  1. Launch Azure Data Studio.

  2. On the Connections tab, select the ellipses (...), then select Deploy SQL Server....

    Deploy SQL Server

  3. From the deployment options, select SQL Server Big Data Cluster.

  4. From the Deployment Target, under Options, select either New Azure Kubernetes Cluster or Existing Azure Kubernetes Service cluster.

  5. Accept the Privacy and license terms.

  6. This dialog also checks whether the required tools for the chosen type of SQL deployment exist on the host. The Select button isn't enabled until the tools check is successful.

  7. Select the Select button. This action launches the deployment experience.

Set deployment configuration template

You can customize the settings of the deployment profile by following the instructions below.

Target configuration template

Select the target configuration template from the available templates. The available profiles are filtered depending on the type of deployment target that's chosen in the previous dialog.

Deployment configuration template Step 1

Azure settings

If the deployment target is a new Azure Kubernetes Service (AKS), additional information such as Azure Subscription ID, resource group, AKS cluster name, VM count, size, and other additional information are required to create the AKS cluster.

Azure settings

If the deployment target is an existing Kubernetes cluster, the wizard prompts for the path to the kube config file to import the Kubernetes cluster settings. Ensure the appropriate cluster context is selected where the SQL Server 2019 Big Data Cluster can be deployed.

Target cluster context

Cluster, docker, and AD settings

  1. Enter the cluster name for the big data cluster, an admin username, and password. This same account is used for the controller and SQL Server.

    Cluster settings

  2. Enter the Docker settings as appropriate.


    Make sure image tag field is latest: 2019-CU13-ubuntu-20.04

    Docker settings

  3. If the AD authentication is available, enter the AD settings.

    Active Directory settings

Service settings

This screen has inputs for various settings such as Scale, Endpoints, Storage, and other Advanced storage settings. Enter the appropriate values and select Next.

Scale settings

Enter the number of instances of each of the components in the big data cluster.

A Spark Instance can be included along with HDFS. It's included in the storage pool or on its own in the Spark pool.

Service settings

For additional information on each of these components, you can refer to master instance, data pool, storage pool, or compute pool.

Endpoint settings

The default endpoints have been pre-filled. However, they can be changed as appropriate.

Endpoint settings

Storage settings

The storage settings include storage class and claim size for Data and Logs. The settings can be applied across Storage, Data, and SQL Server master pool.

Storage settings

Advanced storage settings

You can add additional storage settings under Advanced storage settings

  • Storage pool (HDFS)

  • Data pool

  • SQL Server Master

    Advanced storage settings


This screen summarizes all the input that was provided to deploy the big data cluster. The config files can be downloaded via the Save config files button. Select Script to Notebook to script out the entire deployment configuration to a notebook. Once the notebook is open, select Run Cells to start deploying the big data cluster to the selected target.


Next steps

For more information about deployment, see deployment guidance for SQL Server Big Data Clusters.