restore_points

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

Overview

Name	restore_points
Type	Resource
Id	azure.sql.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_by_database

Successfully returned restore points.

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	resourceGroupName, serverName, databaseName, restorePointName, subscriptionId		Gets a restore point.
list_by_database	select	resourceGroupName, serverName, databaseName, subscriptionId		Gets a list of database restore points.
create	insert	resourceGroupName, serverName, databaseName, subscriptionId, data__restorePointLabel		Creates a restore point for a data warehouse.
delete	delete	resourceGroupName, serverName, databaseName, restorePointName, subscriptionId		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
databaseName	string	The name of the database.
resourceGroupName	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
restorePointName	string	The name of the restore point.
serverName	string	The name of the server.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Gets a restore point.

SELECT
location,
properties
FROM azure.sql.restore_points
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND restorePointName = '{{ restorePointName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_database

Gets a list of database restore points.

SELECT
location,
properties
FROM azure.sql.restore_points
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates a restore point for a data warehouse.

INSERT INTO azure.sql.restore_points (
data__restorePointLabel,
resourceGroupName,
serverName,
databaseName,
subscriptionId
)
SELECT 
'{{ restorePointLabel }}' /* required */,
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties
;

Manifest

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

DELETE examples

delete

Deletes a restore point.

DELETE FROM azure.sql.restore_points
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
AND restorePointName = '{{ restorePointName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;