Microsoft.NetApp netAppAccounts/capacityPools/volumes 2020-02-01

Template format

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

{
  "name": "string",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
  "apiVersion": "2020-02-01",
  "location": "string",
  "tags": {},
  "properties": {
    "creationToken": "string",
    "serviceLevel": "string",
    "usageThreshold": "integer",
    "exportPolicy": {
      "rules": [
        {
          "ruleIndex": "integer",
          "unixReadOnly": "boolean",
          "unixReadWrite": "boolean",
          "cifs": "boolean",
          "nfsv3": "boolean",
          "nfsv41": "boolean",
          "allowedClients": "string"
        }
      ]
    },
    "protocolTypes": [
      "string"
    ],
    "snapshotId": "string",
    "subnetId": "string",
    "mountTargets": [
      {
        "fileSystemId": "string",
        "subnet": "string",
        "startIp": "string",
        "endIp": "string",
        "gateway": "string",
        "netmask": "string",
        "smbServerFqdn": "string"
      }
    ],
    "volumeType": "string",
    "dataProtection": {
      "replication": {
        "replicationId": "string",
        "endpointType": "string",
        "replicationSchedule": "string",
        "remoteVolumeResourceId": "string",
        "remoteVolumeRegion": "string"
      },
      "snapshot": {
        "snapshotPolicyId": "string"
      }
    },
    "isRestoring": "boolean",
    "snapshotDirectoryVisible": "boolean"
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.NetApp/netAppAccounts/capacityPools/volumes object

Name Type Required Value
name string Yes The name of the volume
type enum Yes volumes
-or-
Microsoft.NetApp/netAppAccounts/capacityPools/volumes

See Set name and type for child resources.
apiVersion enum Yes 2020-02-01
location string Yes Resource location
tags object No Resource tags
properties object Yes Volume properties - VolumeProperties object
resources array No snapshots

VolumeProperties object

Name Type Required Value
creationToken string Yes A unique file path for the volume. Used when creating mount targets
serviceLevel enum No The service level of the file system. - Standard, Premium, Ultra
usageThreshold integer Yes 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.
exportPolicy object No Set of export policy rules - VolumePropertiesExportPolicy object
protocolTypes array No Set of protocol types - string
snapshotId string No UUID v4 or resource identifier used to identify the Snapshot.
subnetId string Yes The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
mountTargets array No List of mount targets - MountTargetProperties object
volumeType string No What type of volume is this
dataProtection object No DataProtection type volumes include an object containing details of the replication - VolumePropertiesDataProtection object
isRestoring boolean No Restoring
snapshotDirectoryVisible boolean No 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).

VolumePropertiesExportPolicy object

Name Type Required Value
rules array No Export policy rule - ExportPolicyRule object

MountTargetProperties object

Name Type Required Value
fileSystemId string Yes UUID v4 used to identify the MountTarget
subnet string No The subnet
startIp string No The start of IPv4 address range to use when creating a new mount target
endIp string No The end of IPv4 address range to use when creating a new mount target
gateway string No The gateway of the IPv4 address range to use when creating a new mount target
netmask string No The netmask of the IPv4 address range to use when creating a new mount target
smbServerFqdn string No The SMB server's Fully Qualified Domain Name, FQDN

VolumePropertiesDataProtection object

Name Type Required Value
replication object No Replication properties - ReplicationObject object
snapshot object No Snapshot properties. - VolumeSnapshotProperties object

ExportPolicyRule object

Name Type Required Value
ruleIndex integer No Order index
unixReadOnly boolean No Read only access
unixReadWrite boolean No Read and write access
cifs boolean No Allows CIFS protocol
nfsv3 boolean No Allows NFSv3 protocol. Enable only for NFSv3 type volumes
nfsv41 boolean No Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
allowedClients string No Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names

ReplicationObject object

Name Type Required Value
replicationId string No Id
endpointType enum No Indicates whether the local volume is the source or destination for the Volume Replication. - src or dst
replicationSchedule enum Yes Schedule. - _10minutely, hourly, daily
remoteVolumeResourceId string Yes The resource ID of the remote volume.
remoteVolumeRegion string No The remote region for the other end of the Volume Replication.

VolumeSnapshotProperties object

Name Type Required Value
snapshotPolicyId string No Snapshot Policy ResourceId

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.