Skip to main content

volumes

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

Overview​

Namevolumes
TypeResource
Idazure.netapp.volumes

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
groupIdsForLdapUserarrayGroup Id list.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_get_group_id_list_for_ldap_userselectresource_group_name, account_name, pool_name, volume_name, subscription_idReturns the list of group Ids for a specific LDAP User.
getselectresource_group_name, account_name, pool_name, volume_name, subscription_idGet the details of the specified volume.
listselectresource_group_name, account_name, pool_name, subscription_idList all volumes within the capacity pool.
create_or_updateinsertresource_group_name, account_name, pool_name, volume_name, subscription_id, location, propertiesCreate or update the specified volume within the capacity pool.
updateupdateresource_group_name, account_name, pool_name, volume_name, subscription_idPatch the specified volume.
create_or_updatereplaceresource_group_name, account_name, pool_name, volume_name, subscription_id, location, propertiesCreate or update the specified volume within the capacity pool.
deletedeleteresource_group_name, account_name, pool_name, volume_name, subscription_idforceDeleteDelete the specified volume.
list_replicationsexecresource_group_name, account_name, pool_name, volume_name, subscription_idList all replications for a specified volume.
list_quota_reportexecresource_group_name, account_name, pool_name, volume_name, subscription_idGet quota report for volume (with filter support).
populate_availability_zoneexecresource_group_name, account_name, pool_name, volume_name, subscription_idThis operation will populate availability zone information for a volume.
revertexecresource_group_name, account_name, pool_name, volume_name, subscription_idRevert a volume to the snapshot specified in the body.
reset_cifs_passwordexecresource_group_name, account_name, pool_name, volume_name, subscription_idReset cifs password from volume.
split_clone_from_parentexecresource_group_name, account_name, pool_name, volume_name, subscription_idSplit operation to convert clone volume to an independent volume.
break_file_locksexecresource_group_name, account_name, pool_name, volume_name, subscription_idBreak all the file locks on a volume.
break_replicationexecresource_group_name, account_name, pool_name, volume_name, subscription_idBreak the replication connection on the destination volume.
reestablish_replicationexecresource_group_name, account_name, pool_name, volume_name, subscription_idRe-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots.
replication_statusexecresource_group_name, account_name, pool_name, volume_name, subscription_idGet the status of the replication.
resync_replicationexecresource_group_name, account_name, pool_name, volume_name, subscription_idResync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.
delete_replicationexecresource_group_name, account_name, pool_name, volume_name, subscription_idDelete the replication connection on the destination volume, and send release to the source replication.
authorize_replicationexecresource_group_name, account_name, pool_name, volume_name, subscription_idAuthorize the replication connection on the source volume.
re_initialize_replicationexecresource_group_name, account_name, pool_name, volume_name, subscription_idRe-Initializes the replication connection on the destination volume.
peer_external_clusterexecresource_group_name, account_name, pool_name, volume_name, subscription_id, peerIpAddressesStarts peering the external cluster for this migration volume.
authorize_external_replicationexecresource_group_name, account_name, pool_name, volume_name, subscription_idStarts SVM peering and returns a command to be run on the external ONTAP to accept it. Once the SVM have been peered a SnapMirror will be created.
finalize_external_replicationexecresource_group_name, account_name, pool_name, volume_name, subscription_idFinalizes the migration of an external volume by releasing the replication and breaking the external cluster peering if no other migration is active.
perform_replication_transferexecresource_group_name, account_name, pool_name, volume_name, subscription_idPerforms an adhoc replication transfer on a volume with volumeType Migration.
pool_changeexecresource_group_name, account_name, pool_name, volume_name, subscription_id, newPoolResourceIdMoves volume to another pool.
relocateexecresource_group_name, account_name, pool_name, volume_name, subscription_idRelocates volume to a new stamp.
finalize_relocationexecresource_group_name, account_name, pool_name, volume_name, subscription_idFinalizes the relocation of the volume and cleans up the old volume.
revert_relocationexecresource_group_name, account_name, pool_name, volume_name, subscription_idReverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.

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.

NameDatatypeDescription
account_namestringThe name of the NetApp account. Required.
pool_namestringThe name of the capacity pool. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
volume_namestringThe name of the volume. Required.
forceDeletebooleanAn option to force delete the volume. Will cleanup resources connected to the particular volume. Default value is None.

SELECT examples​

Returns the list of group Ids for a specific LDAP User.

SELECT
groupIdsForLdapUser
FROM azure.netapp.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
;

INSERT examples​

Create or update the specified volume within the capacity pool.

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

UPDATE examples​

Patch the specified volume.

UPDATE azure.netapp.volumes
SET 
location = '{{ location }}',
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 the specified volume within the capacity pool.

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

DELETE examples​

Delete the specified volume.

DELETE FROM azure.netapp.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
AND forceDelete = '{{ forceDelete }}'
;

Lifecycle Methods​

List all replications for a specified volume.

EXEC azure.netapp.volumes.list_replications 
@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=
'{
"exclude": "{{ exclude }}"
}'
;