sql_pools

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

Overview

Name	sql_pools
Type	Resource
Id	azure.synapse_artifacts.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}. # pylint: disable=line-too-long
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	Snapshot time to restore.
sku	object	SQL pool SKU.
sourceDatabaseId	string	Source database to create from.
status	string	Resource status.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
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	Snapshot time to restore.
sku	object	SQL pool SKU.
sourceDatabaseId	string	Source database to create from.
status	string	Resource status.
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	sql_pool_name, endpoint		Get Sql Pool.
list	select	endpoint		List Sql Pools.

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
endpoint	string	The service endpoint host (no scheme). (default: )
sql_pool_name	string	The Sql Pool name. Required.

SELECT examples

get

Get Sql Pool.

SELECT
id,
name,
collation,
createMode,
creationDate,
location,
maxSizeBytes,
provisioningState,
recoverableDatabaseId,
restorePointInTime,
sku,
sourceDatabaseId,
status,
tags,
type
FROM azure.synapse_artifacts.sql_pools
WHERE sql_pool_name = '{{ sql_pool_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list

List Sql Pools.

SELECT
id,
name,
collation,
createMode,
creationDate,
location,
maxSizeBytes,
provisioningState,
recoverableDatabaseId,
restorePointInTime,
sku,
sourceDatabaseId,
status,
tags,
type
FROM azure.synapse_artifacts.sql_pools
WHERE endpoint = '{{ endpoint }}' -- required
;