Microsoft.NetApp netAppAccounts/capacityPools/volumes 2023-11-01-preview

Article
08/01/2024

Bicep resource definition

The netAppAccounts/capacityPools/volumes resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NetApp/netAppAccounts/capacityPools/volumes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2023-11-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    acceptGrowCapacityPoolForShortTermCloneSplit: 'string'
    avsDataStore: 'string'
    backupId: 'string'
    capacityPoolResourceId: 'string'
    coolAccess: bool
    coolAccessRetrievalPolicy: 'string'
    coolnessPeriod: int
    creationToken: 'string'
    dataProtection: {
      backup: {
        backupPolicyId: 'string'
        backupVaultId: 'string'
        policyEnforced: bool
      }
      replication: {
        endpointType: 'string'
        remotePath: {
          externalHostName: 'string'
          serverName: 'string'
          volumeName: 'string'
        }
        remoteVolumeRegion: 'string'
        remoteVolumeResourceId: 'string'
        replicationSchedule: 'string'
      }
      snapshot: {
        snapshotPolicyId: 'string'
      }
      volumeRelocation: {
        relocationRequested: bool
      }
    }
    defaultGroupQuotaInKiBs: int
    defaultUserQuotaInKiBs: int
    deleteBaseSnapshot: bool
    enableSubvolumes: 'string'
    encryptionKeySource: 'string'
    exportPolicy: {
      rules: [
        {
          allowedClients: 'string'
          chownMode: 'string'
          cifs: bool
          hasRootAccess: bool
          kerberos5iReadWrite: bool
          kerberos5pReadWrite: bool
          kerberos5ReadWrite: bool
          nfsv3: bool
          nfsv41: bool
          ruleIndex: int
          unixReadWrite: bool
        }
      ]
    }
    isDefaultQuotaEnabled: bool
    isLargeVolume: bool
    isRestoring: bool
    kerberosEnabled: bool
    keyVaultPrivateEndpointResourceId: 'string'
    language: 'string'
    ldapEnabled: bool
    networkFeatures: 'string'
    placementRules: [
      {
        key: 'string'
        value: 'string'
      }
    ]
    protocolTypes: [
      'string'
    ]
    proximityPlacementGroup: 'string'
    securityStyle: 'string'
    serviceLevel: 'string'
    smbAccessBasedEnumeration: 'string'
    smbContinuouslyAvailable: bool
    smbEncryption: bool
    smbNonBrowsable: 'string'
    snapshotDirectoryVisible: bool
    snapshotId: 'string'
    subnetId: 'string'
    throughputMibps: int
    unixPermissions: 'string'
    usageThreshold: int
    volumeSpecName: 'string'
    volumeType: 'string'
  }
  zones: [
    'string'
  ]
}

Property values

netAppAccounts/capacityPools/volumes

Name	Description	Value
name	The resource name See how to set names and types for child resources in Bicep.	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: capacityPools
properties	Volume properties	VolumeProperties (required)
zones	Availability Zone	string[] Constraints: Min length = 1 Max length = 255

VolumeProperties

