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

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@2020-08-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    backupId: 'string'
    creationToken: 'string'
    dataProtection: {
      backup: {
        backupEnabled: bool
        backupPolicyId: 'string'
        policyEnforced: bool
        vaultId: 'string'
      }
      replication: {
        endpointType: 'string'
        remoteVolumeRegion: 'string'
        remoteVolumeResourceId: 'string'
        replicationId: 'string'
        replicationSchedule: 'string'
      }
      snapshot: {
        snapshotPolicyId: 'string'
      }
    }
    exportPolicy: {
      rules: [
        {
          allowedClients: 'string'
          cifs: bool
          hasRootAccess: bool
          kerberos5iReadOnly: bool
          kerberos5iReadWrite: bool
          kerberos5pReadOnly: bool
          kerberos5pReadWrite: bool
          kerberos5ReadOnly: bool
          kerberos5ReadWrite: bool
          nfsv3: bool
          nfsv41: bool
          ruleIndex: int
          unixReadOnly: bool
          unixReadWrite: bool
        }
      ]
    }
    isRestoring: bool
    kerberosEnabled: bool
    protocolTypes: [
      'string'
    ]
    securityStyle: 'string'
    serviceLevel: 'string'
    snapshotDirectoryVisible: bool
    snapshotId: 'string'
    subnetId: 'string'
    throughputMibps: int
    usageThreshold: int
    volumeType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.NetApp/netAppAccounts/capacityPools/volumes

ExportPolicyRule

ReplicationObject

ResourceTags

VolumeBackupProperties

VolumeProperties

VolumePropertiesDataProtection

VolumePropertiesExportPolicy

VolumeSnapshotProperties

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": "2020-08-01",
  "name": "string",
  "location": "string",
  "properties": {
    "backupId": "string",
    "creationToken": "string",
    "dataProtection": {
      "backup": {
        "backupEnabled": "bool",
        "backupPolicyId": "string",
        "policyEnforced": "bool",
        "vaultId": "string"
      },
      "replication": {
        "endpointType": "string",
        "remoteVolumeRegion": "string",
        "remoteVolumeResourceId": "string",
        "replicationId": "string",
        "replicationSchedule": "string"
      },
      "snapshot": {
        "snapshotPolicyId": "string"
      }
    },
    "exportPolicy": {
      "rules": [
        {
          "allowedClients": "string",
          "cifs": "bool",
          "hasRootAccess": "bool",
          "kerberos5iReadOnly": "bool",
          "kerberos5iReadWrite": "bool",
          "kerberos5pReadOnly": "bool",
          "kerberos5pReadWrite": "bool",
          "kerberos5ReadOnly": "bool",
          "kerberos5ReadWrite": "bool",
          "nfsv3": "bool",
          "nfsv41": "bool",
          "ruleIndex": "int",
          "unixReadOnly": "bool",
          "unixReadWrite": "bool"
        }
      ]
    },
    "isRestoring": "bool",
    "kerberosEnabled": "bool",
    "protocolTypes": [ "string" ],
    "securityStyle": "string",
    "serviceLevel": "string",
    "snapshotDirectoryVisible": "bool",
    "snapshotId": "string",
    "subnetId": "string",
    "throughputMibps": "int",
    "usageThreshold": "int",
    "volumeType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.NetApp/netAppAccounts/capacityPools/volumes

ExportPolicyRule

ReplicationObject

ResourceTags

VolumeBackupProperties

VolumeProperties

VolumePropertiesDataProtection

VolumePropertiesExportPolicy

VolumeSnapshotProperties

Usage Examples

Azure Quickstart Templates

The following Azure 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:

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@2020-08-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      backupId = "string"
      creationToken = "string"
      dataProtection = {
        backup = {
          backupEnabled = bool
          backupPolicyId = "string"
          policyEnforced = bool
          vaultId = "string"
        }
        replication = {
          endpointType = "string"
          remoteVolumeRegion = "string"
          remoteVolumeResourceId = "string"
          replicationId = "string"
          replicationSchedule = "string"
        }
        snapshot = {
          snapshotPolicyId = "string"
        }
      }
      exportPolicy = {
        rules = [
          {
            allowedClients = "string"
            cifs = bool
            hasRootAccess = bool
            kerberos5iReadOnly = bool
            kerberos5iReadWrite = bool
            kerberos5pReadOnly = bool
            kerberos5pReadWrite = bool
            kerberos5ReadOnly = bool
            kerberos5ReadWrite = bool
            nfsv3 = bool
            nfsv41 = bool
            ruleIndex = int
            unixReadOnly = bool
            unixReadWrite = bool
          }
        ]
      }
      isRestoring = bool
      kerberosEnabled = bool
      protocolTypes = [
        "string"
      ]
      securityStyle = "string"
      serviceLevel = "string"
      snapshotDirectoryVisible = bool
      snapshotId = "string"
      subnetId = "string"
      throughputMibps = int
      usageThreshold = int
      volumeType = "string"
    }
  }
}

