disk_restore_point

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

Overview

Name	disk_restore_point
Type	Resource
Id	azure.compute.disk_restore_point

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.
completionPercent	number	Percentage complete for the background copy of disk restore point when source resource is from a different region.
diskAccessId	string	ARM id of the DiskAccess resource for using private endpoints on disks.
encryption	object	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
familyId	string	id of the backing snapshot's MIS family.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2". (V1, V2)
logicalSectorSize	integer	Logical sector size in bytes for disk restore points of UltraSSD_LRS and PremiumV2_LRS disks. Supported values are 512 and 4096. 4096 is the default.
networkAccessPolicy	string	Policy for accessing the disk via network. Known values are: "AllowAll", "AllowPrivate", and "DenyAll". (AllowAll, AllowPrivate, DenyAll)
osType	string	The Operating System type. Known values are: "Windows" and "Linux". (Windows, Linux)
publicNetworkAccess	string	Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
purchasePlan	object	Purchase plan information for the the image from which the OS disk was created.
replicationState	string	Replication state of disk restore point when source resource is from a different region.
securityProfile	object	Contains the security related information for the resource.
sourceResourceId	string	arm id of source disk or source disk restore point.
sourceResourceLocation	string	Location of source disk or source disk restore point when source resource is from a different region.
sourceUniqueId	string	unique incarnation id of the source disk.
supportedCapabilities	object	List of supported capabilities for the image from which the OS disk was created.
supportsHibernation	boolean	Indicates the OS on a disk supports hibernation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated	string (date-time)	The timestamp of restorePoint creation.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_restore_point

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.
completionPercent	number	Percentage complete for the background copy of disk restore point when source resource is from a different region.
diskAccessId	string	ARM id of the DiskAccess resource for using private endpoints on disks.
encryption	object	Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
familyId	string	id of the backing snapshot's MIS family.
hyperVGeneration	string	The hypervisor generation of the Virtual Machine. Applicable to OS disks only. Known values are: "V1" and "V2". (V1, V2)
logicalSectorSize	integer	Logical sector size in bytes for disk restore points of UltraSSD_LRS and PremiumV2_LRS disks. Supported values are 512 and 4096. 4096 is the default.
networkAccessPolicy	string	Policy for accessing the disk via network. Known values are: "AllowAll", "AllowPrivate", and "DenyAll". (AllowAll, AllowPrivate, DenyAll)
osType	string	The Operating System type. Known values are: "Windows" and "Linux". (Windows, Linux)
publicNetworkAccess	string	Policy for controlling export on the disk. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
purchasePlan	object	Purchase plan information for the the image from which the OS disk was created.
replicationState	string	Replication state of disk restore point when source resource is from a different region.
securityProfile	object	Contains the security related information for the resource.
sourceResourceId	string	arm id of source disk or source disk restore point.
sourceResourceLocation	string	Location of source disk or source disk restore point when source resource is from a different region.
sourceUniqueId	string	unique incarnation id of the source disk.
supportedCapabilities	object	List of supported capabilities for the image from which the OS disk was created.
supportsHibernation	boolean	Indicates the OS on a disk supports hibernation.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated	string (date-time)	The timestamp of restorePoint creation.
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, restore_point_collection_name, vm_restore_point_name, disk_restore_point_name, subscription_id		Get disk restorePoint resource.
list_by_restore_point	select	resource_group_name, restore_point_collection_name, vm_restore_point_name, subscription_id		Lists diskRestorePoints under a vmRestorePoint.
grant_access	exec	resource_group_name, restore_point_collection_name, vm_restore_point_name, disk_restore_point_name, subscription_id, access, durationInSeconds		Grants access to a diskRestorePoint.
revoke_access	exec	resource_group_name, restore_point_collection_name, vm_restore_point_name, disk_restore_point_name, subscription_id		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
disk_restore_point_name	string	The name of the DiskRestorePoint. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
restore_point_collection_name	string	The name of the restore point collection that the disk restore point belongs. Required.
subscription_id	string
vm_restore_point_name	string	The name of the vm restore point that the disk disk restore point belongs. Required.

SELECT examples

get

Get disk restorePoint resource.

SELECT
id,
name,
completionPercent,
diskAccessId,
encryption,
familyId,
hyperVGeneration,
logicalSectorSize,
networkAccessPolicy,
osType,
publicNetworkAccess,
purchasePlan,
replicationState,
securityProfile,
sourceResourceId,
sourceResourceLocation,
sourceUniqueId,
supportedCapabilities,
supportsHibernation,
systemData,
timeCreated,
type
FROM azure.compute.disk_restore_point
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND restore_point_collection_name = '{{ restore_point_collection_name }}' -- required
AND vm_restore_point_name = '{{ vm_restore_point_name }}' -- required
AND disk_restore_point_name = '{{ disk_restore_point_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_restore_point

Lists diskRestorePoints under a vmRestorePoint.

SELECT
id,
name,
completionPercent,
diskAccessId,
encryption,
familyId,
hyperVGeneration,
logicalSectorSize,
networkAccessPolicy,
osType,
publicNetworkAccess,
purchasePlan,
replicationState,
securityProfile,
sourceResourceId,
sourceResourceLocation,
sourceUniqueId,
supportedCapabilities,
supportsHibernation,
systemData,
timeCreated,
type
FROM azure.compute.disk_restore_point
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND restore_point_collection_name = '{{ restore_point_collection_name }}' -- required
AND vm_restore_point_name = '{{ vm_restore_point_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

grant_access

Grants access to a diskRestorePoint.

EXEC azure.compute.disk_restore_point.grant_access 
@resource_group_name='{{ resource_group_name }}' --required, 
@restore_point_collection_name='{{ restore_point_collection_name }}' --required, 
@vm_restore_point_name='{{ vm_restore_point_name }}' --required, 
@disk_restore_point_name='{{ disk_restore_point_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"access": "{{ access }}", 
"durationInSeconds": {{ durationInSeconds }}, 
"getSecureVMGuestStateSAS": {{ getSecureVMGuestStateSAS }}, 
"fileFormat": "{{ fileFormat }}"
}'
;

revoke_access

Revokes access to a diskRestorePoint.

EXEC azure.compute.disk_restore_point.revoke_access 
@resource_group_name='{{ resource_group_name }}' --required, 
@restore_point_collection_name='{{ restore_point_collection_name }}' --required, 
@vm_restore_point_name='{{ vm_restore_point_name }}' --required, 
@disk_restore_point_name='{{ disk_restore_point_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;