Microsoft.NetApp netAppAccounts 2020-08-01

01/14/2021
2 minutes to read

Template format

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

{
  "name": "string",
  "type": "Microsoft.NetApp/netAppAccounts",
  "apiVersion": "2020-08-01",
  "location": "string",
  "tags": {},
  "properties": {
    "activeDirectories": [
      {
        "activeDirectoryId": "string",
        "username": "string",
        "password": "string",
        "domain": "string",
        "dns": "string",
        "smbServerName": "string",
        "organizationalUnit": "string",
        "site": "string",
        "backupOperators": [
          "string"
        ],
        "kdcIP": "string",
        "adName": "string",
        "serverRootCACertificate": "string",
        "aesEncryption": "boolean",
        "ldapSigning": "boolean"
      }
    ]
  },
  "resources": []
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.NetApp/netAppAccounts object

Name	Type	Required	Value
name	string	Yes	The name of the NetApp account
type	enum	Yes	Microsoft.NetApp/netAppAccounts
apiVersion	enum	Yes	2020-08-01
location	string	Yes	Resource location
tags	object	No	Resource tags
properties	object	Yes	NetApp Account properties - AccountProperties object
resources	array	No	backupPolicies snapshotPolicies capacityPools

AccountProperties object

Name	Type	Required	Value
activeDirectories	array	No	Active Directories - ActiveDirectory object

ActiveDirectory object

Name	Type	Required	Value
activeDirectoryId	string	No	Id of the Active Directory
username	string	No	Username of Active Directory domain administrator
password	string	No	Plain text password of Active Directory domain administrator, value is masked in the response
domain	string	No	Name of the Active Directory domain
dns	string	No	Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain
smbServerName	string	No	NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes
organizationalUnit	string	No	The Organizational Unit (OU) within the Windows Active Directory
site	string	No	The Active Directory site the service will limit Domain Controller discovery to
backupOperators	array	No	Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier - string
kdcIP	string	No	kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.
adName	string	No	Name of the active directory machine. This optional parameter is used only while creating kerberos volume
serverRootCACertificate	string	No	When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.
aesEncryption	boolean	No	If enabled, AES encryption will be enabled for SMB communication.
ldapSigning	boolean	No	Specifies whether or not the LDAP traffic needs to be signed.

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.