Name	Description	Value
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.	'Accepted' 'Declined'
avsDataStore	Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose	'Disabled' 'Enabled'
backupId	Resource identifier used to identify the Backup.	string
capacityPoolResourceId	Pool Resource Id used in case of creating a volume through volume group	string
coolAccess	Specifies whether Cool Access(tiering) is enabled for the volume.	bool
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.	'Default' 'Never' 'OnRead'
coolnessPeriod	Specifies the number of days after which data that is not accessed by clients will be tiered.	int Constraints: Min value = 2 Max value = 183
creationToken	A unique file path for the volume. Used when creating mount targets	string (required) Constraints: Min length = 1 Max length = 80 Pattern = `^[a-zA-Z][a-zA-Z0-9\-]{0,79}$`
dataProtection	DataProtection type volumes include an object containing details of the replication	VolumePropertiesDataProtection
defaultGroupQuotaInKiBs	Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.	int
defaultUserQuotaInKiBs	Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .	int
deleteBaseSnapshot	If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false	bool
enableSubvolumes	Flag indicating whether subvolume operations are enabled on the volume	'Disabled' 'Enabled'
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'	'Microsoft.KeyVault' 'Microsoft.NetApp'
exportPolicy	Set of export policy rules	VolumePropertiesExportPolicy
isDefaultQuotaEnabled	Specifies if default quota is enabled for the volume.	bool
isLargeVolume	Specifies whether volume is a Large Volume or Regular Volume.	bool
isRestoring	Restoring	bool
kerberosEnabled	Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later	bool
keyVaultPrivateEndpointResourceId	The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.	string
language	Language supported for volume.	'ar' 'ar.utf-8' 'c' 'c.utf-8' 'cs' 'cs.utf-8' 'da' 'da.utf-8' 'de' 'de.utf-8' 'en' 'en-us' 'en-us.utf-8' 'en.utf-8' 'es' 'es.utf-8' 'fi' 'fi.utf-8' 'fr' 'fr.utf-8' 'he' 'he.utf-8' 'hr' 'hr.utf-8' 'hu' 'hu.utf-8' 'it' 'it.utf-8' 'ja' 'ja-jp.932' 'ja-jp.932.utf-8' 'ja-jp.pck' 'ja-jp.pck-v2' 'ja-jp.pck-v2.utf-8' 'ja-jp.pck.utf-8' 'ja-v1' 'ja-v1.utf-8' 'ja.utf-8' 'ko' 'ko.utf-8' 'nl' 'nl.utf-8' 'no' 'no.utf-8' 'pl' 'pl.utf-8' 'pt' 'pt.utf-8' 'ro' 'ro.utf-8' 'ru' 'ru.utf-8' 'sk' 'sk.utf-8' 'sl' 'sl.utf-8' 'sv' 'sv.utf-8' 'tr' 'tr.utf-8' 'utf8mb4' 'zh' 'zh-tw' 'zh-tw.big5' 'zh-tw.big5.utf-8' 'zh-tw.utf-8' 'zh.gbk' 'zh.gbk.utf-8' 'zh.utf-8'
ldapEnabled	Specifies whether LDAP is enabled or not for a given NFS volume.	bool
networkFeatures	Network features available to the volume, or current state of update.	'Basic' 'Basic_Standard' 'Standard' 'Standard_Basic'
placementRules	Application specific placement rules for the particular volume	PlacementKeyValuePairs[]
protocolTypes	Set of protocol types, default NFSv3, CIFS for SMB protocol	string[]
proximityPlacementGroup	Proximity placement group associated with the volume	string
securityStyle	The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol	'ntfs' 'unix'
serviceLevel	The service level of the file system	'Premium' 'Standard' 'StandardZRS' 'Ultra'
smbAccessBasedEnumeration	Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume	'Disabled' 'Enabled'
smbContinuouslyAvailable	Enables continuously available share property for smb volume. Only applicable for SMB volume	bool
smbEncryption	Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later	bool
smbNonBrowsable	Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume	'Disabled' 'Enabled'
snapshotDirectoryVisible	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).	bool
snapshotId	Resource identifier used to identify the Snapshot.	string
subnetId	The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes	string (required)
throughputMibps	Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume	int
unixPermissions	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.	string Constraints: Min length = 4 Max length = 4
usageThreshold	Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.	int (required) Constraints: Min value = 107374182400 Max value = 2638827906662400
volumeSpecName	Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log	string
volumeType	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	string

VolumePropertiesDataProtection

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

VolumeBackupProperties

Name	Description	Value
backupPolicyId	Backup Policy Resource ID	string
backupVaultId	Backup Vault Resource ID	string
policyEnforced	Policy Enforced	bool

ReplicationObject

Name	Description	Value
endpointType	Indicates whether the local volume is the source or destination for the Volume Replication	'dst' 'src'
remotePath	The full path to a volume that is to be migrated into ANF. Required for Migration volumes	RemotePath
remoteVolumeRegion	The remote region for the other end of the Volume Replication.	string
remoteVolumeResourceId	The resource ID of the remote volume. Required for cross region and cross zone replication	string (required)
replicationSchedule	Schedule	'_10minutely' 'daily' 'hourly'

RemotePath

Name	Description	Value
externalHostName	The Path to a ONTAP Host	string (required)
serverName	The name of a server on the ONTAP Host	string (required)
volumeName	The name of a volume on the server	string (required)

VolumeSnapshotProperties

Name	Description	Value
snapshotPolicyId	Snapshot Policy ResourceId	string

