volume_groups

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

Overview

Name	volume_groups
Type	Resource
Id	azure.elastic_san.volume_groups

Fields

The following fields are returned by SELECT queries:

get

Operation completed successfully; retrieved iSCSI Target.

Name	Datatype	Description
identity	object	Identity for the resource.
properties	object	Properties of VolumeGroup.

list_by_elastic_san

OK -- Operation completed successfully; retrieved Volume Group List.

Name	Datatype	Description
identity	object	Identity for the resource.
properties	object	Properties of VolumeGroup.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName		Get an VolumeGroups.
list_by_elastic_san	select	subscriptionId, resourceGroupName, elasticSanName		List VolumeGroups.
create	insert	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName		Create a Volume Group.
update	update	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName		Update an VolumeGroup.
delete	delete	subscriptionId, resourceGroupName, elasticSanName, volumeGroupName		Delete an VolumeGroup.

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.

SELECT examples

get

Get an VolumeGroups.

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

list_by_elastic_san

List VolumeGroups.

SELECT
identity,
properties
FROM azure.elastic_san.volume_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND elasticSanName = '{{ elasticSanName }}' -- required
;

INSERT examples

create

Create a Volume Group.

INSERT INTO azure.elastic_san.volume_groups (
data__identity,
data__properties,
subscriptionId,
resourceGroupName,
elasticSanName,
volumeGroupName
)
SELECT 
'{{ identity }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ elasticSanName }}',
'{{ volumeGroupName }}'
RETURNING
identity,
properties
;

Manifest

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

UPDATE examples

update

Update an VolumeGroup.

UPDATE azure.elastic_san.volume_groups
SET 
data__identity = '{{ identity }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND elasticSanName = '{{ elasticSanName }}' --required
AND volumeGroupName = '{{ volumeGroupName }}' --required
RETURNING
identity,
properties;

DELETE examples

delete

Delete an VolumeGroup.

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