restore_points

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

Overview

Name	restore_points
Type	Resource
Id	azure.compute.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.
consistencyMode	string	ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints _ for more details. Known values are: "CrashConsistent", "FileSystemConsistent", and "ApplicationConsistent". (CrashConsistent, FileSystemConsistent, ApplicationConsistent)
excludeDisks	array	List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included.
instanceView	object	The restore point instance view.
instantAccessDurationMinutes	integer	This property determines the time in minutes the snapshot is retained as instant access for restoring Premium SSD v2 or Ultra disk with fast restore performance in this restore point.
provisioningState	string	Gets the provisioning state of the restore point.
sourceMetadata	object	Gets the details of the VM captured at the time of the restore point creation.
sourceRestorePoint	object	The API entity reference.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
timeCreated	string (date-time)	Gets the creation time of the restore point.
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, restore_point_name, subscription_id	$expand	The operation to get the restore point.
create	insert	resource_group_name, restore_point_collection_name, restore_point_name, subscription_id		The operation to create the restore point. Updating properties of an existing restore point is not allowed.
delete	delete	resource_group_name, restore_point_collection_name, restore_point_name, subscription_id		The operation to delete the 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
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. Required.
restore_point_name	string	The name of the restore point. Required.
subscription_id	string
$expand	string	The expand expression to apply on the operation. 'InstanceView' retrieves information about the run-time state of a restore point. "instanceView" Default value is None.

SELECT examples

get

The operation to get the restore point.

SELECT
id,
name,
consistencyMode,
excludeDisks,
instanceView,
instantAccessDurationMinutes,
provisioningState,
sourceMetadata,
sourceRestorePoint,
systemData,
timeCreated,
type
FROM azure.compute.restore_points
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND restore_point_collection_name = '{{ restore_point_collection_name }}' -- required
AND restore_point_name = '{{ restore_point_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create

The operation to create the restore point. Updating properties of an existing restore point is not allowed.

