volumes

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

Overview

Name	volumes
Type	Resource
Id	azure_isv.netapp.volumes

Fields

vw_volumes

Name	Datatype	Description
accountName	text	field from the properties object
actual_throughput_mibps	text	field from the properties object
avs_data_store	text	field from the properties object
backup_id	text	field from the properties object
baremetal_tenant_id	text	field from the properties object
capacity_pool_resource_id	text	field from the properties object
clone_progress	text	field from the properties object
cool_access	text	field from the properties object
cool_access_retrieval_policy	text	field from the properties object
coolness_period	text	field from the properties object
creation_token	text	field from the properties object
data_protection	text	field from the properties object
data_store_resource_id	text	field from the properties object
default_group_quota_in_ki_bs	text	field from the properties object
default_user_quota_in_ki_bs	text	field from the properties object
delete_base_snapshot	text	field from the properties object
enable_subvolumes	text	field from the properties object
encrypted	text	field from the properties object
encryption_key_source	text	field from the properties object
etag	text	A unique read-only string that changes whenever the resource is updated.
export_policy	text	field from the properties object
file_access_logs	text	field from the properties object
file_system_id	text	field from the properties object
is_default_quota_enabled	text	field from the properties object
is_large_volume	text	field from the properties object
is_restoring	text	field from the properties object
kerberos_enabled	text	field from the properties object
key_vault_private_endpoint_resource_id	text	field from the properties object
ldap_enabled	text	field from the properties object
location	text	The geo-location where the resource lives
maximum_number_of_files	text	field from the properties object
mount_targets	text	field from the properties object
network_features	text	field from the properties object
network_sibling_set_id	text	field from the properties object
originating_resource_id	text	field from the properties object
placement_rules	text	field from the properties object
poolName	text	field from the properties object
protocol_types	text	field from the properties object
provisioned_availability_zone	text	field from the properties object
provisioning_state	text	field from the properties object
proximity_placement_group	text	field from the properties object
resourceGroupName	text	field from the properties object
security_style	text	field from the properties object
service_level	text	field from the properties object
smb_access_based_enumeration	text	field from the properties object
smb_continuously_available	text	field from the properties object
smb_encryption	text	field from the properties object
smb_non_browsable	text	field from the properties object
snapshot_directory_visible	text	field from the properties object
snapshot_id	text	field from the properties object
storage_to_network_proximity	text	field from the properties object
subnet_id	text	field from the properties object
subscriptionId	text	field from the properties object
t2_network	text	field from the properties object
tags	text	Resource tags.
throughput_mibps	text	field from the properties object
unix_permissions	text	field from the properties object
usage_threshold	text	field from the properties object
volumeName	text	field from the properties object
volume_group_name	text	field from the properties object
volume_spec_name	text	field from the properties object
volume_type	text	field from the properties object
zones	text	Availability Zone

volumes

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

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

SELECT examples

List all volumes within the capacity pool

vw_volumes

SELECT
accountName,
actual_throughput_mibps,
avs_data_store,
backup_id,
baremetal_tenant_id,
capacity_pool_resource_id,
clone_progress,
cool_access,
cool_access_retrieval_policy,
coolness_period,
creation_token,
data_protection,
data_store_resource_id,
default_group_quota_in_ki_bs,
default_user_quota_in_ki_bs,
delete_base_snapshot,
enable_subvolumes,
encrypted,
encryption_key_source,
etag,
export_policy,
file_access_logs,
file_system_id,
is_default_quota_enabled,
is_large_volume,
is_restoring,
kerberos_enabled,
key_vault_private_endpoint_resource_id,
ldap_enabled,
location,
maximum_number_of_files,
mount_targets,
network_features,
network_sibling_set_id,
originating_resource_id,
placement_rules,
poolName,
protocol_types,
provisioned_availability_zone,
provisioning_state,
proximity_placement_group,
resourceGroupName,
security_style,
service_level,
smb_access_based_enumeration,
smb_continuously_available,
smb_encryption,
smb_non_browsable,
snapshot_directory_visible,
snapshot_id,
storage_to_network_proximity,
subnet_id,
subscriptionId,
t2_network,
tags,
throughput_mibps,
unix_permissions,
usage_threshold,
volumeName,
volume_group_name,
volume_spec_name,
volume_type,
zones
FROM azure_isv.netapp.vw_volumes
WHERE accountName = '{{ accountName }}'
AND poolName = '{{ poolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

