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

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.
earliestRestoreDate	string (date-time)	The earliest time to which this database can be restored.
location	string	Resource location.
restorePointCreationDate	string (date-time)	The time the backup was taken.
restorePointLabel	string	The label of restore point for backup request by user.
restorePointType	string	The type of restore point. Known values are: "CONTINUOUS" and "DISCRETE". (CONTINUOUS, DISCRETE)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_database

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.
earliestRestoreDate	string (date-time)	The earliest time to which this database can be restored.
location	string	Resource location.
restorePointCreationDate	string (date-time)	The time the backup was taken.
restorePointLabel	string	The label of restore point for backup request by user.
restorePointType	string	The type of restore point. Known values are: "CONTINUOUS" and "DISCRETE". (CONTINUOUS, DISCRETE)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, server_name, database_name, restore_point_name, subscription_id		Gets a restore point.
list_by_database	select	resource_group_name, server_name, database_name, subscription_id		Gets a list of database restore points.
create	insert	resource_group_name, server_name, database_name, subscription_id, restorePointLabel		Creates a restore point for a data warehouse.
delete	delete	resource_group_name, server_name, database_name, restore_point_name, subscription_id		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
database_name	string	The name of the database. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
restore_point_name	string	The name of the restore point. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets a restore point.

SELECT
id,
name,
earliestRestoreDate,
location,
restorePointCreationDate,
restorePointLabel,
restorePointType,
systemData,
type
FROM azure.sql.restore_points
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND restore_point_name = '{{ restore_point_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_database

Gets a list of database restore points.

SELECT
id,
name,
earliestRestoreDate,
location,
restorePointCreationDate,
restorePointLabel,
restorePointType,
systemData,
type
FROM azure.sql.restore_points
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a restore point for a data warehouse.

INSERT INTO azure.sql.restore_points (
restorePointLabel,
resource_group_name,
server_name,
database_name,
subscription_id
)
SELECT 
'{{ restorePointLabel }}' /* required */,
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: restore_points
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the restore_points resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the restore_points resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the restore_points resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the restore_points resource.
  - name: restorePointLabel
    value: "{{ restorePointLabel }}"
    description: |
      The restore point label to apply. Required.

DELETE examples

delete

Deletes a restore point.

DELETE FROM azure.sql.restore_points
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND restore_point_name = '{{ restore_point_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;