sql_pool_restore_points

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

Overview

Name	sql_pool_restore_points
Type	Resource
Id	azure.synapse.sql_pool_restore_points

Fields

The following fields are returned by SELECT queries:

get

Successfully returned the restore point.

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.

list

Name	Datatype	Description
location	string	Resource location.
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, restorePointName		Gets a restore point.
list	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName		Get SQL pool backup information
create	insert	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, data__restorePointLabel		Creates a restore point for a data warehouse.
delete	delete	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, restorePointName		Deletes a restore point.

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.
restorePointName	string	The name of the restore point.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.

SELECT examples

get

Gets a restore point.

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

list

Get SQL pool backup information

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

INSERT examples

create

Creates a restore point for a data warehouse.

INSERT INTO azure.synapse.sql_pool_restore_points (
data__restorePointLabel,
subscriptionId,
resourceGroupName,
workspaceName,
sqlPoolName
)
SELECT 
'{{ restorePointLabel }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}',
'{{ sqlPoolName }}'
RETURNING
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: sql_pool_restore_points
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the sql_pool_restore_points resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sql_pool_restore_points resource.
    - name: workspaceName
      value: string
      description: Required parameter for the sql_pool_restore_points resource.
    - name: sqlPoolName
      value: string
      description: Required parameter for the sql_pool_restore_points resource.
    - name: restorePointLabel
      value: string
      description: |
        The restore point label to apply

DELETE examples

delete

Deletes a restore point.

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