VolumeRelocationProperties

Name	Description	Value
relocationRequested	Has relocation been requested for this volume	bool

VolumePropertiesExportPolicy

Name	Description	Value
rules	Export policy rule	ExportPolicyRule[]

ExportPolicyRule

Name	Description	Value
allowedClients	Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names	string
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.	'Restricted' 'Unrestricted'
cifs	Allows CIFS protocol	bool
hasRootAccess	Has root access to volume	bool
kerberos5iReadWrite	Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later	bool
kerberos5pReadWrite	Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later	bool
kerberos5ReadWrite	Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later	bool
nfsv3	Allows NFSv3 protocol. Enable only for NFSv3 type volumes	bool
nfsv41	Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes	bool
ruleIndex	Order index	int
unixReadWrite	Read and write access	bool

PlacementKeyValuePairs

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create new ANF resource with NFSV3/NFSv4.1 volume	This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with NFSV3 or NFSv4.1 protocol. They are all deployed together with Azure Virtual Network and Delegated subnet that are required for any volume to be created
Create new ANF resource with SMB volume	This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with SMB protocol.

ARM template resource definition

The netAppAccounts/capacityPools/volumes resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NetApp/netAppAccounts/capacityPools/volumes resource, add the following JSON to your template.

{
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
  "apiVersion": "2023-11-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "acceptGrowCapacityPoolForShortTermCloneSplit": "string",
    "avsDataStore": "string",
    "backupId": "string",
    "capacityPoolResourceId": "string",
    "coolAccess": "bool",
    "coolAccessRetrievalPolicy": "string",
    "coolnessPeriod": "int",
    "creationToken": "string",
    "dataProtection": {
      "backup": {
        "backupPolicyId": "string",
        "backupVaultId": "string",
        "policyEnforced": "bool"
      },
      "replication": {
        "endpointType": "string",
        "remotePath": {
          "externalHostName": "string",
          "serverName": "string",
          "volumeName": "string"
        },
        "remoteVolumeRegion": "string",
        "remoteVolumeResourceId": "string",
        "replicationSchedule": "string"
      },
      "snapshot": {
        "snapshotPolicyId": "string"
      },
      "volumeRelocation": {
        "relocationRequested": "bool"
      }
    },
    "defaultGroupQuotaInKiBs": "int",
    "defaultUserQuotaInKiBs": "int",
    "deleteBaseSnapshot": "bool",
    "enableSubvolumes": "string",
    "encryptionKeySource": "string",
    "exportPolicy": {
      "rules": [
        {
          "allowedClients": "string",
          "chownMode": "string",
          "cifs": "bool",
          "hasRootAccess": "bool",
          "kerberos5iReadWrite": "bool",
          "kerberos5pReadWrite": "bool",
          "kerberos5ReadWrite": "bool",
          "nfsv3": "bool",
          "nfsv41": "bool",
          "ruleIndex": "int",
          "unixReadWrite": "bool"
        }
      ]
    },
    "isDefaultQuotaEnabled": "bool",
    "isLargeVolume": "bool",
    "isRestoring": "bool",
    "kerberosEnabled": "bool",
    "keyVaultPrivateEndpointResourceId": "string",
    "language": "string",
    "ldapEnabled": "bool",
    "networkFeatures": "string",
    "placementRules": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "protocolTypes": [ "string" ],
    "proximityPlacementGroup": "string",
    "securityStyle": "string",
    "serviceLevel": "string",
    "smbAccessBasedEnumeration": "string",
    "smbContinuouslyAvailable": "bool",
    "smbEncryption": "bool",
    "smbNonBrowsable": "string",
    "snapshotDirectoryVisible": "bool",
    "snapshotId": "string",
    "subnetId": "string",
    "throughputMibps": "int",
    "unixPermissions": "string",
    "usageThreshold": "int",
    "volumeSpecName": "string",
    "volumeType": "string"
  },
  "zones": [ "string" ]
}

Property values

netAppAccounts/capacityPools/volumes

Name	Description	Value
type	The resource type	'Microsoft.NetApp/netAppAccounts/capacityPools/volumes'
apiVersion	The resource api version	'2023-11-01-preview'
name	The resource name See how to set names and types for child resources in JSON ARM templates.	string (required)
location	The geo-location where the resource lives	string (required)
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
properties	Volume properties	VolumeProperties (required)
zones	Availability Zone	string[] Constraints: Min length = 1 Max length = 255

