elastic_volumes

Creates, updates, deletes, gets or lists an elastic_volumes resource.

Overview

Name	elastic_volumes
Type	Resource
Id	azure.netapp.elastic_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.
availabilityStatus	string	Current availability status of the resource. Known values are: "Online" and "Offline". (Online, Offline)
backupResourceId	string	Resource identifier used to identify the Elastic Backup.
dataProtection	object	Data protection configuration option for the volume, including snapshot policies and backup.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
exportPolicy	object	Set of export policy rules.
filePath	string	A unique file path for the volume. Used when creating mount targets. This needs to be unique within the elastic capacity pool. Required.
location	string	The geo-location where the resource lives. Required.
mountTargets	array	List of mount targets that can be used to mount this volume.
protocolTypes	array	Set of support protocol types for the elastic volume. Required.
provisioningState	string	Azure lifecycle management. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
restorationState	string	The current state of the restoration process. Known values are: "Restoring", "Restored", and "Failed". (Restoring, Restored, Failed)
size	integer	Maximum size allowed for a volume in bytes. Valid values are in the range 1GiB to 16TiB. Values expressed in bytes as multiples of 1 GiB. Required.
smbProperties	object	SMB Properties.
snapshotDirectoryVisibility	string	Controls the visibility of the volume's read-only snapshot directory, which provides access to each of the volume's snapshots. Known values are: "Hidden" and "Visible". (Hidden, Visible)
snapshotResourceId	string	Resource identifier used to identify the Elastic Snapshot.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

list_by_elastic_pool

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.
availabilityStatus	string	Current availability status of the resource. Known values are: "Online" and "Offline". (Online, Offline)
backupResourceId	string	Resource identifier used to identify the Elastic Backup.
dataProtection	object	Data protection configuration option for the volume, including snapshot policies and backup.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
exportPolicy	object	Set of export policy rules.
filePath	string	A unique file path for the volume. Used when creating mount targets. This needs to be unique within the elastic capacity pool. Required.
location	string	The geo-location where the resource lives. Required.
mountTargets	array	List of mount targets that can be used to mount this volume.
protocolTypes	array	Set of support protocol types for the elastic volume. Required.
provisioningState	string	Azure lifecycle management. Known values are: "Accepted", "Creating", "Patching", "Updating", "Deleting", "Moving", "Failed", and "Succeeded". (Accepted, Creating, Patching, Updating, Deleting, Moving, Failed, Succeeded)
restorationState	string	The current state of the restoration process. Known values are: "Restoring", "Restored", and "Failed". (Restoring, Restored, Failed)
size	integer	Maximum size allowed for a volume in bytes. Valid values are in the range 1GiB to 16TiB. Values expressed in bytes as multiples of 1 GiB. Required.
smbProperties	object	SMB Properties.
snapshotDirectoryVisibility	string	Controls the visibility of the volume's read-only snapshot directory, which provides access to each of the volume's snapshots. Known values are: "Hidden" and "Visible". (Hidden, Visible)
snapshotResourceId	string	Resource identifier used to identify the Elastic Snapshot.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
zones	array	The availability zones.

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, subscription_id		Get the details of the specified volume.
list_by_elastic_pool	select	resource_group_name, account_name, pool_name, subscription_id		List all Elastic Volumes within the Elastic Capacity Pool.
create_or_update	insert	resource_group_name, account_name, pool_name, volume_name, subscription_id, location		Create or update the specified volume within the capacity pool.
update	update	resource_group_name, account_name, pool_name, volume_name, subscription_id		Patch the specified elastic volume.
create_or_update	replace	resource_group_name, account_name, pool_name, volume_name, subscription_id, location		Create or update the specified volume within the capacity pool.
delete	delete	resource_group_name, account_name, pool_name, volume_name, subscription_id		Delete the specified Elastic Volume.
revert	exec	resource_group_name, account_name, pool_name, volume_name, subscription_id		Revert an Elastic Volume to the snapshot specified in the body.

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 ElasticAccount. Required.
pool_name	string	The name of the ElasticCapacityPool. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
volume_name	string	The name of the ElasticVolume. Required.

SELECT examples

get

Get the details of the specified volume.

