disk_restore_points

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

Overview

Name	disk_restore_points
Type	Resource
Id	azure.compute.disk_restore_points

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
properties	object	Properties of an incremental disk restore point
type	string	Resource type

list_by_restore_point

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
properties	object	Properties of an incremental disk restore point
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, vmRestorePointName, diskRestorePointName		Get disk restorePoint resource
list_by_restore_point	select	subscriptionId, resourceGroupName, restorePointCollectionName, vmRestorePointName		Lists diskRestorePoints under a vmRestorePoint.
grant_access	exec	subscriptionId, resourceGroupName, restorePointCollectionName, vmRestorePointName, diskRestorePointName, access, durationInSeconds		Grants access to a diskRestorePoint.
revoke_access	exec	subscriptionId, resourceGroupName, restorePointCollectionName, vmRestorePointName, diskRestorePointName		Revokes access to a diskRestorePoint.

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
diskRestorePointName	string	The name of the disk restore point created.
resourceGroupName	string	The name of the resource group.
restorePointCollectionName	string	The name of the restore point collection that the disk restore point belongs.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
vmRestorePointName	string	The name of the vm restore point that the disk disk restore point belongs.

SELECT examples

get

Get disk restorePoint resource

SELECT
id,
name,
properties,
type
FROM azure.compute.disk_restore_points
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND restorePointCollectionName = '{{ restorePointCollectionName }}' -- required
AND vmRestorePointName = '{{ vmRestorePointName }}' -- required
AND diskRestorePointName = '{{ diskRestorePointName }}' -- required
;

list_by_restore_point

Lists diskRestorePoints under a vmRestorePoint.

SELECT
id,
name,
properties,
type
FROM azure.compute.disk_restore_points
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND restorePointCollectionName = '{{ restorePointCollectionName }}' -- required
AND vmRestorePointName = '{{ vmRestorePointName }}' -- required
;

Lifecycle Methods

grant_access

Grants access to a diskRestorePoint.

EXEC azure.compute.disk_restore_points.grant_access 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@restorePointCollectionName='{{ restorePointCollectionName }}' --required, 
@vmRestorePointName='{{ vmRestorePointName }}' --required, 
@diskRestorePointName='{{ diskRestorePointName }}' --required 
@@json=
'{
"access": "{{ access }}", 
"durationInSeconds": {{ durationInSeconds }}, 
"getSecureVMGuestStateSAS": {{ getSecureVMGuestStateSAS }}, 
"fileFormat": "{{ fileFormat }}"
}'
;

revoke_access

Revokes access to a diskRestorePoint.

EXEC azure.compute.disk_restore_points.revoke_access 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@restorePointCollectionName='{{ restorePointCollectionName }}' --required, 
@vmRestorePointName='{{ vmRestorePointName }}' --required, 
@diskRestorePointName='{{ diskRestorePointName }}' --required
;