Property Values

Microsoft.NetApp/netAppAccounts/capacityPools/volumes

ExportPolicyRule

ReplicationObject

ResourceTags

VolumeBackupProperties

VolumeProperties

VolumePropertiesDataProtection

VolumePropertiesExportPolicy

VolumeSnapshotProperties

Usage Examples

Terraform Samples

A basic example of deploying NetApp Volume.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "centralus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "virtualNetwork" {
  type      = "Microsoft.Network/virtualNetworks@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "10.6.0.0/16",
        ]
      }
      dhcpOptions = {
        dnsServers = [
        ]
      }
      subnets = [
      ]
    }
    tags = {
      SkipASMAzSecPack = "true"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.subnets]
  }
}

resource "azapi_resource" "netAppAccount" {
  type      = "Microsoft.NetApp/netAppAccounts@2022-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      activeDirectories = [
      ]
    }
    tags = {
      SkipASMAzSecPack = "true"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "subnet" {
  type      = "Microsoft.Network/virtualNetworks/subnets@2022-07-01"
  parent_id = azapi_resource.virtualNetwork.id
  name      = "GatewaySubnet"
  body = {
    properties = {
      addressPrefix = "10.6.1.0/24"
      delegations = [
      ]
      privateEndpointNetworkPolicies    = "Enabled"
      privateLinkServiceNetworkPolicies = "Enabled"
      serviceEndpointPolicies = [
      ]
      serviceEndpoints = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "subnet2" {
  type      = "Microsoft.Network/virtualNetworks/subnets@2022-07-01"
  parent_id = azapi_resource.virtualNetwork.id
  name      = var.resource_name
  body = {
    properties = {
      addressPrefix = "10.6.2.0/24"
      delegations = [
        {
          name = "testdelegation"
          properties = {
            serviceName = "Microsoft.Netapp/volumes"
          }
        },
      ]
      privateEndpointNetworkPolicies    = "Enabled"
      privateLinkServiceNetworkPolicies = "Enabled"
      serviceEndpointPolicies = [
      ]
      serviceEndpoints = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "capacityPool" {
  type      = "Microsoft.NetApp/netAppAccounts/capacityPools@2022-05-01"
  parent_id = azapi_resource.netAppAccount.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      serviceLevel = "Standard"
      size         = 4.398046511104e+12
    }
    tags = {
      SkipASMAzSecPack = "true"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "volume" {
  type      = "Microsoft.NetApp/netAppAccounts/capacityPools/volumes@2022-05-01"
  parent_id = azapi_resource.capacityPool.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      avsDataStore  = "Enabled"
      creationToken = "my-unique-file-path-230630034120103726"
      dataProtection = {
      }
      exportPolicy = {
        rules = [
          {
            allowedClients = "0.0.0.0/0"
            cifs           = false
            hasRootAccess  = true
            nfsv3          = true
            nfsv41         = false
            ruleIndex      = 1
            unixReadOnly   = false
            unixReadWrite  = true
          },
        ]
      }
      networkFeatures = "Basic"
      protocolTypes = [
        "NFSv3",
      ]
      serviceLevel             = "Standard"
      snapshotDirectoryVisible = true
      subnetId                 = azapi_resource.subnet2.id
      usageThreshold           = 1.073741824e+11
      volumeType               = ""
    }
    tags = {
      SkipASMAzSecPack = "true"
    }
    zones = [
    ]
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}