volume_snapshots

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

Overview

Name	volume_snapshots
Type	Resource
Id	azure.elastic_san.volume_snapshots

Fields

The following fields are returned by SELECT queries:

get

Operation completed successfully; retrieved Volume Snapshot.

Name	Datatype	Description
properties	object	Properties of Volume Snapshot.

list_by_volume_group

Operation completed successfully; retrieved snapshots in a volume group.

Name	Datatype	Description
properties	object	Properties of Volume Snapshot.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName, snapshotName		Get a Volume Snapshot.
list_by_volume_group	select	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName	$filter	List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter
create	insert	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName, snapshotName, data__properties		Create a Volume Snapshot.
delete	delete	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName, snapshotName		Delete a Volume Snapshot.

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
elasticSanName	string	The name of the ElasticSan.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
snapshotName	string	The name of the volume snapshot within the given volume group.
subscriptionId	string	The ID of the target subscription.
volumeGroupName	string	The name of the VolumeGroup.
$filter	string	Specify $filter='volumeName eq <volume name>' to filter on volume.

SELECT examples

get

Get a Volume Snapshot.

SELECT
properties
FROM azure.elastic_san.volume_snapshots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND elasticSanName = '{{ elasticSanName }}' -- required
AND volumeGroupName = '{{ volumeGroupName }}' -- required
AND snapshotName = '{{ snapshotName }}' -- required
;

list_by_volume_group

List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter

SELECT
properties
FROM azure.elastic_san.volume_snapshots
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND elasticSanName = '{{ elasticSanName }}' -- required
AND volumeGroupName = '{{ volumeGroupName }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Create a Volume Snapshot.

INSERT INTO azure.elastic_san.volume_snapshots (
data__properties,
subscriptionId,
resourceGroupName,
elasticSanName,
volumeGroupName,
snapshotName
)
SELECT 
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ elasticSanName }}',
'{{ volumeGroupName }}',
'{{ snapshotName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: volume_snapshots
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the volume_snapshots resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the volume_snapshots resource.
    - name: elasticSanName
      value: string
      description: Required parameter for the volume_snapshots resource.
    - name: volumeGroupName
      value: string
      description: Required parameter for the volume_snapshots resource.
    - name: snapshotName
      value: string
      description: Required parameter for the volume_snapshots resource.
    - name: properties
      value: object
      description: |
        Properties of Volume Snapshot.

DELETE examples

delete

Delete a Volume Snapshot.

DELETE FROM azure.elastic_san.volume_snapshots
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND elasticSanName = '{{ elasticSanName }}' --required
AND volumeGroupName = '{{ volumeGroupName }}' --required
AND snapshotName = '{{ snapshotName }}' --required
;