Overview

The SQL Pools API provides operations for managing dedicated SQL pools in Azure Synapse Analytics. Use this reference to create, update, delete, and query SQL pool resources.

  • Endpoint: https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}
  • Supported API versions: 2021-06-01
  • Authentication: Azure AD Bearer token

Methods

GET /sqlPools

List all SQL pools in a workspace.

{
  "value": [
    {
      "name": "mySqlPool",
      "type": "Microsoft.Synapse/workspaces/sqlPools",
      "location": "eastus",
      "properties": {
        "status": "Online",
        "sku": {
          "name": "DW100c"
        }
      }
    }
  ]
}

PUT /sqlPools/{sqlPoolName}

Create or update a SQL pool.

{
  "location": "eastus",
  "sku": {
    "name": "DW200c"
  },
  "properties": {
    "createMode": "Default"
  }
}

PATCH /sqlPools/{sqlPoolName}

Update specific properties of a SQL pool.

{
  "sku": {
    "name": "DW300c"
  }
}

DELETE /sqlPools/{sqlPoolName}

Delete a SQL pool.

Parameters

NameInTypeRequiredDescription
subscriptionIdpathstringYesAzure subscription identifier.
resourceGroupNamepathstringYesName of the resource group.
workspaceNamepathstringYesSynapse workspace name.
sqlPoolNamepathstringNo for list, Yes for specific actionsName of the SQL pool.
api-versionquerystringYesAPI version, e.g., 2021-06-01.

Responses

200 OK

Successful GET request.

{
  "name": "mySqlPool",
  "type": "Microsoft.Synapse/workspaces/sqlPools",
  "location": "eastus",
  "properties": {
    "status": "Online",
    "sku": {
      "name": "DW100c"
    }
  }
}

201 Created

Successful creation of a SQL pool.

202 Accepted

Delete operation accepted; provisioning state asynchronous.

400 Bad Request

Invalid request parameters.

Examples

PowerShell - Create a SQL pool

AzSynapseSqlPool -ResourceGroupName "myRg" -WorkspaceName "myWs" `
  -Name "myNewPool" -PerformanceLevel "DW300c" -Location "eastus"

Azure CLI - List SQL pools

az synapse sql pool list --workspace-name myWs --resource-group myRg