snapshots

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

Overview

Name	snapshots
Type	Resource
Id	azure_isv.netapp.snapshots

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	Resource location
properties	object	Snapshot Properties

list

Name	Datatype	Description
location	string	Resource location
properties	object	Snapshot Properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, poolName, volumeName, snapshotName		Get details of the specified snapshot
list	select	subscriptionId, resourceGroupName, accountName, poolName, volumeName		List all snapshots associated with the volume
create	insert	subscriptionId, resourceGroupName, accountName, poolName, volumeName, snapshotName, data__location		Create the specified snapshot within the given volume
update	update	subscriptionId, resourceGroupName, accountName, poolName, volumeName, snapshotName		Patch a snapshot
delete	delete	subscriptionId, resourceGroupName, accountName, poolName, volumeName, snapshotName		Delete snapshot
restore_files	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName, snapshotName, 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
accountName	string	The name of the NetApp account
poolName	string	The name of the capacity pool
resourceGroupName	string	The name of the resource group. The name is case insensitive.
snapshotName	string	The name of the snapshot
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
volumeName	string	The name of the volume

SELECT examples

get

Get details of the specified snapshot

SELECT
location,
properties
FROM azure_isv.netapp.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND poolName = '{{ poolName }}' -- required
AND volumeName = '{{ volumeName }}' -- required
AND snapshotName = '{{ snapshotName }}' -- required
;

list

List all snapshots associated with the volume

SELECT
location,
properties
FROM azure_isv.netapp.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND poolName = '{{ poolName }}' -- required
AND volumeName = '{{ volumeName }}' -- required
;

INSERT examples

create

Create the specified snapshot within the given volume

INSERT INTO azure_isv.netapp.snapshots (
data__location,
data__properties,
subscriptionId,
resourceGroupName,
accountName,
poolName,
volumeName,
snapshotName
)
SELECT 
'{{ location }}' /* required */,
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ poolName }}',
'{{ volumeName }}',
'{{ snapshotName }}'
RETURNING
location,
properties
;

Manifest

# Description fields are for documentation purposes
- name: snapshots
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the snapshots resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the snapshots resource.
    - name: accountName
      value: string
      description: Required parameter for the snapshots resource.
    - name: poolName
      value: string
      description: Required parameter for the snapshots resource.
    - name: volumeName
      value: string
      description: Required parameter for the snapshots resource.
    - name: snapshotName
      value: string
      description: Required parameter for the snapshots resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: properties
      value: object
      description: |
        Snapshot Properties

UPDATE examples

update

Patch a snapshot

UPDATE azure_isv.netapp.snapshots
SET 
-- No updatable properties
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND poolName = '{{ poolName }}' --required
AND volumeName = '{{ volumeName }}' --required
AND snapshotName = '{{ snapshotName }}' --required
RETURNING
location,
properties;

DELETE examples

delete

Delete snapshot

DELETE FROM azure_isv.netapp.snapshots
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND poolName = '{{ poolName }}' --required
AND volumeName = '{{ volumeName }}' --required
AND snapshotName = '{{ snapshotName }}' --required
;

Lifecycle Methods

restore_files

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

EXEC azure_isv.netapp.snapshots.restore_files 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required, 
@snapshotName='{{ snapshotName }}' --required 
@@json=
'{
"filePaths": "{{ filePaths }}", 
"destinationPath": "{{ destinationPath }}"
}'
;