Microsoft.NetApp netAppAccounts/capacityPools/volumes 2017-08-15

Bicep resource definition

The netAppAccounts/capacityPools/volumes 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/netAppAccounts/capacityPools/volumes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2017-08-15' = {
  name: 'string'
  location: 'string'
  tags: any()
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  properties: {
    creationToken: 'string'
    exportPolicy: {
      rules: [
        {
          allowedClients: 'string'
          cifs: bool
          nfsv3: bool
          nfsv4: bool
          ruleIndex: int
          unixReadWrite: bool
        }
      ]
    }
    serviceLevel: 'string'
    subnetId: 'string'
    usageThreshold: int
  }
}

Property values

netAppAccounts/capacityPools/volumes

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.
string (required)
location Resource location string (required)
tags Resource tags For Bicep, you can use the any() function.
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: capacityPools
properties Volume properties VolumeProperties (required)

VolumeProperties

Name Description Value
creationToken A unique file path for the volume. Used when creating mount targets string (required)
exportPolicy Export policy rule VolumePropertiesExportPolicy
serviceLevel The service level of the file system 'Premium'
'Standard'
'Ultra' (required)
subnetId The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes 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. int

Constraints:
Min value = 107374182400
Max value = 109951162777600

VolumePropertiesExportPolicy

Name Description Value
rules 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
nfsv4 Allows NFSv4 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.

ARM template resource definition

The netAppAccounts/capacityPools/volumes 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/netAppAccounts/capacityPools/volumes resource, add the following JSON to your template.

{
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
  "apiVersion": "2017-08-15",
  "name": "string",
  "location": "string",
  "tags": {},
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "creationToken": "string",
    "exportPolicy": {
      "rules": [
        {
          "allowedClients": "string",
          "cifs": "bool",
          "nfsv3": "bool",
          "nfsv4": "bool",
          "ruleIndex": "int",
          "unixReadWrite": "bool"
        }
      ]
    },
    "serviceLevel": "string",
    "subnetId": "string",
    "usageThreshold": "int"
  }
}

Property values

netAppAccounts/capacityPools/volumes

Name Description Value
type The resource type 'Microsoft.NetApp/netAppAccounts/capacityPools/volumes'
apiVersion The resource api version '2017-08-15'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
location Resource location string (required)
tags Resource tags
properties Volume properties VolumeProperties (required)

VolumeProperties

Name Description Value
creationToken A unique file path for the volume. Used when creating mount targets string (required)
exportPolicy Export policy rule VolumePropertiesExportPolicy
serviceLevel The service level of the file system 'Premium'
'Standard'
'Ultra' (required)
subnetId The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes 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. int

Constraints:
Min value = 107374182400
Max value = 109951162777600

VolumePropertiesExportPolicy

Name Description Value
rules 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
nfsv4 Allows NFSv4 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.

Terraform (AzAPI provider) resource definition

The netAppAccounts/capacityPools/volumes resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2017-08-15"
  name = "string"
  location = "string"
  parent_id = "string"
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      creationToken = "string"
      exportPolicy = {
        rules = [
          {
            allowedClients = "string"
            cifs = bool
            nfsv3 = bool
            nfsv4 = bool
            ruleIndex = int
            unixReadWrite = bool
          }
        ]
      }
      serviceLevel = "string"
      subnetId = "string"
      usageThreshold = int
    }
  })
}

Property values

netAppAccounts/capacityPools/volumes

Name Description Value
type The resource type "Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2017-08-15"
name The resource name string (required)
location Resource location string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: capacityPools
tags Resource tags
properties Volume properties VolumeProperties (required)

VolumeProperties

Name Description Value
creationToken A unique file path for the volume. Used when creating mount targets string (required)
exportPolicy Export policy rule VolumePropertiesExportPolicy
serviceLevel The service level of the file system "Premium"
"Standard"
"Ultra" (required)
subnetId The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes 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. int

Constraints:
Min value = 107374182400
Max value = 109951162777600

VolumePropertiesExportPolicy

Name Description Value
rules 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
nfsv4 Allows NFSv4 protocol bool
ruleIndex Order index int
unixReadWrite Read and write access bool