INSERT INTO azure.compute.restore_points (
properties,
resource_group_name,
restore_point_collection_name,
restore_point_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ restore_point_collection_name }}',
'{{ restore_point_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
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: restore_point_collection_name
    value: "{{ restore_point_collection_name }}"
    description: Required parameter for the restore_points resource.
  - name: restore_point_name
    value: "{{ restore_point_name }}"
    description: Required parameter for the restore_points resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the restore_points resource.
  - name: properties
    description: |
      The restore point properties.
    value:
      excludeDisks:
        - id: "{{ id }}"
      sourceMetadata:
        hardwareProfile:
          vmSize: "{{ vmSize }}"
          vmSizeProperties:
            vCPUsAvailable: {{ vCPUsAvailable }}
            vCPUsPerCore: {{ vCPUsPerCore }}
        storageProfile:
          osDisk:
            osType: "{{ osType }}"
            encryptionSettings:
              diskEncryptionKey: "{{ diskEncryptionKey }}"
              keyEncryptionKey: "{{ keyEncryptionKey }}"
              enabled: {{ enabled }}
            name: "{{ name }}"
            caching: "{{ caching }}"
            diskSizeGB: {{ diskSizeGB }}
            managedDisk:
              id: "{{ id }}"
              storageAccountType: "{{ storageAccountType }}"
              diskEncryptionSet: "{{ diskEncryptionSet }}"
              securityProfile: "{{ securityProfile }}"
            diskRestorePoint:
              id: "{{ id }}"
              encryption: "{{ encryption }}"
              sourceDiskRestorePoint: "{{ sourceDiskRestorePoint }}"
            writeAcceleratorEnabled: {{ writeAcceleratorEnabled }}
          dataDisks:
            - lun: {{ lun }}
              name: "{{ name }}"
              caching: "{{ caching }}"
              diskSizeGB: {{ diskSizeGB }}
              managedDisk:
                id: "{{ id }}"
                storageAccountType: "{{ storageAccountType }}"
                diskEncryptionSet: "{{ diskEncryptionSet }}"
                securityProfile: "{{ securityProfile }}"
              diskRestorePoint:
                id: "{{ id }}"
                encryption: "{{ encryption }}"
                sourceDiskRestorePoint: "{{ sourceDiskRestorePoint }}"
              writeAcceleratorEnabled: {{ writeAcceleratorEnabled }}
          diskControllerType: "{{ diskControllerType }}"
        osProfile:
          computerName: "{{ computerName }}"
          adminUsername: "{{ adminUsername }}"
          adminPassword: "{{ adminPassword }}"
          customData: "{{ customData }}"
          windowsConfiguration:
            provisionVMAgent: {{ provisionVMAgent }}
            enableAutomaticUpdates: {{ enableAutomaticUpdates }}
            timeZone: "{{ timeZone }}"
            additionalUnattendContent:
              - passName: "{{ passName }}"
                componentName: "{{ componentName }}"
                settingName: "{{ settingName }}"
                content: "{{ content }}"
            patchSettings:
              patchMode: "{{ patchMode }}"
              enableHotpatching: {{ enableHotpatching }}
              assessmentMode: "{{ assessmentMode }}"
              automaticByPlatformSettings: "{{ automaticByPlatformSettings }}"
            winRM:
              listeners: "{{ listeners }}"
            enableVMAgentPlatformUpdates: {{ enableVMAgentPlatformUpdates }}
          linuxConfiguration:
            disablePasswordAuthentication: {{ disablePasswordAuthentication }}
            ssh:
              publicKeys: "{{ publicKeys }}"
            provisionVMAgent: {{ provisionVMAgent }}
            patchSettings:
              patchMode: "{{ patchMode }}"
              assessmentMode: "{{ assessmentMode }}"
              automaticByPlatformSettings: "{{ automaticByPlatformSettings }}"
            enableVMAgentPlatformUpdates: {{ enableVMAgentPlatformUpdates }}
          secrets:
            - sourceVault:
                id: "{{ id }}"
              vaultCertificates: "{{ vaultCertificates }}"
          allowExtensionOperations: {{ allowExtensionOperations }}
          requireGuestProvisionSignal: {{ requireGuestProvisionSignal }}
        diagnosticsProfile:
          bootDiagnostics:
            enabled: {{ enabled }}
            storageUri: "{{ storageUri }}"
        licenseType: "{{ licenseType }}"
        vmId: "{{ vmId }}"
        securityProfile:
          uefiSettings:
            secureBootEnabled: {{ secureBootEnabled }}
            vTpmEnabled: {{ vTpmEnabled }}
          encryptionAtHost: {{ encryptionAtHost }}
          securityType: "{{ securityType }}"
          encryptionIdentity:
            userAssignedIdentityResourceId: "{{ userAssignedIdentityResourceId }}"
          proxyAgentSettings:
            enabled: {{ enabled }}
            mode: "{{ mode }}"
            keyIncarnationId: {{ keyIncarnationId }}
            wireServer:
              mode: "{{ mode }}"
              inVMAccessControlProfileReferenceId: "{{ inVMAccessControlProfileReferenceId }}"
            imds:
              mode: "{{ mode }}"
              inVMAccessControlProfileReferenceId: "{{ inVMAccessControlProfileReferenceId }}"
            addProxyAgentExtension: {{ addProxyAgentExtension }}
        location: "{{ location }}"
        userData: "{{ userData }}"
        hyperVGeneration: "{{ hyperVGeneration }}"
      provisioningState: "{{ provisioningState }}"
      consistencyMode: "{{ consistencyMode }}"
      timeCreated: "{{ timeCreated }}"
      sourceRestorePoint:
        id: "{{ id }}"
      instanceView:
        diskRestorePoints:
          - id: "{{ id }}"
            snapshotAccessState: "{{ snapshotAccessState }}"
            replicationStatus:
              status:
                code: "{{ code }}"
                level: "{{ level }}"
                displayStatus: "{{ displayStatus }}"
                message: "{{ message }}"
                time: "{{ time }}"
              completionPercent: {{ completionPercent }}
        statuses:
          - code: "{{ code }}"
            level: "{{ level }}"
            displayStatus: "{{ displayStatus }}"
            message: "{{ message }}"
            time: "{{ time }}"
      instantAccessDurationMinutes: {{ instantAccessDurationMinutes }}

DELETE examples

delete

The operation to delete the restore point.

DELETE FROM azure.compute.restore_points
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND restore_point_collection_name = '{{ restore_point_collection_name }}' --required
AND restore_point_name = '{{ restore_point_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;