Microsoft.NetApp netAppAccounts 2020-02-01

Bicep resource definition

The netAppAccounts resource type can be deployed to:

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

Resource format

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

resource symbolicname 'Microsoft.NetApp/netAppAccounts@2020-02-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    activeDirectories: [
      {
        activeDirectoryId: 'string'
        backupOperators: [
          'string'
        ]
        dns: 'string'
        domain: 'string'
        organizationalUnit: 'string'
        password: 'string'
        site: 'string'
        smbServerName: 'string'
        status: 'string'
        username: 'string'
      }
    ]
  }
}

Property values

netAppAccounts

Name Description Value
name The resource name string (required)

Character limit: 1-128

Valid characters:
Alphanumerics, underscores, and hyphens.

Start with alphanumeric.
location Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
properties NetApp Account properties AccountProperties

AccountProperties

Name Description Value
activeDirectories Active Directories ActiveDirectory[]

ActiveDirectory

Name Description Value
activeDirectoryId Id of the Active Directory string
backupOperators Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier string[]
dns Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain string
domain Name of the Active Directory domain string
organizationalUnit The Organizational Unit (OU) within the Windows Active Directory string
password Plain text password of Active Directory domain administrator string
site The Active Directory site the service will limit Domain Controller discovery to string
smbServerName NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes string
status Status of the Active Directory string
username Username of Active Directory domain administrator string

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 resource type can be deployed to:

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

Resource format

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

{
  "type": "Microsoft.NetApp/netAppAccounts",
  "apiVersion": "2020-02-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "activeDirectories": [
      {
        "activeDirectoryId": "string",
        "backupOperators": [ "string" ],
        "dns": "string",
        "domain": "string",
        "organizationalUnit": "string",
        "password": "string",
        "site": "string",
        "smbServerName": "string",
        "status": "string",
        "username": "string"
      }
    ]
  }
}

Property values

netAppAccounts

Name Description Value
type The resource type 'Microsoft.NetApp/netAppAccounts'
apiVersion The resource api version '2020-02-01'
name The resource name string (required)

Character limit: 1-128

Valid characters:
Alphanumerics, underscores, and hyphens.

Start with alphanumeric.
location Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
properties NetApp Account properties AccountProperties

AccountProperties

Name Description Value
activeDirectories Active Directories ActiveDirectory[]

ActiveDirectory

Name Description Value
activeDirectoryId Id of the Active Directory string
backupOperators Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier string[]
dns Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain string
domain Name of the Active Directory domain string
organizationalUnit The Organizational Unit (OU) within the Windows Active Directory string
password Plain text password of Active Directory domain administrator string
site The Active Directory site the service will limit Domain Controller discovery to string
smbServerName NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes string
status Status of the Active Directory string
username Username of Active Directory domain administrator string

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 resource type can be deployed to:

  • Resource groups

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

Resource format

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts@2020-02-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      activeDirectories = [
        {
          activeDirectoryId = "string"
          backupOperators = [
            "string"
          ]
          dns = "string"
          domain = "string"
          organizationalUnit = "string"
          password = "string"
          site = "string"
          smbServerName = "string"
          status = "string"
          username = "string"
        }
      ]
    }
  })
}

Property values

netAppAccounts

Name Description Value
type The resource type "Microsoft.NetApp/netAppAccounts@2020-02-01"
name The resource name string (required)

Character limit: 1-128

Valid characters:
Alphanumerics, underscores, and hyphens.

Start with alphanumeric.
location Resource location string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags Dictionary of tag names and values.
properties NetApp Account properties AccountProperties

AccountProperties

Name Description Value
activeDirectories Active Directories ActiveDirectory[]

ActiveDirectory

Name Description Value
activeDirectoryId Id of the Active Directory string
backupOperators Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier string[]
dns Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain string
domain Name of the Active Directory domain string
organizationalUnit The Organizational Unit (OU) within the Windows Active Directory string
password Plain text password of Active Directory domain administrator string
site The Active Directory site the service will limit Domain Controller discovery to string
smbServerName NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes string
status Status of the Active Directory string
username Username of Active Directory domain administrator string