volumes

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

Overview

Name	volumes
Type	Resource
Id	azure.elastic_san.volumes

Fields

The following fields are returned by SELECT queries:

get

Operation completed successfully; retrieved Volume.

Name	Datatype	Description
properties	object	Properties of Volume.

list_by_volume_group

Operation completed successfully; retrieved volumes in a volume group.

Name	Datatype	Description
properties	object	Properties of Volume.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName, volumeName		Get an Volume.
list_by_volume_group	select	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName		List Volumes in a VolumeGroup.
create	insert	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName, volumeName, data__properties		Create a Volume.
update	update	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName, volumeName		Update an Volume.
delete	delete	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName, volumeName	x-ms-delete-snapshots, x-ms-force-delete	Delete an Volume.

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.
subscriptionId	string	The ID of the target subscription.
volumeGroupName	string	The name of the VolumeGroup.
volumeName	string	The name of the Volume.
x-ms-delete-snapshots	string	Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false.
x-ms-force-delete	string	Optional, used to delete volume if active sessions present. Allowed value are only true or false. Default value is false.

SELECT examples

get

Get an Volume.

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

list_by_volume_group

List Volumes in a VolumeGroup.

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

INSERT examples

create

Create a Volume.

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

Manifest

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

UPDATE examples

update

Update an Volume.

UPDATE azure.elastic_san.volumes
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND elasticSanName = '{{ elasticSanName }}' --required
AND volumeGroupName = '{{ volumeGroupName }}' --required
AND volumeName = '{{ volumeName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete an Volume.

DELETE FROM azure.elastic_san.volumes
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND elasticSanName = '{{ elasticSanName }}' --required
AND volumeGroupName = '{{ volumeGroupName }}' --required
AND volumeName = '{{ volumeName }}' --required
AND x-ms-delete-snapshots = '{{ x-ms-delete-snapshots }}'
AND x-ms-force-delete = '{{ x-ms-force-delete }}'
;