subvolumes

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

Overview

Name	subvolumes
Type	Resource
Id	azure.netapp.subvolumes

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.
parentPath	string	parent path to the subvolume.
path	string	Path to the subvolume.
provisioningState	string	Azure lifecycle management.
size	integer	Truncate subvolume to the provided size in bytes.
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".

list_by_volume

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.
parentPath	string	parent path to the subvolume.
path	string	Path to the subvolume.
provisioningState	string	Azure lifecycle management.
size	integer	Truncate subvolume to the provided size in bytes.
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, account_name, pool_name, volume_name, subvolume_name, subscription_id		Returns the path associated with the subvolumeName provided.
list_by_volume	select	resource_group_name, account_name, pool_name, volume_name, subscription_id		Returns a list of the subvolumes in the volume.
create	insert	resource_group_name, account_name, pool_name, volume_name, subvolume_name, subscription_id		Creates a subvolume in the path or clones the subvolume mentioned in the parentPath.
update	update	resource_group_name, account_name, pool_name, volume_name, subvolume_name, subscription_id		Patch a subvolume.
delete	delete	resource_group_name, account_name, pool_name, volume_name, subvolume_name, subscription_id		Delete subvolume.
get_metadata	exec	resource_group_name, account_name, pool_name, volume_name, subvolume_name, subscription_id		Get details of the specified 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
account_name	string	The name of the NetApp account. Required.
pool_name	string	The name of the capacity pool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
subvolume_name	string	The name of the subvolume. Required.
volume_name	string	The name of the volume. Required.

SELECT examples

get

Returns the path associated with the subvolumeName provided.

SELECT
id,
name,
parentPath,
path,
provisioningState,
size,
systemData,
type
FROM azure.netapp.subvolumes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND subvolume_name = '{{ subvolume_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_volume

Returns a list of the subvolumes in the volume.

SELECT
id,
name,
parentPath,
path,
provisioningState,
size,
systemData,
type
FROM azure.netapp.subvolumes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND volume_name = '{{ volume_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.netapp.subvolumes (
properties,
resource_group_name,
account_name,
pool_name,
volume_name,
subvolume_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ pool_name }}',
'{{ volume_name }}',
'{{ subvolume_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: subvolumes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the subvolumes resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the subvolumes resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the subvolumes resource.
  - name: volume_name
    value: "{{ volume_name }}"
    description: Required parameter for the subvolumes resource.
  - name: subvolume_name
    value: "{{ subvolume_name }}"
    description: Required parameter for the subvolumes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the subvolumes resource.
  - name: properties
    description: |
      Subvolume Properties.
    value:
      path: "{{ path }}"
      size: {{ size }}
      parentPath: "{{ parentPath }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Patch a subvolume.

UPDATE azure.netapp.subvolumes
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND subvolume_name = '{{ subvolume_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete subvolume.

DELETE FROM azure.netapp.subvolumes
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND account_name = '{{ account_name }}' --required
AND pool_name = '{{ pool_name }}' --required
AND volume_name = '{{ volume_name }}' --required
AND subvolume_name = '{{ subvolume_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_metadata

Get details of the specified subvolume.

EXEC azure.netapp.subvolumes.get_metadata 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@volume_name='{{ volume_name }}' --required, 
@subvolume_name='{{ subvolume_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;