Volumes - List

Service:: Azure NetApp Files

API Version:: 2025-09-01

List all volumes within the capacity pool

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes?api-version=2025-09-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$	The name of the NetApp account
poolName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$	The name of the capacity pool
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	VolumeList	Azure operation completed successfully.
Other Status Codes	ErrorResponse	An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Volumes_List

Sample request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes?api-version=2025-09-01


/**
 * Samples for Volumes List.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-09-01/Volumes_List.json
     */
    /**
     * Sample code: Volumes_List.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void volumesList(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.volumes().list("myRG", "account1", "pool1", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python volumes_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.volumes.list(
        resource_group_name="myRG",
        account_name="account1",
        pool_name="pool1",
    )
    for item in response:
        print(item)


# x-ms-original-file: 2025-09-01/Volumes_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v8"
)

// Generated from example definition: 2025-09-01/Volumes_List.json
func ExampleVolumesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewVolumesClient().NewListPager("myRG", "account1", "pool1", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page = armnetapp.VolumesClientListResponse{
		// 	VolumeList: armnetapp.VolumeList{
		// 		Value: []*armnetapp.Volume{
		// 			{
		// 				Name: to.Ptr("account1/pool1/volume1"),
		// 				Type: to.Ptr("Microsoft.NetApp/netAppAccounts/capacityPools/volumes"),
		// 				ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1"),
		// 				Location: to.Ptr("eastus"),
		// 				Properties: &armnetapp.VolumeProperties{
		// 					CreationToken: to.Ptr("my-unique-file-path"),
		// 					FileSystemID: to.Ptr("9760acf5-4638-11e7-9bdb-020073ca7778"),
		// 					NetworkFeatures: to.Ptr(armnetapp.NetworkFeaturesStandard),
		// 					NetworkSiblingSetID: to.Ptr("0f434a03-ce0b-4935-81af-d98652ffb1c4"),
		// 					ProvisioningState: to.Ptr("Succeeded"),
		// 					ServiceLevel: to.Ptr(armnetapp.ServiceLevelPremium),
		// 					StorageToNetworkProximity: to.Ptr(armnetapp.VolumeStorageToNetworkProximityT2),
		// 					SubnetID: to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
		// 					ThroughputMibps: to.Ptr[float32](128),
		// 					UsageThreshold: to.Ptr[int64](107374182400),
		// 				},
		// 			},
		// 		},
		// 	},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to list all volumes within the capacity pool
 *
 * @summary list all volumes within the capacity pool
 * x-ms-original-file: 2025-09-01/Volumes_List.json
 */
async function volumesList() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "00000000-0000-0000-0000-000000000000";
  const client = new NetAppManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.volumes.list("myRG", "account1", "pool1")) {
    resArray.push(item);
  }

  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/NetApp/stable/2025-09-01/examples/Volumes_List.json
// this example is just showing the usage of "Volumes_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CapacityPoolResource created on azure
// for more information of creating CapacityPoolResource, please refer to the document of CapacityPoolResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "myRG";
string accountName = "account1";
string poolName = "pool1";
ResourceIdentifier capacityPoolResourceId = CapacityPoolResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName);
CapacityPoolResource capacityPool = client.GetCapacityPoolResource(capacityPoolResourceId);

// get the collection of this NetAppVolumeResource
NetAppVolumeCollection collection = capacityPool.GetNetAppVolumes();

// invoke the operation and iterate over the result
await foreach (NetAppVolumeResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    NetAppVolumeData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "account1/pool1/volume1",
      "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
      "location": "eastus",
      "properties": {
        "creationToken": "my-unique-file-path",
        "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
        "networkFeatures": "Standard",
        "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4",
        "provisioningState": "Succeeded",
        "serviceLevel": "Premium",
        "storageToNetworkProximity": "T2",
        "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
        "throughputMibps": 128,
        "usageThreshold": 107374182400
      }
    }
  ]
}

Definitions

