Microsoft.NetApp netAppAccounts/capacityPools/volumes 2021-04-01

The netAppAccounts/capacityPools/volumes resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

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

resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2021-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    backupId: 'string'
    coolAccess: bool
    coolnessPeriod: int
    creationToken: 'string'
    dataProtection: {
      backup: {
        backupEnabled: bool
        backupPolicyId: 'string'
        policyEnforced: bool
        vaultId: 'string'
      }
      replication: {
        endpointType: 'string'
        remoteVolumeRegion: 'string'
        remoteVolumeResourceId: 'string'
        replicationId: 'string'
        replicationSchedule: 'string'
      }
      snapshot: {
        snapshotPolicyId: '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
        }
      ]
    }
    isRestoring: bool
    kerberosEnabled: bool
    ldapEnabled: bool
    protocolTypes: [ 'string' ]
    securityStyle: 'string'
    serviceLevel: 'string'
    smbContinuouslyAvailable: bool
    smbEncryption: bool
    snapshotDirectoryVisible: bool
    snapshotId: 'string'
    subnetId: 'string'
    throughputMibps: int
    unixPermissions: 'string'
    usageThreshold: int
    volumeType: 'string'
  }
}

Property values

netAppAccounts/capacityPools/volumes

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.
'Microsoft.NetApp/netAppAccounts/capacityPools/volumes'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.
'2021-04-01'
name The resource name

See how to set names and types for child resources in Bicep or JSON ARM templates.
string (required)
location Resource location string (required)
tags Tags are a list of key-value pairs that describe the resource Dictionary of tag names and values. See Tags in templates
properties Volume properties VolumeProperties (required)

VolumeProperties

Name Description Value
backupId UUID v4 or resource identifier used to identify the Backup. string
coolAccess Specifies whether Cool Access(tiering) is enabled for the volume. bool
coolnessPeriod Specifies the number of days after which data that is not accessed by clients will be tiered. int
creationToken A unique file path for the volume. Used when creating mount targets string (required)
dataProtection DataProtection type volumes include an object containing details of the replication VolumePropertiesDataProtection
encryptionKeySource Encryption Key Source. Possible values are: 'Microsoft.NetApp' string
exportPolicy Set of export policy rules VolumePropertiesExportPolicy
isRestoring Restoring bool
kerberosEnabled Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later bool
ldapEnabled Specifies whether LDAP is enabled or not for a given NFS volume. bool
protocolTypes Set of protocol types, default NFSv3, CIFS for SMB protocol 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'
'Ultra'
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
snapshotDirectoryVisible If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (default to true). bool
snapshotId UUID v4 or 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 Mibps that can be achieved by this 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
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. Specified in bytes. int (required)
volumeType What type of volume is this string

VolumePropertiesDataProtection

Name Description Value
backup Volume Backup Properties VolumeBackupProperties
replication Replication properties ReplicationObject
snapshot Volume Snapshot Properties VolumeSnapshotProperties

VolumeBackupProperties

Name Description Value
backupEnabled Backup Enabled bool
backupPolicyId Backup Policy Resource ID string
policyEnforced Policy Enforced bool
vaultId Vault Resource ID string

ReplicationObject

Name Description Value
endpointType Indicates whether the local volume is the source or destination for the Volume Replication 'dst'
'src'
remoteVolumeRegion The remote region for the other end of the Volume Replication. string
remoteVolumeResourceId The resource ID of the remote volume. string (required)
replicationId Id string
replicationSchedule Schedule '_10minutely'
'daily'
'hourly'

VolumeSnapshotProperties

Name Description Value
snapshotPolicyId Snapshot Policy ResourceId string

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create new ANF resource with NFSV3/NFSv4.1 volume

Deploy to Azure
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

Deploy to Azure
This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with SMB protocol.