sql_pools

Creates, updates, deletes, gets or lists a sql_pools resource.

Overview

Name	sql_pools
Type	Resource
Id	azure.synapse.sql_pools

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	SQL pool properties (title: SQL pool properties)
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

list_by_workspace

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	SQL pool properties (title: SQL pool properties)
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Get SQL pool properties
list_by_workspace	select	subscriptionId, resourceGroupName, workspaceName		List all SQL pools
create	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Create a SQL pool
update	update	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Apply a partial update to a SQL pool
delete	delete	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Delete a SQL pool
pause	exec	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Pause a SQL pool
resume	exec	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Resume a SQL pool

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resourceGroupName	string	The name of the resource group. The name is case insensitive.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Get SQL pool properties

SELECT
location,
properties,
sku,
tags
FROM azure.synapse.sql_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
;

list_by_workspace

List all SQL pools

SELECT
location,
properties,
sku,
tags
FROM azure.synapse.sql_pools
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

INSERT examples

create

Create a SQL pool

INSERT INTO azure.synapse.sql_pools (
data__tags,
data__location,
data__sku,
data__properties,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ sku }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}'
RETURNING
location,
properties,
sku,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sql_pools
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_pools resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_pools resource.
    - name: workspaceName
      value: string
      description: Required parameter for the sql_pools resource.
    - name: sqlPoolName
      value: string
      description: Required parameter for the sql_pools resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: sku
      value: object
      description: |
        The resource model definition representing SKU
    - name: properties
      value: object
      description: |
        SQL pool properties

UPDATE examples

update

Apply a partial update to a SQL pool

UPDATE azure.synapse.sql_pools
SET 
data__tags = '{{ tags }}',
data__location = '{{ location }}',
data__sku = '{{ sku }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND sqlPoolName = '{{ sqlPoolName }}' --required
RETURNING
location,
properties,
sku,
tags;

DELETE examples

delete

Delete a SQL pool

DELETE FROM azure.synapse.sql_pools
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
AND sqlPoolName = '{{ sqlPoolName }}' --required
;

Lifecycle Methods

pause

Pause a SQL pool

EXEC azure.synapse.sql_pools.pause 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@sqlPoolName='{{ sqlPoolName }}' --required
;

resume

Resume a SQL pool

EXEC azure.synapse.sql_pools.resume 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@sqlPoolName='{{ sqlPoolName }}' --required
;