Name	Description
AcceptGrowCapacityPoolForShortTermCloneSplit	While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.
AvsDataStore	Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
ChownMode	This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
CoolAccessRetrievalPolicy	coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.
CoolAccessTieringPolicy	coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier.
createdByType	The type of identity that created the resource.
DestinationReplication	Destination replication properties
EnableSubvolumes	Flag indicating whether subvolume operations are enabled on the volume
EncryptionKeySource	Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
EndpointType	Indicates whether the local volume is the source or destination for the Volume Replication
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExportPolicyRule	Volume Export Policy Rule
FileAccessLogs	Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
MountTargetProperties	Mount target properties
NetworkFeatures	Network features available to the volume, or current state of update.
PlacementKeyValuePairs	Application specific parameters for the placement of volumes in the volume group
RemotePath	The full path to a volume that is to be migrated into ANF. Required for Migration volumes
ReplicationObject	Replication properties
ReplicationSchedule	Schedule
ReplicationType	Indicates whether the replication is cross zone or cross region.
SecurityStyle	The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
ServiceLevel	The service level of the file system
SmbAccessBasedEnumeration	Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
SmbNonBrowsable	Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
systemData	Metadata pertaining to creation and last modification of the resource.
Volume	Volume resource
VolumeBackupProperties	Volume Backup Properties
VolumeList	List of volume resources
VolumePropertiesDataProtection	DataProtection type volumes include an object containing details of the replication
VolumePropertiesExportPolicy	Set of export policy rules
VolumeRelocationProperties	Volume relocation properties
VolumeSnapshotProperties	Volume Snapshot Properties
VolumeStorageToNetworkProximity	Provides storage to network proximity information for the volume.

AcceptGrowCapacityPoolForShortTermCloneSplit

Enumeration

While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.

Value	Description
Accepted	Auto grow capacity pool for short term clone split is accepted.
Declined	Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool.

AvsDataStore

Enumeration

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose

Value	Description
Enabled	avsDataStore is enabled
Disabled	avsDataStore is disabled

ChownMode

Enumeration

This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.

Value	Description
Restricted
Unrestricted

CoolAccessRetrievalPolicy

Enumeration

coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.

Value	Description
Default
OnRead
Never

CoolAccessTieringPolicy

Enumeration

coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier.

Value	Description
Auto
SnapshotOnly

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DestinationReplication

Object

Destination replication properties

Name	Type	Description
region	string	The remote region for the destination volume.
replicationType	ReplicationType	Indicates whether the replication is cross zone or cross region.
resourceId	string (arm-id)	The resource ID of the remote volume
zone	string	The remote zone for the destination volume.

EnableSubvolumes

Enumeration

Flag indicating whether subvolume operations are enabled on the volume

Value	Description
Enabled	subvolumes are enabled
Disabled	subvolumes are not enabled

EncryptionKeySource

Enumeration

Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'

Value	Description
Microsoft.NetApp	Microsoft-managed key encryption
Microsoft.KeyVault	Customer-managed key encryption

EndpointType

Enumeration

Indicates whether the local volume is the source or destination for the Volume Replication

Value	Description
src
dst

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExportPolicyRule

Object

Volume Export Policy Rule

Name	Type	Default value	Description
allowedClients	string		Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
chownMode	ChownMode	Restricted	This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
cifs	boolean		Allows CIFS protocol
hasRootAccess	boolean	True	Has root access to volume
kerberos5ReadOnly	boolean	False	Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
kerberos5ReadWrite	boolean	False	Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5iReadOnly	boolean	False	Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
kerberos5iReadWrite	boolean	False	Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5pReadOnly	boolean	False	Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
kerberos5pReadWrite	boolean	False	Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
nfsv3	boolean		Allows NFSv3 protocol. Enable only for NFSv3 type volumes
nfsv41	boolean		Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
ruleIndex	integer (int32)		Order index
unixReadOnly	boolean		Read only access
unixReadWrite	boolean		Read and write access

FileAccessLogs

Enumeration

Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.

Value	Description
Enabled	fileAccessLogs are enabled
Disabled	fileAccessLogs are not enabled

MountTargetProperties

Object

Mount target properties

Name	Type	Description
fileSystemId	string minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$	UUID v4 used to identify the MountTarget
ipAddress	string	The mount target's IPv4 address
mountTargetId	string minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$	UUID v4 used to identify the MountTarget
smbServerFqdn	string	The SMB server's Fully Qualified Domain Name, FQDN

NetworkFeatures

Enumeration

Network features available to the volume, or current state of update.

Value	Description
Basic	Basic network features.
Standard	Standard network features.
Basic_Standard	Updating from Basic to Standard network features.
Standard_Basic	Updating from Standard to Basic network features.

