Microsoft.NetApp netAppAccounts/capacityPools/volumes

01/14/2021
4 minutes to read

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-09-01",
  "location": "string",
  "tags": {},
  "properties": {
    "creationToken": "string",
    "serviceLevel": "string",
    "usageThreshold": "integer",
    "exportPolicy": {
      "rules": [
        {
          "ruleIndex": "integer",
          "unixReadOnly": "boolean",
          "unixReadWrite": "boolean",
          "kerberos5ReadOnly": "boolean",
          "kerberos5ReadWrite": "boolean",
          "kerberos5iReadOnly": "boolean",
          "kerberos5iReadWrite": "boolean",
          "kerberos5pReadOnly": "boolean",
          "kerberos5pReadWrite": "boolean",
          "cifs": "boolean",
          "nfsv3": "boolean",
          "nfsv41": "boolean",
          "allowedClients": "string",
          "hasRootAccess": "boolean"
        }
      ]
    },
    "protocolTypes": [
      "string"
    ],
    "snapshotId": "string",
    "backupId": "string",
    "subnetId": "string",
    "mountTargets": [
      {
        "fileSystemId": "string",
        "smbServerFqdn": "string"
      }
    ],
    "volumeType": "string",
    "dataProtection": {
      "backup": {
        "backupPolicyId": "string",
        "policyEnforced": "boolean",
        "vaultId": "string",
        "backupEnabled": "boolean"
      },
      "replication": {
        "replicationId": "string",
        "endpointType": "string",
        "replicationSchedule": "string",
        "remoteVolumeResourceId": "string",
        "remoteVolumeRegion": "string"
      },
      "snapshot": {
        "snapshotPolicyId": "string"
      }
    },
    "isRestoring": "boolean",
    "snapshotDirectoryVisible": "boolean",
    "kerberosEnabled": "boolean",
    "securityStyle": "string",
    "smbEncryption": "boolean",
    "smbContinuouslyAvailable": "boolean",
    "throughputMibps": "number"
  },
  "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-09-01
location	string	Yes	Resource location
tags	object	No	Resource tags
properties	object	Yes	Volume properties - VolumeProperties object
resources	array	No	backups 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.
backupId	string	No	UUID v4 or resource identifier used to identify the Backup.
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).
kerberosEnabled	boolean	No	Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
securityStyle	enum	No	The security style of volume. - ntfs or unix
smbEncryption	boolean	No	Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later
smbContinuouslyAvailable	boolean	No	Enables continuously available share property for smb volume. Only applicable for SMB volume
throughputMibps	number	No

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
smbServerFqdn	string	No	The SMB server's Fully Qualified Domain Name, FQDN

VolumePropertiesDataProtection object

Name	Type	Required	Value
backup	object	No	Backup Properties - VolumeBackupProperties object
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
kerberos5ReadOnly	boolean	No	Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
kerberos5ReadWrite	boolean	No	Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5iReadOnly	boolean	No	Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
kerberos5iReadWrite	boolean	No	Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5pReadOnly	boolean	No	Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
kerberos5pReadWrite	boolean	No	Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
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
hasRootAccess	boolean	No	Has root access to volume

VolumeBackupProperties object

Name	Type	Required	Value
backupPolicyId	string	No	Backup Policy Resource ID
policyEnforced	boolean	No	Policy Enforced
vaultId	string	No	Vault Resource ID
backupEnabled	boolean	No	Backup Enabled

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	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	This template allows you to create a new Azure NetApp Files resource with a single Capacity pool and single volume configured with SMB protocol.