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

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	State of the operation on the resource.
managedBy	object	Parent resource information.
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)
sizeGiB	integer	Volume size. Required.
storageTarget	object	Storage target information.
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".
volumeId	string	Unique Id of the volume in GUID format.

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	State of the operation on the resource.
managedBy	object	Parent resource information.
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)
sizeGiB	integer	Volume size. Required.
storageTarget	object	Storage target information.
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".
volumeId	string	Unique Id of the volume in GUID format.

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, volume_name, subscription_id		Get an Volume.
list_by_volume_group	select	resource_group_name, elastic_san_name, volume_group_name, subscription_id		List Volumes in a VolumeGroup.
create	insert	resource_group_name, elastic_san_name, volume_group_name, volume_name, subscription_id, properties		Create a Volume.
update	update	resource_group_name, elastic_san_name, volume_group_name, volume_name, subscription_id		Update an Volume.
delete	delete	resource_group_name, elastic_san_name, volume_group_name, volume_name, subscription_id	x-ms-delete-snapshots, x-ms-force-delete	Delete an Volume.
pre_backup	exec	resource_group_name, elastic_san_name, volume_group_name, subscription_id, volumeNames		Validate whether a disk snapshot backup can be taken for list of volumes.
pre_restore	exec	resource_group_name, elastic_san_name, volume_group_name, subscription_id, diskSnapshotIds		Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.

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.
subscription_id	string
volume_group_name	string	The name of the VolumeGroup. Required.
volume_name	string	The name of the Volume. Required.
x-ms-delete-snapshots	string	Optional, used to delete snapshots under volume. Allowed value are only true or false. Default value is false. Known values are: "true" and "false". Default value is None.
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. Known values are: "true" and "false". Default value is None.

SELECT examples

get

Get an Volume.

SELECT
id,
name,
creationData,
managedBy,
provisioningState,
sizeGiB,
storageTarget,
systemData,
type,
volumeId
FROM azure.elastic_san.volumes
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 volume_name = '{{ volume_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_volume_group

List Volumes in a VolumeGroup.

SELECT
id,
name,
creationData,
managedBy,
provisioningState,
sizeGiB,
storageTarget,
systemData,
type,
volumeId
FROM azure.elastic_san.volumes
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
;

INSERT examples

create

Create a Volume.

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

Manifest

# Description fields are for documentation purposes
- name: volumes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the volumes resource.
  - name: elastic_san_name
    value: "{{ elastic_san_name }}"
    description: Required parameter for the volumes resource.
  - name: volume_group_name
    value: "{{ volume_group_name }}"
    description: Required parameter for the volumes resource.
  - name: volume_name
    value: "{{ volume_name }}"
    description: Required parameter for the volumes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the volumes resource.
  - name: properties
    description: |
      Properties of Volume. Required.
    value:
      volumeId: "{{ volumeId }}"
      creationData:
        createSource: "{{ createSource }}"
        sourceId: "{{ sourceId }}"
      sizeGiB: {{ sizeGiB }}
      storageTarget:
        targetIqn: "{{ targetIqn }}"
        targetPortalHostname: "{{ targetPortalHostname }}"
        targetPortalPort: {{ targetPortalPort }}
        provisioningState: "{{ provisioningState }}"
        status: "{{ status }}"
      managedBy:
        resourceId: "{{ resourceId }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update an Volume.

UPDATE azure.elastic_san.volumes
SET 
properties = '{{ properties }}'
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 volume_name = '{{ volume_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete an Volume.

DELETE FROM azure.elastic_san.volumes
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 volume_name = '{{ volume_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND x-ms-delete-snapshots = '{{ x-ms-delete-snapshots }}'
AND x-ms-force-delete = '{{ x-ms-force-delete }}'
;

Lifecycle Methods

pre_backup

Validate whether a disk snapshot backup can be taken for list of volumes.

EXEC azure.elastic_san.volumes.pre_backup 
@resource_group_name='{{ resource_group_name }}' --required, 
@elastic_san_name='{{ elastic_san_name }}' --required, 
@volume_group_name='{{ volume_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"volumeNames": "{{ volumeNames }}"
}'
;

pre_restore

Validate whether a list of backed up disk snapshots can be restored into ElasticSan volumes.

EXEC azure.elastic_san.volumes.pre_restore 
@resource_group_name='{{ resource_group_name }}' --required, 
@elastic_san_name='{{ elastic_san_name }}' --required, 
@volume_group_name='{{ volume_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"diskSnapshotIds": "{{ diskSnapshotIds }}"
}'
;