sql_pools

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

Overview

Name	sql_pools
Type	Resource
Id	azure.synapse.sql_pools

Fields

vw_sql_pools

Name	Datatype	Description
collation	text	field from the properties object
create_mode	text	field from the properties object
creation_date	text	field from the properties object
location	text	The geo-location where the resource lives
max_size_bytes	text	field from the properties object
provisioning_state	text	field from the properties object
recoverable_database_id	text	field from the properties object
resourceGroupName	text	field from the properties object
restore_point_in_time	text	field from the properties object
sku	text	The resource model definition representing SKU
source_database_deletion_date	text	field from the properties object
source_database_id	text	field from the properties object
sqlPoolName	text	field from the properties object
status	text	field from the properties object
storage_account_type	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.
workspaceName	text	field from the properties object

sql_pools

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of a SQL Analytics pool
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Get SQL pool properties
list_by_workspace	SELECT	resourceGroupName, subscriptionId, workspaceName	List all SQL pools
create	INSERT	resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Create a SQL pool
delete	DELETE	resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Delete a SQL pool
update	UPDATE	resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Apply a partial update to a SQL pool
pause	EXEC	resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Pause a SQL pool
resume	EXEC	resourceGroupName, sqlPoolName, subscriptionId, workspaceName	Resume a SQL pool

SELECT examples

List all SQL pools

vw_sql_pools

SELECT
collation,
create_mode,
creation_date,
location,
max_size_bytes,
provisioning_state,
recoverable_database_id,
resourceGroupName,
restore_point_in_time,
sku,
source_database_deletion_date,
source_database_id,
sqlPoolName,
status,
storage_account_type,
subscriptionId,
tags,
workspaceName
FROM azure.synapse.vw_sql_pools
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

sql_pools

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

INSERT example

Use the following StackQL query and manifest file to create a new sql_pools resource.

All Properties

/*+ create */
INSERT INTO azure.synapse.sql_pools (
resourceGroupName,
sqlPoolName,
subscriptionId,
workspaceName,
tags,
location,
sku,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ sqlPoolName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ tags }}',
'{{ location }}',
'{{ sku }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: size
          value: string
        - name: family
          value: string
        - name: capacity
          value: integer
    - name: properties
      value:
        - name: maxSizeBytes
          value: integer
        - name: collation
          value: string
        - name: sourceDatabaseId
          value: string
        - name: recoverableDatabaseId
          value: string
        - name: provisioningState
          value: string
        - name: status
          value: string
        - name: restorePointInTime
          value: string
        - name: createMode
          value: string
        - name: creationDate
          value: string
        - name: storageAccountType
          value: string
        - name: sourceDatabaseDeletionDate
          value: string

UPDATE example

Updates a sql_pools resource.

/*+ update */
UPDATE azure.synapse.sql_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND sqlPoolName = '{{ sqlPoolName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified sql_pools resource.

/*+ delete */
DELETE FROM azure.synapse.sql_pools
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND sqlPoolName = '{{ sqlPoolName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';