VolumeProperties

Name	Description	Value
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.	'Accepted' 'Declined'
avsDataStore	Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose	'Disabled' 'Enabled'
backupId	Resource identifier used to identify the Backup.	string
capacityPoolResourceId	Pool Resource Id used in case of creating a volume through volume group	string
coolAccess	Specifies whether Cool Access(tiering) is enabled for the volume.	bool
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.	'Default' 'Never' 'OnRead'
coolnessPeriod	Specifies the number of days after which data that is not accessed by clients will be tiered.	int Constraints: Min value = 2 Max value = 183
creationToken	A unique file path for the volume. Used when creating mount targets	string (required) Constraints: Min length = 1 Max length = 80 Pattern = `^[a-zA-Z][a-zA-Z0-9\-]{0,79}$`
dataProtection	DataProtection type volumes include an object containing details of the replication	VolumePropertiesDataProtection
defaultGroupQuotaInKiBs	Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.	int
defaultUserQuotaInKiBs	Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .	int
deleteBaseSnapshot	If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false	bool
enableSubvolumes	Flag indicating whether subvolume operations are enabled on the volume	'Disabled' 'Enabled'
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'	'Microsoft.KeyVault' 'Microsoft.NetApp'
exportPolicy	Set of export policy rules	VolumePropertiesExportPolicy
isDefaultQuotaEnabled	Specifies if default quota is enabled for the volume.	bool
isLargeVolume	Specifies whether volume is a Large Volume or Regular Volume.	bool
isRestoring	Restoring	bool
kerberosEnabled	Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later	bool
keyVaultPrivateEndpointResourceId	The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.	string
language	Language supported for volume.	'ar' 'ar.utf-8' 'c' 'c.utf-8' 'cs' 'cs.utf-8' 'da' 'da.utf-8' 'de' 'de.utf-8' 'en' 'en-us' 'en-us.utf-8' 'en.utf-8' 'es' 'es.utf-8' 'fi' 'fi.utf-8' 'fr' 'fr.utf-8' 'he' 'he.utf-8' 'hr' 'hr.utf-8' 'hu' 'hu.utf-8' 'it' 'it.utf-8' 'ja' 'ja-jp.932' 'ja-jp.932.utf-8' 'ja-jp.pck' 'ja-jp.pck-v2' 'ja-jp.pck-v2.utf-8' 'ja-jp.pck.utf-8' 'ja-v1' 'ja-v1.utf-8' 'ja.utf-8' 'ko' 'ko.utf-8' 'nl' 'nl.utf-8' 'no' 'no.utf-8' 'pl' 'pl.utf-8' 'pt' 'pt.utf-8' 'ro' 'ro.utf-8' 'ru' 'ru.utf-8' 'sk' 'sk.utf-8' 'sl' 'sl.utf-8' 'sv' 'sv.utf-8' 'tr' 'tr.utf-8' 'utf8mb4' 'zh' 'zh-tw' 'zh-tw.big5' 'zh-tw.big5.utf-8' 'zh-tw.utf-8' 'zh.gbk' 'zh.gbk.utf-8' 'zh.utf-8'
ldapEnabled	Specifies whether LDAP is enabled or not for a given NFS volume.	bool
networkFeatures	Network features available to the volume, or current state of update.	'Basic' 'Basic_Standard' 'Standard' 'Standard_Basic'
placementRules	Application specific placement rules for the particular volume	PlacementKeyValuePairs[]
protocolTypes	Set of protocol types, default NFSv3, CIFS for SMB protocol	string[]
proximityPlacementGroup	Proximity placement group associated with the volume	string
securityStyle	The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol	'ntfs' 'unix'
serviceLevel	The service level of the file system	'Premium' 'Standard' 'StandardZRS' 'Ultra'
smbAccessBasedEnumeration	Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume	'Disabled' 'Enabled'
smbContinuouslyAvailable	Enables continuously available share property for smb volume. Only applicable for SMB volume	bool
smbEncryption	Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later	bool
smbNonBrowsable	Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume	'Disabled' 'Enabled'
snapshotDirectoryVisible	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).	bool
snapshotId	Resource identifier used to identify the Snapshot.	string
subnetId	The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes	string (required)
throughputMibps	Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume	int
unixPermissions	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.	string Constraints: Min length = 4 Max length = 4
usageThreshold	Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.	int (required) Constraints: Min value = 107374182400 Max value = 2638827906662400
volumeSpecName	Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log	string
volumeType	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	string

