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

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.
creationData	object	Data used when creating a volume snapshot. Required.
provisioningState	string	State of the operation on the resource. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", "Deleting", "Deleted", and "Restoring". (Invalid, Succeeded, Failed, Canceled, Pending, Creating, Updating, Deleting, Deleted, Restoring)
sourceVolumeSizeGiB	integer	Size of Source Volume.
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".
volumeName	string	Source Volume Name of a snapshot.

list_by_volume_group

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.
creationData	object	Data used when creating a volume snapshot. Required.
provisioningState	string	State of the operation on the resource. Known values are: "Invalid", "Succeeded", "Failed", "Canceled", "Pending", "Creating", "Updating", "Deleting", "Deleted", and "Restoring". (Invalid, Succeeded, Failed, Canceled, Pending, Creating, Updating, Deleting, Deleted, Restoring)
sourceVolumeSizeGiB	integer	Size of Source Volume.
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".
volumeName	string	Source Volume Name of a snapshot.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, elastic_san_name, volume_group_name, snapshot_name, subscription_id		Get a Volume Snapshot.
list_by_volume_group	select	resource_group_name, elastic_san_name, volume_group_name, subscription_id	$filter	List Snapshots in a VolumeGroup or List Snapshots by Volume (name) in a VolumeGroup using filter.
create	insert	resource_group_name, elastic_san_name, volume_group_name, snapshot_name, subscription_id, properties		Create a Volume Snapshot.
delete	delete	resource_group_name, elastic_san_name, volume_group_name, snapshot_name, subscription_id		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
elastic_san_name	string	The name of the ElasticSan. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
snapshot_name	string	The name of the volume snapshot within the given volume group. Required.
subscription_id	string
volume_group_name	string	The name of the VolumeGroup. Required.
$filter	string	Specify $filter='volumeName eq ' to filter on volume. Default value is None.

SELECT examples

get

Get a Volume Snapshot.

SELECT
id,
name,
creationData,
provisioningState,
sourceVolumeSizeGiB,
systemData,
type,
volumeName
FROM azure.elastic_san.volume_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND elastic_san_name = '{{ elastic_san_name }}' -- required
AND volume_group_name = '{{ volume_group_name }}' -- required
AND snapshot_name = '{{ snapshot_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_volume_group

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

SELECT
id,
name,
creationData,
provisioningState,
sourceVolumeSizeGiB,
systemData,
type,
volumeName
FROM azure.elastic_san.volume_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND elastic_san_name = '{{ elastic_san_name }}' -- required
AND volume_group_name = '{{ volume_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create

Create a Volume Snapshot.

INSERT INTO azure.elastic_san.volume_snapshots (
properties,
resource_group_name,
elastic_san_name,
volume_group_name,
snapshot_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ elastic_san_name }}',
'{{ volume_group_name }}',
'{{ snapshot_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: volume_snapshots
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the volume_snapshots resource.
  - name: elastic_san_name
    value: "{{ elastic_san_name }}"
    description: Required parameter for the volume_snapshots resource.
  - name: volume_group_name
    value: "{{ volume_group_name }}"
    description: Required parameter for the volume_snapshots resource.
  - name: snapshot_name
    value: "{{ snapshot_name }}"
    description: Required parameter for the volume_snapshots resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the volume_snapshots resource.
  - name: properties
    description: |
      Properties of Volume Snapshot. Required.
    value:
      creationData:
        sourceId: "{{ sourceId }}"
      provisioningState: "{{ provisioningState }}"
      sourceVolumeSizeGiB: {{ sourceVolumeSizeGiB }}
      volumeName: "{{ volumeName }}"

DELETE examples

delete

Delete a Volume Snapshot.

DELETE FROM azure.elastic_san.volume_snapshots
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND elastic_san_name = '{{ elastic_san_name }}' --required
AND volume_group_name = '{{ volume_group_name }}' --required
AND snapshot_name = '{{ snapshot_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;