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
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
collation	string	Collation mode.
createMode	string	Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified. Known values are: "Default", "PointInTimeRestore", "Recovery", and "Restore".
creationDate	string (date-time)	Date the SQL pool was created.
location	string	The geo-location where the resource lives. Required.
maxSizeBytes	integer	Maximum size in bytes.
provisioningState	string	Resource state.
recoverableDatabaseId	string	Backup database to restore from.
restorePointInTime	string (date-time)	Snapshot time to restore.
sku	object	SQL pool SKU.
sourceDatabaseDeletionDate	string (date-time)	Specifies the time that the sql pool was deleted.
sourceDatabaseId	string	Source database to create from.
status	string	Resource status.
storageAccountType	string	The storage account type used to store backups for this sql pool. Known values are: "GRS" and "LRS".
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_workspace

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
collation	string	Collation mode.
createMode	string	Specifies the mode of sql pool creation. Default: regular sql pool creation. PointInTimeRestore: Creates a sql pool by restoring a point in time backup of an existing sql pool. sourceDatabaseId must be specified as the resource ID of the existing sql pool, and restorePointInTime must be specified. Recovery: Creates a sql pool by a geo-replicated backup. sourceDatabaseId must be specified as the recoverableDatabaseId to restore. Restore: Creates a sql pool by restoring a backup of a deleted sql pool. SourceDatabaseId should be the sql pool's original resource ID. SourceDatabaseId and sourceDatabaseDeletionDate must be specified. Known values are: "Default", "PointInTimeRestore", "Recovery", and "Restore".
creationDate	string (date-time)	Date the SQL pool was created.
location	string	The geo-location where the resource lives. Required.
maxSizeBytes	integer	Maximum size in bytes.
provisioningState	string	Resource state.
recoverableDatabaseId	string	Backup database to restore from.
restorePointInTime	string (date-time)	Snapshot time to restore.
sku	object	SQL pool SKU.
sourceDatabaseDeletionDate	string (date-time)	Specifies the time that the sql pool was deleted.
sourceDatabaseId	string	Source database to create from.
status	string	Resource status.
storageAccountType	string	The storage account type used to store backups for this sql pool. Known values are: "GRS" and "LRS".
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, sql_pool_name, subscription_id		Get SQL pool. Get SQL pool properties.
list_by_workspace	select	resource_group_name, workspace_name, subscription_id		List SQL pools. List all SQL pools.
create	insert	resource_group_name, workspace_name, sql_pool_name, subscription_id, location		Create SQL pool. Create a SQL pool.
update	update	resource_group_name, workspace_name, sql_pool_name, subscription_id		Update SQL pool. Apply a partial update to a SQL pool.
delete	delete	resource_group_name, workspace_name, sql_pool_name, subscription_id		Delete SQL pool. Delete a SQL pool.
pause	exec	resource_group_name, workspace_name, sql_pool_name, subscription_id		Pause SQL pool. Pause a SQL pool.
resume	exec	resource_group_name, workspace_name, sql_pool_name, subscription_id		Resume SQL pool. Resume a SQL pool.
rename	exec	resource_group_name, workspace_name, sql_pool_name, subscription_id, id		Rename a SQL pool. Rename 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
sql_pool_name	string	SQL pool name. Required.
subscription_id	string
workspace_name	string	The name of the workspace. Required.

SELECT examples

get

Get SQL pool. Get SQL pool properties.

SELECT
id,
name,
collation,
createMode,
creationDate,
location,
maxSizeBytes,
provisioningState,
recoverableDatabaseId,
restorePointInTime,
sku,
sourceDatabaseDeletionDate,
sourceDatabaseId,
status,
storageAccountType,
tags,
type
FROM azure.synapse.sql_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND sql_pool_name = '{{ sql_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_workspace

List SQL pools. List all SQL pools.

SELECT
id,
name,
collation,
createMode,
creationDate,
location,
maxSizeBytes,
provisioningState,
recoverableDatabaseId,
restorePointInTime,
sku,
sourceDatabaseDeletionDate,
sourceDatabaseId,
status,
storageAccountType,
tags,
type
FROM azure.synapse.sql_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create SQL pool. Create a SQL pool.

INSERT INTO azure.synapse.sql_pools (
tags,
location,
sku,
properties,
resource_group_name,
workspace_name,
sql_pool_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ sku }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ sql_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: sql_pools
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sql_pools resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the sql_pools resource.
  - name: sql_pool_name
    value: "{{ sql_pool_name }}"
    description: Required parameter for the sql_pools resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sql_pools resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: sku
    description: |
      SQL pool SKU.
    value:
      tier: "{{ tier }}"
      name: "{{ name }}"
      capacity: {{ capacity }}
  - name: properties
    value:
      maxSizeBytes: {{ maxSizeBytes }}
      collation: "{{ collation }}"
      sourceDatabaseId: "{{ sourceDatabaseId }}"
      recoverableDatabaseId: "{{ recoverableDatabaseId }}"
      provisioningState: "{{ provisioningState }}"
      restorePointInTime: "{{ restorePointInTime }}"
      createMode: "{{ createMode }}"
      storageAccountType: "{{ storageAccountType }}"
      sourceDatabaseDeletionDate: "{{ sourceDatabaseDeletionDate }}"

UPDATE examples

update

Update SQL pool. Apply a partial update to a SQL pool.

UPDATE azure.synapse.sql_pools
SET 
tags = '{{ tags }}',
location = '{{ location }}',
sku = '{{ sku }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

Delete SQL pool. Delete a SQL pool.

DELETE FROM azure.synapse.sql_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND sql_pool_name = '{{ sql_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

pause

Pause SQL pool. Pause a SQL pool.

EXEC azure.synapse.sql_pools.pause 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@sql_pool_name='{{ sql_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

resume

Resume SQL pool. Resume a SQL pool.

EXEC azure.synapse.sql_pools.resume 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@sql_pool_name='{{ sql_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

rename

Rename a SQL pool. Rename a SQL pool.

EXEC azure.synapse.sql_pools.rename 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@sql_pool_name='{{ sql_pool_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"id": "{{ id }}"
}'
;