Share via

Microsoft.NetApp netAppAccounts 2020-08-01

Bicep resource definition

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

resource symbolicname 'Microsoft.NetApp/netAppAccounts@2020-08-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    activeDirectories: [
      {
        activeDirectoryId: 'string'
        adName: 'string'
        aesEncryption: bool
        backupOperators: [
          'string'
        ]
        dns: 'string'
        domain: 'string'
        kdcIP: 'string'
        ldapSigning: bool
        organizationalUnit: 'string'
        password: 'string'
        serverRootCACertificate: 'string'
        site: 'string'
        smbServerName: 'string'
        username: 'string'
      }
    ]
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.NetApp/netAppAccounts

Name Description Value
location Resource location string (required)
name The resource name string (required)
properties NetApp Account properties AccountProperties
scope Use when creating a resource at a scope that is different than the deployment scope. Set this property to the symbolic name of a resource to apply the extension resource.
tags Resource tags Dictionary of tag names and values. See Tags in templates

AccountProperties

Name Description Value
activeDirectories Active Directories ActiveDirectory[]

ActiveDirectory

Name Description Value
activeDirectoryId Id of the Active Directory string
adName Name of the active directory machine. This optional parameter is used only while creating kerberos volume string

Constraints:
Min length = 1
Max length = 64
aesEncryption If enabled, AES encryption will be enabled for SMB communication. bool
backupOperators Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier string

Constraints:
Min length = 1
Max length = 255[]
dns Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain string

Constraints:
Pattern = ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
domain Name of the Active Directory domain string
kdcIP kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume. string

Constraints:
Pattern = ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
ldapSigning Specifies whether or not the LDAP traffic needs to be signed. bool
organizationalUnit The Organizational Unit (OU) within the Windows Active Directory string
password Plain text password of Active Directory domain administrator, value is masked in the response string
serverRootCACertificate 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. string

Constraints:
Min length = 1
Max length = 10240
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
username A domain user account with permission to create machine accounts string

ResourceTags

Name Description Value

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Azure NetApp File AVM Resource Module for Azure NetApp File

ARM template resource definition

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

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

Property Values

Microsoft.NetApp/netAppAccounts

Name Description Value
apiVersion The api version '2020-08-01'
location Resource location string (required)
name The resource name string (required)
properties NetApp Account properties AccountProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.NetApp/netAppAccounts'

AccountProperties

Name Description Value
activeDirectories Active Directories ActiveDirectory[]

ActiveDirectory

Name Description Value
activeDirectoryId Id of the Active Directory string
adName Name of the active directory machine. This optional parameter is used only while creating kerberos volume string

Constraints:
Min length = 1
Max length = 64
aesEncryption If enabled, AES encryption will be enabled for SMB communication. bool
backupOperators Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier string

Constraints:
Min length = 1
Max length = 255[]
dns Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain string

Constraints:
Pattern = ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
domain Name of the Active Directory domain string
kdcIP kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume. string

Constraints:
Pattern = ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
ldapSigning Specifies whether or not the LDAP traffic needs to be signed. bool
organizationalUnit The Organizational Unit (OU) within the Windows Active Directory string
password Plain text password of Active Directory domain administrator, value is masked in the response string
serverRootCACertificate 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. string

Constraints:
Min length = 1
Max length = 10240
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
username A domain user account with permission to create machine accounts string

ResourceTags

Name Description Value

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.NetApp/netAppAccounts@2020-08-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      activeDirectories = [
        {
          activeDirectoryId = "string"
          adName = "string"
          aesEncryption = bool
          backupOperators = [
            "string"
          ]
          dns = "string"
          domain = "string"
          kdcIP = "string"
          ldapSigning = bool
          organizationalUnit = "string"
          password = "string"
          serverRootCACertificate = "string"
          site = "string"
          smbServerName = "string"
          username = "string"
        }
      ]
    }
  }
}

Property Values

Microsoft.NetApp/netAppAccounts

Name Description Value
location Resource location string (required)
name The resource name string (required)
parent_id The ID of the resource to apply this extension resource to. string (required)
properties NetApp Account properties AccountProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.NetApp/netAppAccounts@2020-08-01"

AccountProperties

Name Description Value
activeDirectories Active Directories ActiveDirectory[]

ActiveDirectory

Name Description Value
activeDirectoryId Id of the Active Directory string
adName Name of the active directory machine. This optional parameter is used only while creating kerberos volume string

Constraints:
Min length = 1
Max length = 64
aesEncryption If enabled, AES encryption will be enabled for SMB communication. bool
backupOperators Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier string

Constraints:
Min length = 1
Max length = 255[]
dns Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain string

Constraints:
Pattern = ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
domain Name of the Active Directory domain string
kdcIP kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume. string

Constraints:
Pattern = ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
ldapSigning Specifies whether or not the LDAP traffic needs to be signed. bool
organizationalUnit The Organizational Unit (OU) within the Windows Active Directory string
password Plain text password of Active Directory domain administrator, value is masked in the response string
serverRootCACertificate 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. string

Constraints:
Min length = 1
Max length = 10240
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
username A domain user account with permission to create machine accounts string

ResourceTags

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying NetApp Account.

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" "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    = ["*"]
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Azure NetApp File AVM Resource Module for Azure NetApp File
  • Last updated on