volume_groups

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

Overview

Name	volume_groups
Type	Resource
Id	azure_isv.netapp.volume_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Volume group properties
type	string	Resource type

list_by_netapp_account

Name	Datatype	Description
id	string	Resource Id
name	string	Resource name
location	string	Resource location
properties	object	Volume group properties
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, volumeGroupName		Get details of the specified volume group
list_by_netapp_account	select	subscriptionId, resourceGroupName, accountName		List all volume groups for given account
create	insert	subscriptionId, resourceGroupName, accountName, volumeGroupName		Create a volume group along with specified volumes
delete	delete	subscriptionId, resourceGroupName, accountName, volumeGroupName		Delete the specified volume group only if there are no volumes under volume group.

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
accountName	string	The name of the NetApp account
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
volumeGroupName	string	The name of the volumeGroup

SELECT examples

get

Get details of the specified volume group

SELECT
id,
name,
location,
properties,
type
FROM azure_isv.netapp.volume_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND volumeGroupName = '{{ volumeGroupName }}' -- required
;

list_by_netapp_account

List all volume groups for given account

SELECT
id,
name,
location,
properties,
type
FROM azure_isv.netapp.volume_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
;

INSERT examples

create

Create a volume group along with specified volumes

INSERT INTO azure_isv.netapp.volume_groups (
data__location,
data__properties,
subscriptionId,
resourceGroupName,
accountName,
volumeGroupName
)
SELECT 
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ volumeGroupName }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: volume_groups
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the volume_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the volume_groups resource.
    - name: accountName
      value: string
      description: Required parameter for the volume_groups resource.
    - name: volumeGroupName
      value: string
      description: Required parameter for the volume_groups resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: properties
      value: object
      description: |
        Volume group properties

DELETE examples

delete

Delete the specified volume group only if there are no volumes under volume group.

DELETE FROM azure_isv.netapp.volume_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND volumeGroupName = '{{ volumeGroupName }}' --required
;