Microsoft.NetApp netAppAccounts/capacityPools/volumes 2019-06-01

• Latest
• 2024-07-01
• 2024-07-01-preview
• 2024-05-01
• 2024-05-01-preview
• 2024-03-01
• 2024-03-01-preview
• 2024-01-01
• 2023-11-01
• 2023-11-01-preview
• 2023-07-01
• 2023-07-01-preview
• 2023-05-01
• 2023-05-01-preview
• 2022-11-01
• 2022-11-01-preview
• 2022-09-01
• 2022-05-01
• 2022-03-01
• 2022-01-01
• 2021-10-01
• 2021-08-01
• 2021-06-01
• 2021-04-01
• 2021-04-01-preview
• 2021-02-01
• 2020-12-01
• 2020-11-01
• 2020-09-01
• 2020-08-01
• 2020-07-01
• 2020-06-01
• 2020-05-01
• 2020-03-01
• 2020-02-01
• 2019-11-01
• 2019-10-01
• 2019-08-01
• 2019-07-01
• 2019-06-01
• 2019-05-01
• 2017-08-15

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2019-06-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    creationToken: 'string'
    exportPolicy: {
      rules: [
        {
          allowedClients: 'string'
          cifs: bool
          nfsv3: bool
          nfsv4: bool
          ruleIndex: int
          unixReadOnly: bool
          unixReadWrite: bool
        }
      ]
    }
    protocolTypes: [
      'string'
    ]
    serviceLevel: 'string'
    snapshotId: 'string'
    subnetId: 'string'
    usageThreshold: int
  }
  tags: any(Azure.Bicep.Types.Concrete.AnyType)
}

Property values

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	Deprecated: Will use the NFSv4.1 protocol, please use swagger version 2019-07-01 or later	bool
ruleIndex	Order index	int
unixReadOnly	Read only access	bool
unixReadWrite	Read and write access	bool

Microsoft.NetApp/netAppAccounts/capacityPools/volumes

Name	Description	Value
location	Resource location	string (required)
name	The resource name	string (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/capacityPools
properties	Volume properties	VolumeProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

VolumeProperties

Name	Description	Value
creationToken	A unique file path for the volume. Used when creating mount targets	string (required)
exportPolicy	Set of export policy rules	VolumePropertiesExportPolicy
protocolTypes	Set of protocol types	string[]
serviceLevel	The service level of the file system	'Premium' 'Standard' 'Ultra'
snapshotId	UUID v4 or resource identifier used to identify the Snapshot.	string Constraints: Min length = 36 Max length = 36 Pattern = ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|(\\?([^\/]*[\/])*)([^\/]+)$
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 Constraints: Min value = 107374182400 Max value = 109951162777600 (required)

VolumePropertiesExportPolicy

Name	Description	Value
rules	Export policy rule	ExportPolicyRule[]

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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": "2019-06-01",
  "name": "string",
  "location": "string",
  "properties": {
    "creationToken": "string",
    "exportPolicy": {
      "rules": [
        {
          "allowedClients": "string",
          "cifs": "bool",
          "nfsv3": "bool",
          "nfsv4": "bool",
          "ruleIndex": "int",
          "unixReadOnly": "bool",
          "unixReadWrite": "bool"
        }
      ]
    },
    "protocolTypes": [ "string" ],
    "serviceLevel": "string",
    "snapshotId": "string",
    "subnetId": "string",
    "usageThreshold": "int"
  },
  "tags": {}
}

Property values

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	Deprecated: Will use the NFSv4.1 protocol, please use swagger version 2019-07-01 or later	bool
ruleIndex	Order index	int
unixReadOnly	Read only access	bool
unixReadWrite	Read and write access	bool

Microsoft.NetApp/netAppAccounts/capacityPools/volumes

Name	Description	Value
apiVersion	The api version	'2019-06-01'
location	Resource location	string (required)
name	The resource name	string (required)
properties	Volume properties	VolumeProperties (required)
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.NetApp/netAppAccounts/capacityPools/volumes'

VolumeProperties

Name	Description	Value
creationToken	A unique file path for the volume. Used when creating mount targets	string (required)
exportPolicy	Set of export policy rules	VolumePropertiesExportPolicy
protocolTypes	Set of protocol types	string[]
serviceLevel	The service level of the file system	'Premium' 'Standard' 'Ultra'
snapshotId	UUID v4 or resource identifier used to identify the Snapshot.	string Constraints: Min length = 36 Max length = 36 Pattern = ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|(\\?([^\/]*[\/])*)([^\/]+)$
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 Constraints: Min value = 107374182400 Max value = 109951162777600 (required)

VolumePropertiesExportPolicy

Name	Description	Value
rules	Export policy rule	ExportPolicyRule[]

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.

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@2019-06-01"
  name = "string"
  location = "string"
  tags = ?
  body = jsonencode({
    properties = {
      creationToken = "string"
      exportPolicy = {
        rules = [
          {
            allowedClients = "string"
            cifs = bool
            nfsv3 = bool
            nfsv4 = bool
            ruleIndex = int
            unixReadOnly = bool
            unixReadWrite = bool
          }
        ]
      }
      protocolTypes = [
        "string"
      ]
      serviceLevel = "string"
      snapshotId = "string"
      subnetId = "string"
      usageThreshold = int
    }
  })
}

Property values

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	Deprecated: Will use the NFSv4.1 protocol, please use swagger version 2019-07-01 or later	bool
ruleIndex	Order index	int
unixReadOnly	Read only access	bool
unixReadWrite	Read and write access	bool

Microsoft.NetApp/netAppAccounts/capacityPools/volumes

Name	Description	Value
location	Resource location	string (required)
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: netAppAccounts/capacityPools
properties	Volume properties	VolumeProperties (required)
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2019-06-01"

VolumeProperties

Name	Description	Value
creationToken	A unique file path for the volume. Used when creating mount targets	string (required)
exportPolicy	Set of export policy rules	VolumePropertiesExportPolicy
protocolTypes	Set of protocol types	string[]
serviceLevel	The service level of the file system	'Premium' 'Standard' 'Ultra'
snapshotId	UUID v4 or resource identifier used to identify the Snapshot.	string Constraints: Min length = 36 Max length = 36 Pattern = ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|(\\?([^\/]*[\/])*)([^\/]+)$
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 Constraints: Min value = 107374182400 Max value = 109951162777600 (required)

VolumePropertiesExportPolicy

Name	Description	Value
rules	Export policy rule	ExportPolicyRule[]