volumes

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

Overview

Name	volumes
Type	Resource
Id	azure_isv.netapp.volumes

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives
properties	object	Volume properties
tags	object	Resource tags.
zones	array	Availability Zone

list

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	The geo-location where the resource lives
properties	object	Volume properties
tags	object	Resource tags.
zones	array	Availability Zone

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Get the details of the specified volume
list	select	subscriptionId, resourceGroupName, accountName, poolName		List all volumes within the capacity pool
create_or_update	insert	subscriptionId, resourceGroupName, accountName, poolName, volumeName, data__location, data__properties		Create or update the specified volume within the capacity pool
update	update	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Patch the specified volume
delete	delete	subscriptionId, resourceGroupName, accountName, poolName, volumeName	forceDelete	Delete the specified volume
populate_availability_zone	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		This operation will populate availability zone information for a volume
revert	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Revert a volume to the snapshot specified in the body
reset_cifs_password	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Reset cifs password from volume
break_file_locks	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Break all the file locks on a volume
break_replication	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Break the replication connection on the destination volume
reestablish_replication	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots
replication_status	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Get the status of the replication
resync_replication	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Resync 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.
authorize_replication	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Authorize the replication connection on the source volume
re_initialize_replication	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Re-Initializes the replication connection on the destination volume
pool_change	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName, newPoolResourceId		Moves volume to another pool
relocate	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Relocates volume to a new stamp
finalize_relocation	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Finalizes the relocation of the volume and cleans up the old volume.
revert_relocation	exec	subscriptionId, resourceGroupName, accountName, poolName, volumeName		Reverts 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.

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.
volumeName	string	The name of the volume
forceDelete	boolean	An option to force delete the volume. Will cleanup resources connected to the particular volume

SELECT examples

get

Get the details of the specified volume

SELECT
etag,
location,
properties,
tags,
zones
FROM azure_isv.netapp.volumes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND poolName = '{{ poolName }}' -- required
AND volumeName = '{{ volumeName }}' -- required
;

list

List all volumes within the capacity pool

SELECT
etag,
location,
properties,
tags,
zones
FROM azure_isv.netapp.volumes
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND poolName = '{{ poolName }}' -- required
;

INSERT examples

create_or_update

Create or update the specified volume within the capacity pool

INSERT INTO azure_isv.netapp.volumes (
data__tags,
data__location,
data__zones,
data__properties,
subscriptionId,
resourceGroupName,
accountName,
poolName,
volumeName
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ zones }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ accountName }}',
'{{ poolName }}',
'{{ volumeName }}'
RETURNING
etag,
location,
properties,
tags,
zones
;

Manifest

# Description fields are for documentation purposes
- name: volumes
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the volumes resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the volumes resource.
    - name: accountName
      value: string
      description: Required parameter for the volumes resource.
    - name: poolName
      value: string
      description: Required parameter for the volumes resource.
    - name: volumeName
      value: string
      description: Required parameter for the volumes resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: zones
      value: array
      description: |
        Availability Zone
    - name: properties
      value: object
      description: |
        Volume properties

UPDATE examples

update

Patch the specified volume

UPDATE azure_isv.netapp.volumes
SET 
data__location = '{{ location }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND accountName = '{{ accountName }}' --required
AND poolName = '{{ poolName }}' --required
AND volumeName = '{{ volumeName }}' --required
RETURNING
etag,
location,
properties,
tags,
zones;

DELETE examples

delete

Delete the specified volume

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

Lifecycle Methods

populate_availability_zone

This operation will populate availability zone information for a volume

EXEC azure_isv.netapp.volumes.populate_availability_zone 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required
;

revert

Revert a volume to the snapshot specified in the body

EXEC azure_isv.netapp.volumes.revert 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required 
@@json=
'{
"snapshotId": "{{ snapshotId }}"
}'
;

reset_cifs_password

Reset cifs password from volume

EXEC azure_isv.netapp.volumes.reset_cifs_password 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required
;

break_file_locks

Break all the file locks on a volume

EXEC azure_isv.netapp.volumes.break_file_locks 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required 
@@json=
'{
"clientIp": "{{ clientIp }}", 
"confirmRunningDisruptiveOperation": {{ confirmRunningDisruptiveOperation }}
}'
;

break_replication

Break the replication connection on the destination volume

EXEC azure_isv.netapp.volumes.break_replication 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required 
@@json=
'{
"forceBreakReplication": {{ forceBreakReplication }}
}'
;

reestablish_replication

Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots

EXEC azure_isv.netapp.volumes.reestablish_replication 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required 
@@json=
'{
"sourceVolumeId": "{{ sourceVolumeId }}"
}'
;

replication_status

Get the status of the replication

EXEC azure_isv.netapp.volumes.replication_status 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required
;

resync_replication

Resync 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.

EXEC azure_isv.netapp.volumes.resync_replication 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required
;

authorize_replication

Authorize the replication connection on the source volume

EXEC azure_isv.netapp.volumes.authorize_replication 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required 
@@json=
'{
"remoteVolumeResourceId": "{{ remoteVolumeResourceId }}"
}'
;

re_initialize_replication

Re-Initializes the replication connection on the destination volume

EXEC azure_isv.netapp.volumes.re_initialize_replication 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required
;

pool_change

Moves volume to another pool

EXEC azure_isv.netapp.volumes.pool_change 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required 
@@json=
'{
"newPoolResourceId": "{{ newPoolResourceId }}"
}'
;

relocate

Relocates volume to a new stamp

EXEC azure_isv.netapp.volumes.relocate 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required 
@@json=
'{
"creationToken": "{{ creationToken }}"
}'
;

finalize_relocation

Finalizes the relocation of the volume and cleans up the old volume.

EXEC azure_isv.netapp.volumes.finalize_relocation 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required
;

revert_relocation

Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.

EXEC azure_isv.netapp.volumes.revert_relocation 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@accountName='{{ accountName }}' --required, 
@poolName='{{ poolName }}' --required, 
@volumeName='{{ volumeName }}' --required
;