Share via

Microsoft.NetApp netAppAccounts/capacityPools 2023-11-01

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.NetApp/netAppAccounts/capacityPools@2023-11-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    coolAccess: bool
    encryptionType: 'string'
    qosType: 'string'
    serviceLevel: 'string'
    size: int
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Microsoft.NetApp/netAppAccounts/capacityPools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$ (required)
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: netAppAccounts
properties Capacity pool properties PoolProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

PoolProperties

Name Description Value
coolAccess If enabled (true) the pool can contain cool Access enabled volumes. bool
encryptionType Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. 'Double'
'Single'
qosType The qos type of the pool 'Auto'
'Manual'
serviceLevel The service level of the file system 'Premium'
'Standard'
'StandardZRS'
'Ultra' (required)
size Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 1099511627776). int (required)

TrackedResourceTags

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools",
  "apiVersion": "2023-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "coolAccess": "bool",
    "encryptionType": "string",
    "qosType": "string",
    "serviceLevel": "string",
    "size": "int"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Microsoft.NetApp/netAppAccounts/capacityPools

Name Description Value
apiVersion The api version '2023-11-01'
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$ (required)
properties Capacity pool properties PoolProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.NetApp/netAppAccounts/capacityPools'

PoolProperties

Name Description Value
coolAccess If enabled (true) the pool can contain cool Access enabled volumes. bool
encryptionType Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. 'Double'
'Single'
qosType The qos type of the pool 'Auto'
'Manual'
serviceLevel The service level of the file system 'Premium'
'Standard'
'StandardZRS'
'Ultra' (required)
size Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 1099511627776). int (required)

TrackedResourceTags

Name Description Value

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 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts/capacityPools@2023-11-01"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      coolAccess = bool
      encryptionType = "string"
      qosType = "string"
      serviceLevel = "string"
      size = int
    }
  })
}

Property values

Microsoft.NetApp/netAppAccounts/capacityPools

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 1
Max length = 1
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: netAppAccounts
properties Capacity pool properties PoolProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.NetApp/netAppAccounts/capacityPools@2023-11-01"

PoolProperties

Name Description Value
coolAccess If enabled (true) the pool can contain cool Access enabled volumes. bool
encryptionType Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool. 'Double'
'Single'
qosType The qos type of the pool 'Auto'
'Manual'
serviceLevel The service level of the file system 'Premium'
'Standard'
'StandardZRS'
'Ultra' (required)
size Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 1099511627776). int (required)

TrackedResourceTags

Name Description Value