VolumePropertiesDataProtection

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

VolumeBackupProperties

Name	Description	Value
backupPolicyId	Backup Policy Resource ID	string
backupVaultId	Backup Vault Resource ID	string
policyEnforced	Policy Enforced	bool

ReplicationObject

Name	Description	Value
endpointType	Indicates whether the local volume is the source or destination for the Volume Replication	'dst' 'src'
remotePath	The full path to a volume that is to be migrated into ANF. Required for Migration volumes	RemotePath
remoteVolumeRegion	The remote region for the other end of the Volume Replication.	string
remoteVolumeResourceId	The resource ID of the remote volume. Required for cross region and cross zone replication	string (required)
replicationSchedule	Schedule	'_10minutely' 'daily' 'hourly'

RemotePath

Name	Description	Value
externalHostName	The Path to a ONTAP Host	string (required)
serverName	The name of a server on the ONTAP Host	string (required)
volumeName	The name of a volume on the server	string (required)

VolumeSnapshotProperties

Name	Description	Value
snapshotPolicyId	Snapshot Policy ResourceId	string

VolumeRelocationProperties

Name	Description	Value
relocationRequested	Has relocation been requested for this volume	bool

VolumePropertiesExportPolicy

Name	Description	Value
rules	Export policy rule	ExportPolicyRule[]

ExportPolicyRule

Name	Description	Value
allowedClients	Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names	string
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.	'Restricted' 'Unrestricted'
cifs	Allows CIFS protocol	bool
hasRootAccess	Has root access to volume	bool
kerberos5iReadWrite	Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later	bool
kerberos5pReadWrite	Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later	bool
kerberos5ReadWrite	Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later	bool
nfsv3	Allows NFSv3 protocol. Enable only for NFSv3 type volumes	bool
nfsv41	Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes	bool
ruleIndex	Order index	int
unixReadWrite	Read and write access	bool

PlacementKeyValuePairs

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create new ANF resource with NFSV3/NFSv4.1 volume	This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with NFSV3 or NFSv4.1 protocol. They are all deployed together with Azure Virtual Network and Delegated subnet that are required for any volume to be created
Create new ANF resource with SMB volume	This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with SMB protocol.

Terraform (AzAPI provider) resource definition

The netAppAccounts/capacityPools/volumes resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.NetApp/netAppAccounts/capacityPools/volumes resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2023-11-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      acceptGrowCapacityPoolForShortTermCloneSplit = "string"
      avsDataStore = "string"
      backupId = "string"
      capacityPoolResourceId = "string"
      coolAccess = bool
      coolAccessRetrievalPolicy = "string"
      coolnessPeriod = int
      creationToken = "string"
      dataProtection = {
        backup = {
          backupPolicyId = "string"
          backupVaultId = "string"
          policyEnforced = bool
        }
        replication = {
          endpointType = "string"
          remotePath = {
            externalHostName = "string"
            serverName = "string"
            volumeName = "string"
          }
          remoteVolumeRegion = "string"
          remoteVolumeResourceId = "string"
          replicationSchedule = "string"
        }
        snapshot = {
          snapshotPolicyId = "string"
        }
        volumeRelocation = {
          relocationRequested = bool
        }
      }
      defaultGroupQuotaInKiBs = int
      defaultUserQuotaInKiBs = int
      deleteBaseSnapshot = bool
      enableSubvolumes = "string"
      encryptionKeySource = "string"
      exportPolicy = {
        rules = [
          {
            allowedClients = "string"
            chownMode = "string"
            cifs = bool
            hasRootAccess = bool
            kerberos5iReadWrite = bool
            kerberos5pReadWrite = bool
            kerberos5ReadWrite = bool
            nfsv3 = bool
            nfsv41 = bool
            ruleIndex = int
            unixReadWrite = bool
          }
        ]
      }
      isDefaultQuotaEnabled = bool
      isLargeVolume = bool
      isRestoring = bool
      kerberosEnabled = bool
      keyVaultPrivateEndpointResourceId = "string"
      language = "string"
      ldapEnabled = bool
      networkFeatures = "string"
      placementRules = [
        {
          key = "string"
          value = "string"
        }
      ]
      protocolTypes = [
        "string"
      ]
      proximityPlacementGroup = "string"
      securityStyle = "string"
      serviceLevel = "string"
      smbAccessBasedEnumeration = "string"
      smbContinuouslyAvailable = bool
      smbEncryption = bool
      smbNonBrowsable = "string"
      snapshotDirectoryVisible = bool
      snapshotId = "string"
      subnetId = "string"
      throughputMibps = int
      unixPermissions = "string"
      usageThreshold = int
      volumeSpecName = "string"
      volumeType = "string"
    }
    zones = [
      "string"
    ]
  })
}

