snapshots

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

Overview

Name	snapshots
Type	Resource
Id	azure.netapp.snapshots

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.
created	string (date-time)	The creation date of the snapshot.
location	string	Resource location. Required.
provisioningState	string	Azure lifecycle management.
snapshotId	string	UUID v4 used to identify the Snapshot.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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.
created	string (date-time)	The creation date of the snapshot.
location	string	Resource location. Required.
provisioningState	string	Azure lifecycle management.
snapshotId	string	UUID v4 used to identify the Snapshot.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, account_name, pool_name, volume_name, snapshot_name, subscription_id		Get details of the specified snapshot.
list	select	resource_group_name, account_name, pool_name, volume_name, subscription_id		List all snapshots associated with the volume.
create	insert	resource_group_name, account_name, pool_name, volume_name, snapshot_name, subscription_id, location		Create the specified snapshot within the given volume.
update	update	resource_group_name, account_name, pool_name, volume_name, snapshot_name, subscription_id		Patch a snapshot.
delete	delete	resource_group_name, account_name, pool_name, volume_name, snapshot_name, subscription_id		Delete snapshot.
restore_files	exec	resource_group_name, account_name, pool_name, volume_name, snapshot_name, subscription_id, filePaths		Restore the specified files from the specified snapshot to the active filesystem.

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
account_name	string	The name of the NetApp account. Required.
pool_name	string	The name of the capacity pool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
snapshot_name	string	The name of the snapshot. Required.
subscription_id	string
volume_name	string	The name of the volume. Required.

SELECT examples

get

Get details of the specified snapshot.

SELECT
id,
name,
created,
location,
provisioningState,
snapshotId,
systemData,
type
FROM azure.netapp.snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND snapshot_name = '{{ snapshot_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all snapshots associated with the volume.

SELECT
id,
name,
created,
location,
provisioningState,
snapshotId,
systemData,
type
FROM azure.netapp.snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create the specified snapshot within the given volume.

INSERT INTO azure.netapp.snapshots (
properties,
location,
resource_group_name,
account_name,
pool_name,
volume_name,
snapshot_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ location }}' /* required */,
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ pool_name }}',
'{{ volume_name }}',
'{{ snapshot_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: snapshots
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the snapshots resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the snapshots resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the snapshots resource.
  - name: volume_name
    value: "{{ volume_name }}"
    description: Required parameter for the snapshots resource.
  - name: snapshot_name
    value: "{{ snapshot_name }}"
    description: Required parameter for the snapshots resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the snapshots resource.
  - name: properties
    description: |
      Snapshot Properties.
    value:
      snapshotId: "{{ snapshotId }}"
      created: "{{ created }}"
      provisioningState: "{{ provisioningState }}"
  - name: location
    value: "{{ location }}"
    description: |
      Resource location. Required.

UPDATE examples

update

Patch a snapshot.

UPDATE azure.netapp.snapshots
SET 
-- No updatable properties
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND snapshot_name = '{{ snapshot_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Delete snapshot.

DELETE FROM azure.netapp.snapshots
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND snapshot_name = '{{ snapshot_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

restore_files

Restore the specified files from the specified snapshot to the active filesystem.

EXEC azure.netapp.snapshots.restore_files 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@volume_name='{{ volume_name }}' --required, 
@snapshot_name='{{ snapshot_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"filePaths": "{{ filePaths }}", 
"destinationPath": "{{ destinationPath }}"
}'
;