Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The netAppAccounts/capacityPools/caches resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetApp/netAppAccounts/capacityPools/caches resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools/caches@2025-09-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
cacheSubnetResourceId: 'string'
cifsChangeNotifications: 'string'
encryptionKeySource: 'string'
exportPolicy: [
{
allowedClients: 'string'
chownMode: 'string'
cifs: bool
hasRootAccess: bool
kerberos5iReadOnly: bool
kerberos5iReadWrite: bool
kerberos5pReadOnly: bool
kerberos5pReadWrite: bool
kerberos5ReadOnly: bool
kerberos5ReadWrite: bool
nfsv3: bool
nfsv41: bool
ruleIndex: int
unixReadOnly: bool
unixReadWrite: bool
}
]
filepath: 'string'
globalFileLocking: 'string'
kerberos: 'string'
keyVaultPrivateEndpointResourceId: 'string'
ldap: 'string'
ldapServerType: 'string'
originClusterInformation: {
peerAddresses: [
'string'
]
peerClusterName: 'string'
peerVolumeName: 'string'
peerVserverName: 'string'
}
peeringSubnetResourceId: 'string'
protocolTypes: [
'string'
]
size: int
smbSettings: {
smbAccessBasedEnumerations: 'string'
smbEncryption: 'string'
smbNonBrowsable: 'string'
}
throughputMibps: int
writeBack: 'string'
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Property Values
Microsoft.NetApp/netAppAccounts/capacityPools/caches
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 Pattern = ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$ (required) |
| 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: netAppAccounts/capacityPools |
| properties | Cache properties | CacheProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| zones | The availability zones. | string[] |
CacheProperties
| Name | Description | Value |
|---|---|---|
| cacheSubnetResourceId | The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. | string (required) |
| cifsChangeNotifications | Flag indicating whether a CIFS change notification is enabled for the cache. | 'Disabled' 'Enabled' |
| encryptionKeySource | Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' | 'Microsoft.KeyVault' 'Microsoft.NetApp' (required) |
| exportPolicy | Set of export policy rules | ExportPolicyRule[] |
| filepath | The file path of the Cache. | string Constraints: Min length = 1 Max length = 80 Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ (required) |
| globalFileLocking | Flag indicating whether the global file lock is enabled for the cache. | 'Disabled' 'Enabled' |
| kerberos | Describe if a cache is Kerberos enabled. | 'Disabled' 'Enabled' |
| 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 |
| ldap | Specifies whether LDAP is enabled or not for flexcache volume. | 'Disabled' 'Enabled' |
| ldapServerType | Specifies the type of LDAP server for flexcache volume. | 'ActiveDirectory' 'OpenLDAP' |
| originClusterInformation | Origin cluster information | OriginClusterInformation (required) |
| peeringSubnetResourceId | The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. | string (required) |
| protocolTypes | Set of protocol types, default NFSv3, CIFS for SMB protocol | String array containing any of: 'NFSv3' 'NFSv4' 'SMB' |
| size | Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. | int Constraints: Min value = 53687091200 Max value = 1125899906842624 (required) |
| smbSettings | SMB information for the cache | SmbSettings |
| throughputMibps | Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache | int |
| writeBack | Flag indicating whether writeback is enabled for the cache. | 'Disabled' 'Enabled' |
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 |
| kerberos5iReadOnly | Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later | bool |
| kerberos5iReadWrite | Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later | bool |
| kerberos5pReadOnly | Kerberos5p Read only 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 |
| kerberos5ReadOnly | Kerberos5 Read only 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 |
| unixReadOnly | Read only access | bool |
| unixReadWrite | Read and write access | bool |
OriginClusterInformation
| Name | Description | Value |
|---|---|---|
| peerAddresses | ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required | string[] (required) |
| peerClusterName | ONTAP cluster name of external cluster hosting the origin volume | string (required) |
| peerVolumeName | External origin volume name associated to this cache | string (required) |
| peerVserverName | External Vserver (SVM) name name of the SVM hosting the origin volume | string (required) |
SmbSettings
| Name | Description | Value |
|---|---|---|
| smbAccessBasedEnumerations | Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume | 'Disabled' 'Enabled' |
| smbEncryption | Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. | 'Disabled' 'Enabled' |
| smbNonBrowsable | Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume | 'Disabled' 'Enabled' |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The netAppAccounts/capacityPools/caches resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetApp/netAppAccounts/capacityPools/caches resource, add the following JSON to your template.
{
"type": "Microsoft.NetApp/netAppAccounts/capacityPools/caches",
"apiVersion": "2025-09-01-preview",
"name": "string",
"location": "string",
"properties": {
"cacheSubnetResourceId": "string",
"cifsChangeNotifications": "string",
"encryptionKeySource": "string",
"exportPolicy": [
{
"allowedClients": "string",
"chownMode": "string",
"cifs": "bool",
"hasRootAccess": "bool",
"kerberos5iReadOnly": "bool",
"kerberos5iReadWrite": "bool",
"kerberos5pReadOnly": "bool",
"kerberos5pReadWrite": "bool",
"kerberos5ReadOnly": "bool",
"kerberos5ReadWrite": "bool",
"nfsv3": "bool",
"nfsv41": "bool",
"ruleIndex": "int",
"unixReadOnly": "bool",
"unixReadWrite": "bool"
}
],
"filepath": "string",
"globalFileLocking": "string",
"kerberos": "string",
"keyVaultPrivateEndpointResourceId": "string",
"ldap": "string",
"ldapServerType": "string",
"originClusterInformation": {
"peerAddresses": [ "string" ],
"peerClusterName": "string",
"peerVolumeName": "string",
"peerVserverName": "string"
},
"peeringSubnetResourceId": "string",
"protocolTypes": [ "string" ],
"size": "int",
"smbSettings": {
"smbAccessBasedEnumerations": "string",
"smbEncryption": "string",
"smbNonBrowsable": "string"
},
"throughputMibps": "int",
"writeBack": "string"
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Property Values
Microsoft.NetApp/netAppAccounts/capacityPools/caches
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-09-01-preview' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 Pattern = ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$ (required) |
| properties | Cache properties | CacheProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.NetApp/netAppAccounts/capacityPools/caches' |
| zones | The availability zones. | string[] |
CacheProperties
| Name | Description | Value |
|---|---|---|
| cacheSubnetResourceId | The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. | string (required) |
| cifsChangeNotifications | Flag indicating whether a CIFS change notification is enabled for the cache. | 'Disabled' 'Enabled' |
| encryptionKeySource | Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' | 'Microsoft.KeyVault' 'Microsoft.NetApp' (required) |
| exportPolicy | Set of export policy rules | ExportPolicyRule[] |
| filepath | The file path of the Cache. | string Constraints: Min length = 1 Max length = 80 Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ (required) |
| globalFileLocking | Flag indicating whether the global file lock is enabled for the cache. | 'Disabled' 'Enabled' |
| kerberos | Describe if a cache is Kerberos enabled. | 'Disabled' 'Enabled' |
| 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 |
| ldap | Specifies whether LDAP is enabled or not for flexcache volume. | 'Disabled' 'Enabled' |
| ldapServerType | Specifies the type of LDAP server for flexcache volume. | 'ActiveDirectory' 'OpenLDAP' |
| originClusterInformation | Origin cluster information | OriginClusterInformation (required) |
| peeringSubnetResourceId | The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. | string (required) |
| protocolTypes | Set of protocol types, default NFSv3, CIFS for SMB protocol | String array containing any of: 'NFSv3' 'NFSv4' 'SMB' |
| size | Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. | int Constraints: Min value = 53687091200 Max value = 1125899906842624 (required) |
| smbSettings | SMB information for the cache | SmbSettings |
| throughputMibps | Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache | int |
| writeBack | Flag indicating whether writeback is enabled for the cache. | 'Disabled' 'Enabled' |
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 |
| kerberos5iReadOnly | Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later | bool |
| kerberos5iReadWrite | Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later | bool |
| kerberos5pReadOnly | Kerberos5p Read only 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 |
| kerberos5ReadOnly | Kerberos5 Read only 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 |
| unixReadOnly | Read only access | bool |
| unixReadWrite | Read and write access | bool |
OriginClusterInformation
| Name | Description | Value |
|---|---|---|
| peerAddresses | ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required | string[] (required) |
| peerClusterName | ONTAP cluster name of external cluster hosting the origin volume | string (required) |
| peerVolumeName | External origin volume name associated to this cache | string (required) |
| peerVserverName | External Vserver (SVM) name name of the SVM hosting the origin volume | string (required) |
SmbSettings
| Name | Description | Value |
|---|---|---|
| smbAccessBasedEnumerations | Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume | 'Disabled' 'Enabled' |
| smbEncryption | Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. | 'Disabled' 'Enabled' |
| smbNonBrowsable | Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume | 'Disabled' 'Enabled' |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The netAppAccounts/capacityPools/caches resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.NetApp/netAppAccounts/capacityPools/caches resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetApp/netAppAccounts/capacityPools/caches@2025-09-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
cacheSubnetResourceId = "string"
cifsChangeNotifications = "string"
encryptionKeySource = "string"
exportPolicy = [
{
allowedClients = "string"
chownMode = "string"
cifs = bool
hasRootAccess = bool
kerberos5iReadOnly = bool
kerberos5iReadWrite = bool
kerberos5pReadOnly = bool
kerberos5pReadWrite = bool
kerberos5ReadOnly = bool
kerberos5ReadWrite = bool
nfsv3 = bool
nfsv41 = bool
ruleIndex = int
unixReadOnly = bool
unixReadWrite = bool
}
]
filepath = "string"
globalFileLocking = "string"
kerberos = "string"
keyVaultPrivateEndpointResourceId = "string"
ldap = "string"
ldapServerType = "string"
originClusterInformation = {
peerAddresses = [
"string"
]
peerClusterName = "string"
peerVolumeName = "string"
peerVserverName = "string"
}
peeringSubnetResourceId = "string"
protocolTypes = [
"string"
]
size = int
smbSettings = {
smbAccessBasedEnumerations = "string"
smbEncryption = "string"
smbNonBrowsable = "string"
}
throughputMibps = int
writeBack = "string"
}
zones = [
"string"
]
}
}
Property Values
Microsoft.NetApp/netAppAccounts/capacityPools/caches
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 3 Max length = 64 Pattern = ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$ (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: netAppAccounts/capacityPools |
| properties | Cache properties | CacheProperties (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.NetApp/netAppAccounts/capacityPools/caches@2025-09-01-preview" |
| zones | The availability zones. | string[] |
CacheProperties
| Name | Description | Value |
|---|---|---|
| cacheSubnetResourceId | The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. | string (required) |
| cifsChangeNotifications | Flag indicating whether a CIFS change notification is enabled for the cache. | 'Disabled' 'Enabled' |
| encryptionKeySource | Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' | 'Microsoft.KeyVault' 'Microsoft.NetApp' (required) |
| exportPolicy | Set of export policy rules | ExportPolicyRule[] |
| filepath | The file path of the Cache. | string Constraints: Min length = 1 Max length = 80 Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ (required) |
| globalFileLocking | Flag indicating whether the global file lock is enabled for the cache. | 'Disabled' 'Enabled' |
| kerberos | Describe if a cache is Kerberos enabled. | 'Disabled' 'Enabled' |
| 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 |
| ldap | Specifies whether LDAP is enabled or not for flexcache volume. | 'Disabled' 'Enabled' |
| ldapServerType | Specifies the type of LDAP server for flexcache volume. | 'ActiveDirectory' 'OpenLDAP' |
| originClusterInformation | Origin cluster information | OriginClusterInformation (required) |
| peeringSubnetResourceId | The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. | string (required) |
| protocolTypes | Set of protocol types, default NFSv3, CIFS for SMB protocol | String array containing any of: 'NFSv3' 'NFSv4' 'SMB' |
| size | Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. | int Constraints: Min value = 53687091200 Max value = 1125899906842624 (required) |
| smbSettings | SMB information for the cache | SmbSettings |
| throughputMibps | Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache | int |
| writeBack | Flag indicating whether writeback is enabled for the cache. | 'Disabled' 'Enabled' |
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 |
| kerberos5iReadOnly | Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later | bool |
| kerberos5iReadWrite | Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later | bool |
| kerberos5pReadOnly | Kerberos5p Read only 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 |
| kerberos5ReadOnly | Kerberos5 Read only 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 |
| unixReadOnly | Read only access | bool |
| unixReadWrite | Read and write access | bool |
OriginClusterInformation
| Name | Description | Value |
|---|---|---|
| peerAddresses | ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required | string[] (required) |
| peerClusterName | ONTAP cluster name of external cluster hosting the origin volume | string (required) |
| peerVolumeName | External origin volume name associated to this cache | string (required) |
| peerVserverName | External Vserver (SVM) name name of the SVM hosting the origin volume | string (required) |
SmbSettings
| Name | Description | Value |
|---|---|---|
| smbAccessBasedEnumerations | Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume | 'Disabled' 'Enabled' |
| smbEncryption | Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. | 'Disabled' 'Enabled' |
| smbNonBrowsable | Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume | 'Disabled' 'Enabled' |
TrackedResourceTags
| Name | Description | Value |
|---|