Property values

netAppAccounts/capacityPools/volumes

Name	Description	Value
type	The resource type	"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2023-11-01-preview"
name	The resource name	string (required)
location	The geo-location where the resource lives	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: capacityPools
tags	Resource tags.	Dictionary of tag names and values.
properties	Volume properties	VolumeProperties (required)
zones	Availability Zone	string[] Constraints: Min length = 1 Max length = 255

VolumeProperties

Name	Description	Value
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.	"Accepted" "Declined"
avsDataStore	Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose	"Disabled" "Enabled"
backupId	Resource identifier used to identify the Backup.	string
capacityPoolResourceId	Pool Resource Id used in case of creating a volume through volume group	string
coolAccess	Specifies whether Cool Access(tiering) is enabled for the volume.	bool
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.	"Default" "Never" "OnRead"
coolnessPeriod	Specifies the number of days after which data that is not accessed by clients will be tiered.	int Constraints: Min value = 2 Max value = 183
creationToken	A unique file path for the volume. Used when creating mount targets	string (required) Constraints: Min length = 1 Max length = 80 Pattern = `^[a-zA-Z][a-zA-Z0-9\-]{0,79}$`
dataProtection	DataProtection type volumes include an object containing details of the replication	VolumePropertiesDataProtection
defaultGroupQuotaInKiBs	Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.	int
defaultUserQuotaInKiBs	Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .	int
deleteBaseSnapshot	If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false	bool
enableSubvolumes	Flag indicating whether subvolume operations are enabled on the volume	"Disabled" "Enabled"
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'	"Microsoft.KeyVault" "Microsoft.NetApp"
exportPolicy	Set of export policy rules	VolumePropertiesExportPolicy
isDefaultQuotaEnabled	Specifies if default quota is enabled for the volume.	bool
isLargeVolume	Specifies whether volume is a Large Volume or Regular Volume.	bool
isRestoring	Restoring	bool
kerberosEnabled	Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later	bool
keyVaultPrivateEndpointResourceId	The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.	string
language	Language supported for volume.	"ar" "ar.utf-8" "c" "c.utf-8" "cs" "cs.utf-8" "da" "da.utf-8" "de" "de.utf-8" "en" "en-us" "en-us.utf-8" "en.utf-8" "es" "es.utf-8" "fi" "fi.utf-8" "fr" "fr.utf-8" "he" "he.utf-8" "hr" "hr.utf-8" "hu" "hu.utf-8" "it" "it.utf-8" "ja" "ja-jp.932" "ja-jp.932.utf-8" "ja-jp.pck" "ja-jp.pck-v2" "ja-jp.pck-v2.utf-8" "ja-jp.pck.utf-8" "ja-v1" "ja-v1.utf-8" "ja.utf-8" "ko" "ko.utf-8" "nl" "nl.utf-8" "no" "no.utf-8" "pl" "pl.utf-8" "pt" "pt.utf-8" "ro" "ro.utf-8" "ru" "ru.utf-8" "sk" "sk.utf-8" "sl" "sl.utf-8" "sv" "sv.utf-8" "tr" "tr.utf-8" "utf8mb4" "zh" "zh-tw" "zh-tw.big5" "zh-tw.big5.utf-8" "zh-tw.utf-8" "zh.gbk" "zh.gbk.utf-8" "zh.utf-8"
ldapEnabled	Specifies whether LDAP is enabled or not for a given NFS volume.	bool
networkFeatures	Network features available to the volume, or current state of update.	"Basic" "Basic_Standard" "Standard" "Standard_Basic"
placementRules	Application specific placement rules for the particular volume	PlacementKeyValuePairs[]
protocolTypes	Set of protocol types, default NFSv3, CIFS for SMB protocol	string[]
proximityPlacementGroup	Proximity placement group associated with the volume	string
securityStyle	The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol	"ntfs" "unix"
serviceLevel	The service level of the file system	"Premium" "Standard" "StandardZRS" "Ultra"
smbAccessBasedEnumeration	Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume	"Disabled" "Enabled"
smbContinuouslyAvailable	Enables continuously available share property for smb volume. Only applicable for SMB volume	bool
smbEncryption	Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later	bool
smbNonBrowsable	Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume	"Disabled" "Enabled"
snapshotDirectoryVisible	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).	bool
snapshotId	Resource identifier used to identify the Snapshot.	string
subnetId	The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes	string (required)
throughputMibps	Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume	int
unixPermissions	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.	string Constraints: Min length = 4 Max length = 4
usageThreshold	Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on exceptional basis. Specified in bytes.	int (required) Constraints: Min value = 107374182400 Max value = 2638827906662400
volumeSpecName	Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log	string
volumeType	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	string