volumes

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

INSERT example

Use the following StackQL query and manifest file to create a new volumes resource.

All Properties

/*+ create */
INSERT INTO azure_isv.netapp.volumes (
accountName,
poolName,
resourceGroupName,
subscriptionId,
volumeName,
data__location,
data__properties,
tags,
location,
zones,
properties
)
SELECT 
'{{ accountName }}',
'{{ poolName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ volumeName }}',
'{{ data__location }}',
'{{ data__properties }}',
'{{ tags }}',
'{{ location }}',
'{{ zones }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: tags
      value: object
    - name: location
      value: string
    - name: etag
      value: string
    - name: zones
      value:
        - string
    - name: properties
      value:
        - name: fileSystemId
          value: string
        - name: creationToken
          value: string
        - name: serviceLevel
          value: []
        - name: usageThreshold
          value: integer
        - name: exportPolicy
          value: string
        - name: protocolTypes
          value:
            - string
        - name: provisioningState
          value: string
        - name: snapshotId
          value: string
        - name: deleteBaseSnapshot
          value: boolean
        - name: backupId
          value: string
        - name: baremetalTenantId
          value: string
        - name: subnetId
          value: string
        - name: networkFeatures
          value: []
        - name: networkSiblingSetId
          value: string
        - name: storageToNetworkProximity
          value: string
        - name: mountTargets
          value:
            - - name: mountTargetId
                value: string
              - name: fileSystemId
                value: string
              - name: ipAddress
                value: string
              - name: smbServerFqdn
                value: string
        - name: volumeType
          value: string
        - name: dataProtection
          value: string
        - name: isRestoring
          value: boolean
        - name: snapshotDirectoryVisible
          value: boolean
        - name: kerberosEnabled
          value: boolean
        - name: securityStyle
          value: string
        - name: smbEncryption
          value: boolean
        - name: smbAccessBasedEnumeration
          value: []
        - name: smbNonBrowsable
          value: []
        - name: smbContinuouslyAvailable
          value: boolean
        - name: throughputMibps
          value: number
        - name: actualThroughputMibps
          value: number
        - name: encryptionKeySource
          value: string
        - name: keyVaultPrivateEndpointResourceId
          value: string
        - name: ldapEnabled
          value: boolean
        - name: coolAccess
          value: boolean
        - name: coolnessPeriod
          value: integer
        - name: coolAccessRetrievalPolicy
          value: []
        - name: unixPermissions
          value: string
        - name: cloneProgress
          value: integer
        - name: fileAccessLogs
          value: string
        - name: avsDataStore
          value: string
        - name: dataStoreResourceId
          value:
            - string
        - name: isDefaultQuotaEnabled
          value: boolean
        - name: defaultUserQuotaInKiBs
          value: integer
        - name: defaultGroupQuotaInKiBs
          value: integer
        - name: maximumNumberOfFiles
          value: integer
        - name: volumeGroupName
          value: string
        - name: capacityPoolResourceId
          value: string
        - name: proximityPlacementGroup
          value: string
        - name: t2Network
          value: string
        - name: volumeSpecName
          value: string
        - name: encrypted
          value: boolean
        - name: placementRules
          value:
            - - name: key
                value: string
              - name: value
                value: string
        - name: enableSubvolumes
          value: string
        - name: provisionedAvailabilityZone
          value: string
        - name: isLargeVolume
          value: boolean
        - name: originatingResourceId
          value: string

UPDATE example

Updates a volumes resource.

/*+ update */
UPDATE azure_isv.netapp.volumes
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
accountName = '{{ accountName }}'
AND poolName = '{{ poolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND volumeName = '{{ volumeName }}';

DELETE example

Deletes the specified volumes resource.

/*+ delete */
DELETE FROM azure_isv.netapp.volumes
WHERE accountName = '{{ accountName }}'
AND poolName = '{{ poolName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND volumeName = '{{ volumeName }}';