restore_point_collections

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

Overview

Name	restore_point_collections
Type	Resource
Id	azure.compute.restore_point_collections

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	The restore point collection properties.
tags	object	Resource tags
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	The restore point collection properties.
tags	object	Resource tags
type	string	Resource type

list_all

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	The restore point collection properties.
tags	object	Resource tags
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, restorePointCollectionName	$expand	The operation to get the restore point collection.
list	select	subscriptionId, resourceGroupName		Gets the list of restore point collections in a resource group.
list_all	select	subscriptionId		Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.
create_or_update	insert	subscriptionId, resourceGroupName, restorePointCollectionName		The operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.
update	update	subscriptionId, resourceGroupName, restorePointCollectionName		The operation to update the restore point collection.
delete	delete	subscriptionId, resourceGroupName, restorePointCollectionName		The operation to delete the restore point collection. This operation will also delete all the contained restore points.

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.
restorePointCollectionName	string	The name of the Restore Point Collection.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$expand	string	The expand expression to apply on the operation. If expand=restorePoints, server will return all contained restore points in the restorePointCollection.

SELECT examples

get

The operation to get the restore point collection.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.restore_point_collections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND restorePointCollectionName = '{{ restorePointCollectionName }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets the list of restore point collections in a resource group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.restore_point_collections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_all

Gets the list of restore point collections in the subscription. Use nextLink property in the response to get the next page of restore point collections. Do this till nextLink is not null to fetch all the restore point collections.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.compute.restore_point_collections
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

The operation to create or update the restore point collection. Please refer to https://aka.ms/RestorePoints for more details. When updating a restore point collection, only tags may be modified.

INSERT INTO azure.compute.restore_point_collections (
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName,
restorePointCollectionName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ restorePointCollectionName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: restore_point_collections
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the restore_point_collections resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the restore_point_collections resource.
    - name: restorePointCollectionName
      value: string
      description: Required parameter for the restore_point_collections resource.
    - name: properties
      value: object
      description: |
        The restore point collection properties.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags

UPDATE examples

update

The operation to update the restore point collection.

UPDATE azure.compute.restore_point_collections
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND restorePointCollectionName = '{{ restorePointCollectionName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

The operation to delete the restore point collection. This operation will also delete all the contained restore points.

DELETE FROM azure.compute.restore_point_collections
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND restorePointCollectionName = '{{ restorePointCollectionName }}' --required
;