SELECT
id,
name,
availabilityStatus,
backupResourceId,
dataProtection,
eTag,
exportPolicy,
filePath,
location,
mountTargets,
protocolTypes,
provisioningState,
restorationState,
size,
smbProperties,
snapshotDirectoryVisibility,
snapshotResourceId,
systemData,
tags,
type,
zones
FROM azure.netapp.elastic_volumes
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
;

list_by_elastic_pool

List all Elastic Volumes within the Elastic Capacity Pool.

SELECT
id,
name,
availabilityStatus,
backupResourceId,
dataProtection,
eTag,
exportPolicy,
filePath,
location,
mountTargets,
protocolTypes,
provisioningState,
restorationState,
size,
smbProperties,
snapshotDirectoryVisibility,
snapshotResourceId,
systemData,
tags,
type,
zones
FROM azure.netapp.elastic_volumes
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND account_name = '{{ account_name }}' -- required
AND pool_name = '{{ pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update the specified volume within the capacity pool.

INSERT INTO azure.netapp.elastic_volumes (
tags,
location,
properties,
zones,
resource_group_name,
account_name,
pool_name,
volume_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ zones }}',
'{{ resource_group_name }}',
'{{ account_name }}',
'{{ pool_name }}',
'{{ volume_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type,
zones
;

Manifest

# Description fields are for documentation purposes
- name: elastic_volumes
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the elastic_volumes resource.
  - name: account_name
    value: "{{ account_name }}"
    description: Required parameter for the elastic_volumes resource.
  - name: pool_name
    value: "{{ pool_name }}"
    description: Required parameter for the elastic_volumes resource.
  - name: volume_name
    value: "{{ volume_name }}"
    description: Required parameter for the elastic_volumes resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the elastic_volumes resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      filePath: "{{ filePath }}"
      size: {{ size }}
      exportPolicy:
        rules:
          - ruleIndex: {{ ruleIndex }}
            unixAccessRule: "{{ unixAccessRule }}"
            nfsv3: "{{ nfsv3 }}"
            nfsv4: "{{ nfsv4 }}"
            allowedClients: "{{ allowedClients }}"
            rootAccess: "{{ rootAccess }}"
      protocolTypes:
        - "{{ protocolTypes }}"
      provisioningState: "{{ provisioningState }}"
      availabilityStatus: "{{ availabilityStatus }}"
      snapshotResourceId: "{{ snapshotResourceId }}"
      mountTargets:
        - ipAddress: "{{ ipAddress }}"
          smbServerFqdn: "{{ smbServerFqdn }}"
      dataProtection:
        snapshot:
          snapshotPolicyResourceId: "{{ snapshotPolicyResourceId }}"
        backup:
          elasticBackupPolicyResourceId: "{{ elasticBackupPolicyResourceId }}"
          policyEnforcement: "{{ policyEnforcement }}"
          elasticBackupVaultResourceId: "{{ elasticBackupVaultResourceId }}"
      snapshotDirectoryVisibility: "{{ snapshotDirectoryVisibility }}"
      smbProperties:
        smbEncryption: "{{ smbEncryption }}"
      backupResourceId: "{{ backupResourceId }}"
      restorationState: "{{ restorationState }}"
  - name: zones
    value:
      - "{{ zones }}"
    description: |
      The availability zones.

UPDATE examples

update

Patch the specified elastic volume.

UPDATE azure.netapp.elastic_volumes
SET 
tags = '{{ tags }}',
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 subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type,
zones;

REPLACE examples

create_or_update

Create or update the specified volume within the capacity pool.

REPLACE azure.netapp.elastic_volumes
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
zones = '{{ zones }}'
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
AND location = '{{ location }}' --required
RETURNING
id,
name,
eTag,
location,
properties,
systemData,
tags,
type,
zones;

DELETE examples

delete

Delete the specified Elastic Volume.

DELETE FROM azure.netapp.elastic_volumes
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
;

Lifecycle Methods

revert

Revert an Elastic Volume to the snapshot specified in the body.

EXEC azure.netapp.elastic_volumes.revert 
@resource_group_name='{{ resource_group_name }}' --required, 
@account_name='{{ account_name }}' --required, 
@pool_name='{{ pool_name }}' --required, 
@volume_name='{{ volume_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"snapshotResourceId": "{{ snapshotResourceId }}"
}'
;