PlacementKeyValuePairs

Object

Application specific parameters for the placement of volumes in the volume group

Name	Type	Description
key	string	Key for an application specific parameter for the placement of volumes in the volume group
value	string	Value for an application specific parameter for the placement of volumes in the volume group

RemotePath

Object

The full path to a volume that is to be migrated into ANF. Required for Migration volumes

Name	Type	Description
externalHostName	string	The Path to a ONTAP Host
serverName	string	The name of a server on the ONTAP Host
volumeName	string	The name of a volume on the server

ReplicationObject

Object

Replication properties

Name	Type	Description
destinationReplications	DestinationReplication[]	A list of destination replications
endpointType	EndpointType	Indicates whether the local volume is the source or destination for the Volume Replication
remotePath	RemotePath	The full path to a volume that is to be migrated into ANF. Required for Migration volumes
remoteVolumeRegion	string	The remote region for the other end of the Volume Replication.
remoteVolumeResourceId	string	The resource ID of the remote volume. Required for cross region and cross zone replication
replicationId	string	Id
replicationSchedule	ReplicationSchedule	Schedule

ReplicationSchedule

Enumeration

Schedule

Value	Description
_10minutely
hourly
daily

ReplicationType

Enumeration

Indicates whether the replication is cross zone or cross region.

Value	Description
CrossRegionReplication	Cross region replication
CrossZoneReplication	Cross zone replication

SecurityStyle

Enumeration

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol

Value	Description
ntfs
unix

ServiceLevel

Enumeration

The service level of the file system

Value	Description
Standard	Standard service level
Premium	Premium service level
Ultra	Ultra service level
StandardZRS	Zone redundant storage service level. This will be deprecated soon.
Flexible	Flexible service level

SmbAccessBasedEnumeration

Enumeration

Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume

Value	Description
Disabled	smbAccessBasedEnumeration share setting is disabled
Enabled	smbAccessBasedEnumeration share setting is enabled

SmbNonBrowsable

Enumeration

Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume

Value	Description
Disabled	smbNonBrowsable share setting is disabled
Enabled	smbNonBrowsable share setting is enabled

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Volume

Object

Volume resource

