subvolumes

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

Overview

Name	subvolumes
Type	Resource
Id	azure_isv.netapp.subvolumes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	Subvolume Properties

list_by_volume

Name	Datatype	Description
properties	object	Subvolume Properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, poolName, volumeName, subvolumeName		Returns the path associated with the subvolumeName provided
list_by_volume	select	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Returns a list of the subvolumes in the volume
create	insert	subscriptionId, resourceGroupName, accountName, poolName, volumeName, subvolumeName		Creates a subvolume in the path or clones the subvolume mentioned in the parentPath
update	update	subscriptionId, resourceGroupName, accountName, poolName, volumeName, subvolumeName		Patch a subvolume
delete	delete	subscriptionId, resourceGroupName, accountName, poolName, volumeName, subvolumeName		Delete subvolume

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
poolName	string	The name of the capacity pool
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.
subvolumeName	string	The name of the subvolume.
volumeName	string	The name of the volume

SELECT examples

get

Returns the path associated with the subvolumeName provided

SELECT
properties
FROM azure_isv.netapp.subvolumes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND poolName = '{{ poolName }}' -- required
AND volumeName = '{{ volumeName }}' -- required
AND subvolumeName = '{{ subvolumeName }}' -- required
;

list_by_volume

Returns a list of the subvolumes in the volume

SELECT
properties
FROM azure_isv.netapp.subvolumes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND poolName = '{{ poolName }}' -- required
AND volumeName = '{{ volumeName }}' -- required
;

INSERT examples

create

Creates a subvolume in the path or clones the subvolume mentioned in the parentPath

INSERT INTO azure_isv.netapp.subvolumes (
data__properties,
subscriptionId,
resourceGroupName,
accountName,
poolName,
volumeName,
subvolumeName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ poolName }}',
'{{ volumeName }}',
'{{ subvolumeName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: subvolumes
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the subvolumes resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the subvolumes resource.
    - name: accountName
      value: string
      description: Required parameter for the subvolumes resource.
    - name: poolName
      value: string
      description: Required parameter for the subvolumes resource.
    - name: volumeName
      value: string
      description: Required parameter for the subvolumes resource.
    - name: subvolumeName
      value: string
      description: Required parameter for the subvolumes resource.
    - name: properties
      value: object
      description: |
        Subvolume Properties

UPDATE examples

update

Patch a subvolume

UPDATE azure_isv.netapp.subvolumes
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND poolName = '{{ poolName }}' --required
AND volumeName = '{{ volumeName }}' --required
AND subvolumeName = '{{ subvolumeName }}' --required
RETURNING
properties;

DELETE examples

delete

Delete subvolume

DELETE FROM azure_isv.netapp.subvolumes
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND poolName = '{{ poolName }}' --required
AND volumeName = '{{ volumeName }}' --required
AND subvolumeName = '{{ subvolumeName }}' --required
;