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	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
instantAccess	boolean	This property determines whether instant access snapshot is enabled for restore points created under this restore point collection for Premium SSD v2 or Ultra disk. Instant access snapshot for Premium SSD v2 or Ultra disk is instantaneously available for restoring disk with fast restore performance.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the restore point collection.
restorePointCollectionId	string	The unique id of the restore point collection.
restorePoints	array	A list containing all restore points created under this restore point collection.
source	object	The properties of the source resource that this restore point collection is created from.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

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.
instantAccess	boolean	This property determines whether instant access snapshot is enabled for restore points created under this restore point collection for Premium SSD v2 or Ultra disk. Instant access snapshot for Premium SSD v2 or Ultra disk is instantaneously available for restoring disk with fast restore performance.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the restore point collection.
restorePointCollectionId	string	The unique id of the restore point collection.
restorePoints	array	A list containing all restore points created under this restore point collection.
source	object	The properties of the source resource that this restore point collection is created from.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_all

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.
instantAccess	boolean	This property determines whether instant access snapshot is enabled for restore points created under this restore point collection for Premium SSD v2 or Ultra disk. Instant access snapshot for Premium SSD v2 or Ultra disk is instantaneously available for restoring disk with fast restore performance.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioning state of the restore point collection.
restorePointCollectionId	string	The unique id of the restore point collection.
restorePoints	array	A list containing all restore points created under this restore point collection.
source	object	The properties of the source resource that this restore point collection is created from.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, subscription_id	$expand	The operation to get the restore point collection.
list	select	resource_group_name, subscription_id		Gets the list of restore point collections in a resource group.
list_all	select	subscription_id		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	resource_group_name, restore_point_collection_name, subscription_id, location		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	resource_group_name, restore_point_collection_name, subscription_id		The operation to update the restore point collection.
create_or_update	replace	resource_group_name, restore_point_collection_name, subscription_id, location		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.
delete	delete	resource_group_name, restore_point_collection_name, subscription_id		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
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.
subscription_id	string
$expand	string	The expand expression to apply on the operation. If expand=restorePoints, server will return all contained restore points in the restorePointCollection. "restorePoints" Default value is None.

SELECT examples

get

The operation to get the restore point collection.

SELECT
id,
name,
instantAccess,
location,
provisioningState,
restorePointCollectionId,
restorePoints,
source,
systemData,
tags,
type
FROM azure.compute.restore_point_collections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND restore_point_collection_name = '{{ restore_point_collection_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

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

SELECT
id,
name,
instantAccess,
location,
provisioningState,
restorePointCollectionId,
restorePoints,
source,
systemData,
tags,
type
FROM azure.compute.restore_point_collections
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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,
instantAccess,
location,
provisioningState,
restorePointCollectionId,
restorePoints,
source,
systemData,
tags,
type
FROM azure.compute.restore_point_collections
WHERE subscription_id = '{{ subscription_id }}' -- 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 (
tags,
location,
properties,
resource_group_name,
restore_point_collection_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ restore_point_collection_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: restore_point_collections
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the restore_point_collections resource.
  - name: restore_point_collection_name
    value: "{{ restore_point_collection_name }}"
    description: Required parameter for the restore_point_collections resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the restore_point_collections resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The restore point collection properties.
    value:
      source:
        location: "{{ location }}"
        id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      restorePointCollectionId: "{{ restorePointCollectionId }}"
      restorePoints:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            excludeDisks:
              - id: "{{ id }}"
            sourceMetadata:
              hardwareProfile:
                vmSize: "{{ vmSize }}"
                vmSizeProperties: "{{ vmSizeProperties }}"
              storageProfile:
                osDisk: "{{ osDisk }}"
                dataDisks: "{{ dataDisks }}"
                diskControllerType: "{{ diskControllerType }}"
              osProfile:
                computerName: "{{ computerName }}"
                adminUsername: "{{ adminUsername }}"
                adminPassword: "{{ adminPassword }}"
                customData: "{{ customData }}"
                windowsConfiguration: "{{ windowsConfiguration }}"
                linuxConfiguration: "{{ linuxConfiguration }}"
                secrets: "{{ secrets }}"
                allowExtensionOperations: {{ allowExtensionOperations }}
                requireGuestProvisionSignal: {{ requireGuestProvisionSignal }}
              diagnosticsProfile:
                bootDiagnostics: "{{ bootDiagnostics }}"
              licenseType: "{{ licenseType }}"
              vmId: "{{ vmId }}"
              securityProfile:
                uefiSettings: "{{ uefiSettings }}"
                encryptionAtHost: {{ encryptionAtHost }}
                securityType: "{{ securityType }}"
                encryptionIdentity: "{{ encryptionIdentity }}"
                proxyAgentSettings: "{{ proxyAgentSettings }}"
              location: "{{ location }}"
              userData: "{{ userData }}"
              hyperVGeneration: "{{ hyperVGeneration }}"
            provisioningState: "{{ provisioningState }}"
            consistencyMode: "{{ consistencyMode }}"
            timeCreated: "{{ timeCreated }}"
            sourceRestorePoint:
              id: "{{ id }}"
            instanceView:
              diskRestorePoints:
                - id: "{{ id }}"
                  snapshotAccessState: "{{ snapshotAccessState }}"
                  replicationStatus:
                    status: "{{ status }}"
                    completionPercent: {{ completionPercent }}
              statuses:
                - code: "{{ code }}"
                  level: "{{ level }}"
                  displayStatus: "{{ displayStatus }}"
                  message: "{{ message }}"
                  time: "{{ time }}"
            instantAccessDurationMinutes: {{ instantAccessDurationMinutes }}
      instantAccess: {{ instantAccess }}

UPDATE examples

update

The operation to update the restore point collection.

UPDATE azure.compute.restore_point_collections
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND restore_point_collection_name = '{{ restore_point_collection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE 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.

REPLACE azure.compute.restore_point_collections
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND restore_point_collection_name = '{{ restore_point_collection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
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 resource_group_name = '{{ resource_group_name }}' --required
AND restore_point_collection_name = '{{ restore_point_collection_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;