Name	Type	Default value	Description
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.")
id	string (arm-id)		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.acceptGrowCapacityPoolForShortTermCloneSplit	AcceptGrowCapacityPoolForShortTermCloneSplit		While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.
properties.actualThroughputMibps	number (float)		Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel
properties.avsDataStore	AvsDataStore	Disabled	Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
properties.backupId	string (arm-id)		Resource identifier used to identify the Backup.
properties.baremetalTenantId	string		Unique Baremetal Tenant Identifier.
properties.capacityPoolResourceId	string		Pool Resource Id used in case of creating a volume through volume group
properties.cloneProgress	integer (int32)		When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.
properties.coolAccess	boolean	False	Specifies whether Cool Access(tiering) is enabled for the volume.
properties.coolAccessRetrievalPolicy	CoolAccessRetrievalPolicy		coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. Never - No client-driven data is pulled from cool tier to standard storage.
properties.coolAccessTieringPolicy	CoolAccessTieringPolicy		coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier.
properties.coolnessPeriod	integer (int32) minimum: 2 maximum: 183		Specifies the number of days after which data that is not accessed by clients will be tiered.
properties.creationToken	string minLength: 1 maxLength: 80 pattern: ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$		A unique file path for the volume. Used when creating mount targets
properties.dataProtection	VolumePropertiesDataProtection		DataProtection type volumes include an object containing details of the replication
properties.dataStoreResourceId	string[]		Data store resource unique identifier
properties.defaultGroupQuotaInKiBs	integer (int64)	0	Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
properties.defaultUserQuotaInKiBs	integer (int64)	0	Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
properties.deleteBaseSnapshot	boolean		If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
properties.effectiveNetworkFeatures	NetworkFeatures	Basic	The effective value of the network features type available to the volume, or current effective state of update.
properties.enableSubvolumes	EnableSubvolumes	Disabled	Flag indicating whether subvolume operations are enabled on the volume
properties.encrypted	boolean		Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.
properties.encryptionKeySource	EncryptionKeySource	Microsoft.NetApp	Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
properties.exportPolicy	VolumePropertiesExportPolicy		Set of export policy rules
properties.fileAccessLogs	FileAccessLogs	Disabled	Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
properties.fileSystemId	string minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$		Unique FileSystem Identifier.
properties.inheritedSizeInBytes	integer (int64)		Space shared by short term clone volume with parent volume in bytes.
properties.isDefaultQuotaEnabled	boolean	False	Specifies if default quota is enabled for the volume.
properties.isLargeVolume	boolean	False	Specifies whether volume is a Large Volume or Regular Volume.
properties.isRestoring	boolean		Restoring
properties.kerberosEnabled	boolean	False	Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
properties.keyVaultPrivateEndpointResourceId	string		The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
properties.ldapEnabled	boolean	False	Specifies whether LDAP is enabled or not for a given NFS volume.
properties.maximumNumberOfFiles	integer (int64)		Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.
properties.mountTargets	MountTargetProperties[]		List of mount targets
properties.networkFeatures	NetworkFeatures	Basic	The original value of the network features type available to the volume at the time it was created.
properties.networkSiblingSetId	string minLength: 36 maxLength: 36 pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$		Network Sibling Set ID for the the group of volumes sharing networking resources.
properties.originatingResourceId	string		Id of the snapshot or backup that the volume is restored from.
properties.placementRules	PlacementKeyValuePairs[]		Application specific placement rules for the particular volume
properties.protocolTypes	string[]		Set of protocol types, default NFSv3, CIFS for SMB protocol
properties.provisionedAvailabilityZone	string		The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.
properties.provisioningState	string		Azure lifecycle management
properties.proximityPlacementGroup	string		Proximity placement group associated with the volume
properties.securityStyle	SecurityStyle	unix	The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
properties.serviceLevel	ServiceLevel	Premium	The service level of the file system
properties.smbAccessBasedEnumeration	SmbAccessBasedEnumeration		Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
properties.smbContinuouslyAvailable	boolean	False	Enables continuously available share property for smb volume. Only applicable for SMB volume
properties.smbEncryption	boolean	False	Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later
properties.smbNonBrowsable	SmbNonBrowsable		Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
properties.snapshotDirectoryVisible	boolean	True	If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
properties.snapshotId	string (arm-id)		Resource identifier used to identify the Snapshot.
properties.storageToNetworkProximity	VolumeStorageToNetworkProximity		Provides storage to network proximity information for the volume.
properties.subnetId	string		The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
properties.t2Network	string		T2 network information
properties.throughputMibps	number (float)		Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume
properties.unixPermissions	string minLength: 4 maxLength: 4		UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.
properties.usageThreshold	integer (int64) minimum: 53687091200 maximum: 2638827906662400	0	Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.
properties.volumeGroupName	string		Volume Group Name
properties.volumeSpecName	string		Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log
properties.volumeType	string		What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone
systemData	systemData		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	string[]		The availability zones.

VolumeBackupProperties

Object

Volume Backup Properties

Name	Type	Description
backupPolicyId	string (arm-id)	Backup Policy Resource ID
backupVaultId	string (arm-id)	Backup Vault Resource ID
policyEnforced	boolean	Policy Enforced

VolumeList

Object

List of volume resources

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	Volume[]	The Volume items on this page

VolumePropertiesDataProtection

Object

DataProtection type volumes include an object containing details of the replication

Name	Type	Description
backup	VolumeBackupProperties	Backup Properties
replication	ReplicationObject	Replication properties
snapshot	VolumeSnapshotProperties	Snapshot properties.
volumeRelocation	VolumeRelocationProperties	VolumeRelocation properties

VolumePropertiesExportPolicy

Object

Set of export policy rules

Name	Type	Description
rules	ExportPolicyRule[]	Export policy rule

VolumeRelocationProperties

Object

Volume relocation properties

Name	Type	Description
readyToBeFinalized	boolean	Has relocation finished and is ready to be cleaned up
relocationRequested	boolean	Has relocation been requested for this volume

VolumeSnapshotProperties

Object

Volume Snapshot Properties

Name	Type	Description
snapshotPolicyId	string	Snapshot Policy ResourceId

VolumeStorageToNetworkProximity

Enumeration

Provides storage to network proximity information for the volume.

Value	Description
Default	Basic storage to network connectivity.
T1	Standard T1 storage to network connectivity.
T2	Standard T2 storage to network connectivity.
AcrossT2	Standard AcrossT2 storage to network connectivity.