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 elasticAccounts/elasticCapacityPools/elasticVolumes 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/elasticAccounts/elasticCapacityPools/elasticVolumes resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.NetApp/elasticAccounts/elasticCapacityPools/elasticVolumes@2025-09-01-preview' = {
parent: resourceSymbolicName
location: 'string'
name: 'string'
properties: {
backupResourceId: 'string'
dataProtection: {
backup: {
elasticBackupPolicyResourceId: 'string'
elasticBackupVaultResourceId: 'string'
policyEnforcement: 'string'
}
snapshot: {
snapshotPolicyResourceId: 'string'
}
}
exportPolicy: {
rules: [
{
allowedClients: [
'string'
]
nfsv3: 'string'
nfsv4: 'string'
rootAccess: 'string'
ruleIndex: int
unixAccessRule: 'string'
}
]
}
filePath: 'string'
protocolTypes: [
'string'
]
size: int
smbProperties: {
smbEncryption: 'string'
}
snapshotDirectoryVisibility: 'string'
snapshotResourceId: 'string'
}
tags: {
{customized property}: 'string'
}
zones: [
'string'
]
}
Property Values
Microsoft.NetApp/elasticAccounts/elasticCapacityPools/elasticVolumes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 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: elasticAccounts/elasticCapacityPools |
| properties | The resource-specific properties for this resource. | ElasticVolumeProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| zones | The availability zones. | string[] |
ElasticExportPolicy
| Name | Description | Value |
|---|---|---|
| rules | Export policy rule | ElasticExportPolicyRule[] |
ElasticExportPolicyRule
| Name | Description | Value |
|---|---|---|
| allowedClients | Client ingress specification for the export policy as list of IPv4 CIDRs, IPv4 host addresses and host names. | string[] |
| nfsv3 | Allows clients to access the volume with the NFSv3 protocol. Enable only for NFSv3 type volumes | 'Disabled' 'Enabled' |
| nfsv4 | Allows clients to access the volume with at least NFSv4.1 protocol. | 'Disabled' 'Enabled' |
| rootAccess | Indicates whether root access to the volume is granted to clients affected by this rule | 'Disabled' 'Enabled' |
| ruleIndex | Controls the priority of the export policy rule. When connecting to the volume the rule with the lowest index that applies to the connecting client is used | int Constraints: Max value = 5 |
| unixAccessRule | Specifies the Unix file access level for the volume. It encompasses both read-only and read-write permissions. Additionally, NoAccess can be set to block all access to the volume | 'NoAccess' 'ReadOnly' 'ReadWrite' |
ElasticSmbProperties
| Name | Description | Value |
|---|---|---|
| smbEncryption | Used to enable or disable encryption for in-flight SMB data volume. This flag can be modified during Elastic volume update operation as well. Only applicable for SMB protocol Elastic volumes. | 'Disabled' 'Enabled' |
ElasticVolumeBackupProperties
| Name | Description | Value |
|---|---|---|
| elasticBackupPolicyResourceId | ResourceId used to identify Elastic Backup Policy | string |
| elasticBackupVaultResourceId | ResourceId used to identify Elastic Backup Vault | string |
| policyEnforcement | The property to decide policy is enforced or not on the volume | 'Enforced' 'NotEnforced' |
ElasticVolumeDataProtectionProperties
| Name | Description | Value |
|---|---|---|
| backup | Used to configure backups on an elastic volume. | ElasticVolumeBackupProperties |
| snapshot | Used to apply a snapshot policy to a volume. | ElasticVolumeSnapshotProperties |
ElasticVolumeProperties
| Name | Description | Value |
|---|---|---|
| backupResourceId | Resource identifier used to identify the Elastic Backup. | string |
| dataProtection | Data protection configuration option for the volume, including snapshot policies and backup. | ElasticVolumeDataProtectionProperties |
| exportPolicy | Set of export policy rules | ElasticExportPolicy |
| filePath | A unique file path for the volume. Used when creating mount targets. This needs to be unique within the elastic capacity pool. | string Constraints: Min length = 1 Max length = 80 Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ (required) |
| protocolTypes | Set of support protocol types for the elastic volume | String array containing any of: 'NFSv3' 'NFSv4' 'SMB' (required) |
| size | Maximum size allowed for a volume in bytes. Valid values are in the range 1GiB to 16TiB. Values expressed in bytes as multiples of 1 GiB. | int Constraints: Min value = 1073741824 Max value = 17592186044416 (required) |
| smbProperties | SMB Properties | ElasticSmbProperties |
| snapshotDirectoryVisibility | Controls the visibility of the volume's read-only snapshot directory, which provides access to each of the volume's snapshots. | 'Hidden' 'Visible' |
| snapshotResourceId | Resource identifier used to identify the Elastic Snapshot. | string |
ElasticVolumeSnapshotProperties
| Name | Description | Value |
|---|---|---|
| snapshotPolicyResourceId | Snapshot Policy ResourceId | string |
TrackedResourceTags
| Name | Description | Value |
|---|
ARM template resource definition
The elasticAccounts/elasticCapacityPools/elasticVolumes 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/elasticAccounts/elasticCapacityPools/elasticVolumes resource, add the following JSON to your template.
{
"type": "Microsoft.NetApp/elasticAccounts/elasticCapacityPools/elasticVolumes",
"apiVersion": "2025-09-01-preview",
"name": "string",
"location": "string",
"properties": {
"backupResourceId": "string",
"dataProtection": {
"backup": {
"elasticBackupPolicyResourceId": "string",
"elasticBackupVaultResourceId": "string",
"policyEnforcement": "string"
},
"snapshot": {
"snapshotPolicyResourceId": "string"
}
},
"exportPolicy": {
"rules": [
{
"allowedClients": [ "string" ],
"nfsv3": "string",
"nfsv4": "string",
"rootAccess": "string",
"ruleIndex": "int",
"unixAccessRule": "string"
}
]
},
"filePath": "string",
"protocolTypes": [ "string" ],
"size": "int",
"smbProperties": {
"smbEncryption": "string"
},
"snapshotDirectoryVisibility": "string",
"snapshotResourceId": "string"
},
"tags": {
"{customized property}": "string"
},
"zones": [ "string" ]
}
Property Values
Microsoft.NetApp/elasticAccounts/elasticCapacityPools/elasticVolumes
| 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 = 1 Max length = 64 Pattern = ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$ (required) |
| properties | The resource-specific properties for this resource. | ElasticVolumeProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.NetApp/elasticAccounts/elasticCapacityPools/elasticVolumes' |
| zones | The availability zones. | string[] |
ElasticExportPolicy
| Name | Description | Value |
|---|---|---|
| rules | Export policy rule | ElasticExportPolicyRule[] |
ElasticExportPolicyRule
| Name | Description | Value |
|---|---|---|
| allowedClients | Client ingress specification for the export policy as list of IPv4 CIDRs, IPv4 host addresses and host names. | string[] |
| nfsv3 | Allows clients to access the volume with the NFSv3 protocol. Enable only for NFSv3 type volumes | 'Disabled' 'Enabled' |
| nfsv4 | Allows clients to access the volume with at least NFSv4.1 protocol. | 'Disabled' 'Enabled' |
| rootAccess | Indicates whether root access to the volume is granted to clients affected by this rule | 'Disabled' 'Enabled' |
| ruleIndex | Controls the priority of the export policy rule. When connecting to the volume the rule with the lowest index that applies to the connecting client is used | int Constraints: Max value = 5 |
| unixAccessRule | Specifies the Unix file access level for the volume. It encompasses both read-only and read-write permissions. Additionally, NoAccess can be set to block all access to the volume | 'NoAccess' 'ReadOnly' 'ReadWrite' |
ElasticSmbProperties
| Name | Description | Value |
|---|---|---|
| smbEncryption | Used to enable or disable encryption for in-flight SMB data volume. This flag can be modified during Elastic volume update operation as well. Only applicable for SMB protocol Elastic volumes. | 'Disabled' 'Enabled' |
ElasticVolumeBackupProperties
| Name | Description | Value |
|---|---|---|
| elasticBackupPolicyResourceId | ResourceId used to identify Elastic Backup Policy | string |
| elasticBackupVaultResourceId | ResourceId used to identify Elastic Backup Vault | string |
| policyEnforcement | The property to decide policy is enforced or not on the volume | 'Enforced' 'NotEnforced' |
ElasticVolumeDataProtectionProperties
| Name | Description | Value |
|---|---|---|
| backup | Used to configure backups on an elastic volume. | ElasticVolumeBackupProperties |
| snapshot | Used to apply a snapshot policy to a volume. | ElasticVolumeSnapshotProperties |
ElasticVolumeProperties
| Name | Description | Value |
|---|---|---|
| backupResourceId | Resource identifier used to identify the Elastic Backup. | string |
| dataProtection | Data protection configuration option for the volume, including snapshot policies and backup. | ElasticVolumeDataProtectionProperties |
| exportPolicy | Set of export policy rules | ElasticExportPolicy |
| filePath | A unique file path for the volume. Used when creating mount targets. This needs to be unique within the elastic capacity pool. | string Constraints: Min length = 1 Max length = 80 Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ (required) |
| protocolTypes | Set of support protocol types for the elastic volume | String array containing any of: 'NFSv3' 'NFSv4' 'SMB' (required) |
| size | Maximum size allowed for a volume in bytes. Valid values are in the range 1GiB to 16TiB. Values expressed in bytes as multiples of 1 GiB. | int Constraints: Min value = 1073741824 Max value = 17592186044416 (required) |
| smbProperties | SMB Properties | ElasticSmbProperties |
| snapshotDirectoryVisibility | Controls the visibility of the volume's read-only snapshot directory, which provides access to each of the volume's snapshots. | 'Hidden' 'Visible' |
| snapshotResourceId | Resource identifier used to identify the Elastic Snapshot. | string |
ElasticVolumeSnapshotProperties
| Name | Description | Value |
|---|---|---|
| snapshotPolicyResourceId | Snapshot Policy ResourceId | string |
TrackedResourceTags
| Name | Description | Value |
|---|
Usage Examples
Terraform (AzAPI provider) resource definition
The elasticAccounts/elasticCapacityPools/elasticVolumes 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/elasticAccounts/elasticCapacityPools/elasticVolumes resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.NetApp/elasticAccounts/elasticCapacityPools/elasticVolumes@2025-09-01-preview"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
backupResourceId = "string"
dataProtection = {
backup = {
elasticBackupPolicyResourceId = "string"
elasticBackupVaultResourceId = "string"
policyEnforcement = "string"
}
snapshot = {
snapshotPolicyResourceId = "string"
}
}
exportPolicy = {
rules = [
{
allowedClients = [
"string"
]
nfsv3 = "string"
nfsv4 = "string"
rootAccess = "string"
ruleIndex = int
unixAccessRule = "string"
}
]
}
filePath = "string"
protocolTypes = [
"string"
]
size = int
smbProperties = {
smbEncryption = "string"
}
snapshotDirectoryVisibility = "string"
snapshotResourceId = "string"
}
zones = [
"string"
]
}
}
Property Values
Microsoft.NetApp/elasticAccounts/elasticCapacityPools/elasticVolumes
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Min length = 1 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: elasticAccounts/elasticCapacityPools |
| properties | The resource-specific properties for this resource. | ElasticVolumeProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.NetApp/elasticAccounts/elasticCapacityPools/elasticVolumes@2025-09-01-preview" |
| zones | The availability zones. | string[] |
ElasticExportPolicy
| Name | Description | Value |
|---|---|---|
| rules | Export policy rule | ElasticExportPolicyRule[] |
ElasticExportPolicyRule
| Name | Description | Value |
|---|---|---|
| allowedClients | Client ingress specification for the export policy as list of IPv4 CIDRs, IPv4 host addresses and host names. | string[] |
| nfsv3 | Allows clients to access the volume with the NFSv3 protocol. Enable only for NFSv3 type volumes | 'Disabled' 'Enabled' |
| nfsv4 | Allows clients to access the volume with at least NFSv4.1 protocol. | 'Disabled' 'Enabled' |
| rootAccess | Indicates whether root access to the volume is granted to clients affected by this rule | 'Disabled' 'Enabled' |
| ruleIndex | Controls the priority of the export policy rule. When connecting to the volume the rule with the lowest index that applies to the connecting client is used | int Constraints: Max value = 5 |
| unixAccessRule | Specifies the Unix file access level for the volume. It encompasses both read-only and read-write permissions. Additionally, NoAccess can be set to block all access to the volume | 'NoAccess' 'ReadOnly' 'ReadWrite' |
ElasticSmbProperties
| Name | Description | Value |
|---|---|---|
| smbEncryption | Used to enable or disable encryption for in-flight SMB data volume. This flag can be modified during Elastic volume update operation as well. Only applicable for SMB protocol Elastic volumes. | 'Disabled' 'Enabled' |
ElasticVolumeBackupProperties
| Name | Description | Value |
|---|---|---|
| elasticBackupPolicyResourceId | ResourceId used to identify Elastic Backup Policy | string |
| elasticBackupVaultResourceId | ResourceId used to identify Elastic Backup Vault | string |
| policyEnforcement | The property to decide policy is enforced or not on the volume | 'Enforced' 'NotEnforced' |
ElasticVolumeDataProtectionProperties
| Name | Description | Value |
|---|---|---|
| backup | Used to configure backups on an elastic volume. | ElasticVolumeBackupProperties |
| snapshot | Used to apply a snapshot policy to a volume. | ElasticVolumeSnapshotProperties |
ElasticVolumeProperties
| Name | Description | Value |
|---|---|---|
| backupResourceId | Resource identifier used to identify the Elastic Backup. | string |
| dataProtection | Data protection configuration option for the volume, including snapshot policies and backup. | ElasticVolumeDataProtectionProperties |
| exportPolicy | Set of export policy rules | ElasticExportPolicy |
| filePath | A unique file path for the volume. Used when creating mount targets. This needs to be unique within the elastic capacity pool. | string Constraints: Min length = 1 Max length = 80 Pattern = ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$ (required) |
| protocolTypes | Set of support protocol types for the elastic volume | String array containing any of: 'NFSv3' 'NFSv4' 'SMB' (required) |
| size | Maximum size allowed for a volume in bytes. Valid values are in the range 1GiB to 16TiB. Values expressed in bytes as multiples of 1 GiB. | int Constraints: Min value = 1073741824 Max value = 17592186044416 (required) |
| smbProperties | SMB Properties | ElasticSmbProperties |
| snapshotDirectoryVisibility | Controls the visibility of the volume's read-only snapshot directory, which provides access to each of the volume's snapshots. | 'Hidden' 'Visible' |
| snapshotResourceId | Resource identifier used to identify the Elastic Snapshot. | string |
ElasticVolumeSnapshotProperties
| Name | Description | Value |
|---|---|---|
| snapshotPolicyResourceId | Snapshot Policy ResourceId | string |
TrackedResourceTags
| Name | Description | Value |
|---|