VolumePropertiesDataProtection

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

VolumeBackupProperties

Name	Description	Value
backupPolicyId	Backup Policy Resource ID	string
backupVaultId	Backup Vault Resource ID	string
policyEnforced	Policy Enforced	bool

ReplicationObject

Name	Description	Value
endpointType	Indicates whether the local volume is the source or destination for the Volume Replication	"dst" "src"
remotePath	The full path to a volume that is to be migrated into ANF. Required for Migration volumes	RemotePath
remoteVolumeRegion	The remote region for the other end of the Volume Replication.	string
remoteVolumeResourceId	The resource ID of the remote volume. Required for cross region and cross zone replication	string (required)
replicationSchedule	Schedule	"_10minutely" "daily" "hourly"

RemotePath

Name	Description	Value
externalHostName	The Path to a ONTAP Host	string (required)
serverName	The name of a server on the ONTAP Host	string (required)
volumeName	The name of a volume on the server	string (required)

VolumeSnapshotProperties

Name	Description	Value
snapshotPolicyId	Snapshot Policy ResourceId	string

VolumeRelocationProperties

Name	Description	Value
relocationRequested	Has relocation been requested for this volume	bool

VolumePropertiesExportPolicy

Name	Description	Value
rules	Export policy rule	ExportPolicyRule[]

ExportPolicyRule

Name	Description	Value
allowedClients	Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names	string
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.	"Restricted" "Unrestricted"
cifs	Allows CIFS protocol	bool
hasRootAccess	Has root access to volume	bool
kerberos5iReadWrite	Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later	bool
kerberos5pReadWrite	Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later	bool
kerberos5ReadWrite	Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later	bool
nfsv3	Allows NFSv3 protocol. Enable only for NFSv3 type volumes	bool
nfsv41	Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes	bool
ruleIndex	Order index	int
unixReadWrite	Read and write access	bool

PlacementKeyValuePairs

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

Share via

Microsoft.NetApp netAppAccounts/capacityPools/volumes 2023-11-01-preview

Bicep resource definition

Resource format

Property values

netAppAccounts/capacityPools/volumes

VolumeProperties

VolumePropertiesDataProtection

VolumeBackupProperties

ReplicationObject

RemotePath

VolumeSnapshotProperties

VolumeRelocationProperties

VolumePropertiesExportPolicy

ExportPolicyRule

PlacementKeyValuePairs

Quickstart templates

ARM template resource definition

Resource format

Property values

netAppAccounts/capacityPools/volumes

VolumeProperties

VolumePropertiesDataProtection

VolumeBackupProperties

ReplicationObject

RemotePath

VolumeSnapshotProperties

VolumeRelocationProperties

VolumePropertiesExportPolicy

ExportPolicyRule

PlacementKeyValuePairs

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

netAppAccounts/capacityPools/volumes

VolumeProperties

VolumePropertiesDataProtection

VolumeBackupProperties

ReplicationObject

RemotePath

VolumeSnapshotProperties

VolumeRelocationProperties

VolumePropertiesExportPolicy

ExportPolicyRule

PlacementKeyValuePairs

Feedback

Additional resources