Microsoft.NetApp netAppAccounts/capacityPools/volumes 2019-11-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@2019-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    creationToken: 'string'
    dataProtection: {
      replication: {
        endpointType: 'string'
        remoteVolumeRegion: 'string'
        remoteVolumeResourceId: 'string'
        replicationId: 'string'
        replicationSchedule: 'string'
      }
    }
    exportPolicy: {
      rules: [
        {
          allowedClients: 'string'
          cifs: bool
          nfsv3: bool
          nfsv41: bool
          ruleIndex: int
          unixReadWrite: bool
        }
      ]
    }
    isRestoring: bool
    protocolTypes: [ 'string' ]
    serviceLevel: 'string'
    snapshotId: 'string'
    subnetId: '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.
'2019-11-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
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
exportPolicy Set of export policy rules VolumePropertiesExportPolicy
isRestoring Restoring bool
protocolTypes Set of protocol types, default NFSv3, CIFS for SMB protocol string[]
serviceLevel The service level of the file system 'Premium'
'Standard'
'Ultra'
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)
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
replication Replication properties ReplicationObject

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'

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
cifs Allows CIFS protocol bool
nfsv3 Allows NFSv3 protocol bool
nfsv41 Allows NFSv4.1 protocol 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.