Accounts - Create Or Update

Service:

Azure NetApp Files

API Version:

2023-07-01

Create or update a NetApp account
Create or update the specified NetApp account within the resource group

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}?api-version=2023-07-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the NetApp account Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string	The geo-location where the resource lives
identity		ManagedServiceIdentity	The identity used for the resource.
properties.activeDirectories		activeDirectory[]	Active Directories
properties.encryption		accountEncryption	Encryption settings
tags		object	Resource tags.

Responses

Name	Type	Description
200 OK	netAppAccount	OK - account updated
201 Created	netAppAccount	Account created
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Accounts_CreateOrUpdate

Accounts_CreateOrUpdateWithActiveDirectory

Accounts_CreateOrUpdate

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1?api-version=2023-07-01

{
  "location": "eastus",
  "properties": {}
}

Java

import com.azure.resourcemanager.netapp.models.ActiveDirectory;
import java.util.Arrays;

/**
 * Samples for Accounts CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdate.json
     */
    /**
     * Sample code: Accounts_CreateOrUpdate.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void accountsCreateOrUpdate(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.accounts().define("account1").withRegion("eastus").withExistingResourceGroup("myRG").create();
    }

    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdateAD.json
     */
    /**
     * Sample code: Accounts_CreateOrUpdateWithActiveDirectory.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void
        accountsCreateOrUpdateWithActiveDirectory(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        manager.accounts().define("account1").withRegion("eastus").withExistingResourceGroup("myRG")
            .withActiveDirectories(Arrays.asList(new ActiveDirectory().withUsername("ad_user_name")
                .withPassword("fakeTokenPlaceholder").withDomain("10.10.10.3").withDns("10.10.10.3")
                .withSmbServerName("SMBServer").withOrganizationalUnit("OU=Engineering").withSite("SiteName")
                .withAesEncryption(true).withLdapSigning(false).withLdapOverTls(false)))
            .create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python accounts_create_or_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
    )

    response = client.accounts.begin_create_or_update(
        resource_group_name="myRG",
        account_name="account1",
        body={"location": "eastus", "properties": {}},
    ).result()
    print(response)


# x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdate.json
func ExampleAccountsClient_BeginCreateOrUpdate_accountsCreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginCreateOrUpdate(ctx, "myRG", "account1", armnetapp.Account{
		Location:   to.Ptr("eastus"),
		Properties: &armnetapp.AccountProperties{},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armnetapp.Account{
	// 	Name: to.Ptr("account1"),
	// 	Type: to.Ptr("Microsoft.NetApp/netAppAccounts"),
	// 	ID: to.Ptr("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armnetapp.AccountProperties{
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update the specified NetApp account within the resource group
 *
 * @summary Create or update the specified NetApp account within the resource group
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdate.json
 */
async function accountsCreateOrUpdate() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
  const resourceGroupName = process.env["NETAPP_RESOURCE_GROUP"] || "myRG";
  const accountName = "account1";
  const body = { location: "eastus" };
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.accounts.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    body,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.NetApp;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdate.json
// this example is just showing the usage of "Accounts_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
string resourceGroupName = "myRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NetAppAccountResource
NetAppAccountCollection collection = resourceGroupResource.GetNetAppAccounts();

// invoke the operation
string accountName = "account1";
NetAppAccountData data = new NetAppAccountData(new AzureLocation("eastus"));
ArmOperation<NetAppAccountResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, accountName, data);
NetAppAccountResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
NetAppAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
  "name": "account1",
  "type": "Microsoft.NetApp/netAppAccounts",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded"
  }
}

Status code:

201

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
  "name": "account1",
  "type": "Microsoft.NetApp/netAppAccounts",
  "location": "eastus",
  "properties": {
    "provisioningState": "Creating"
  }
}

Accounts_CreateOrUpdateWithActiveDirectory

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1?api-version=2023-07-01

{
  "location": "eastus",
  "properties": {
    "activeDirectories": [
      {
        "site": "SiteName",
        "username": "ad_user_name",
        "password": "ad_password",
        "domain": "10.10.10.3",
        "dns": "10.10.10.3",
        "smbServerName": "SMBServer",
        "organizationalUnit": "OU=Engineering",
        "aesEncryption": true,
        "ldapSigning": false,
        "ldapOverTLS": false
      }
    ]
  }
}

Java

No code sample is available. To request a code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.netapp import NetAppManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-netapp
# USAGE
    python accounts_create_or_update_ad.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = NetAppManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="D633CC2E-722B-4AE1-B636-BBD9E4C60ED9",
    )

    response = client.accounts.begin_create_or_update(
        resource_group_name="myRG",
        account_name="account1",
        body={
            "location": "eastus",
            "properties": {
                "activeDirectories": [
                    {
                        "aesEncryption": True,
                        "dns": "10.10.10.3",
                        "domain": "10.10.10.3",
                        "ldapOverTLS": False,
                        "ldapSigning": False,
                        "organizationalUnit": "OU=Engineering",
                        "password": "ad_password",
                        "site": "SiteName",
                        "smbServerName": "SMBServer",
                        "username": "ad_user_name",
                    }
                ]
            },
        },
    ).result()
    print(response)


# x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdateAD.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v6"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdateAD.json
func ExampleAccountsClient_BeginCreateOrUpdate_accountsCreateOrUpdateWithActiveDirectory() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewAccountsClient().BeginCreateOrUpdate(ctx, "myRG", "account1", armnetapp.Account{
		Location: to.Ptr("eastus"),
		Properties: &armnetapp.AccountProperties{
			ActiveDirectories: []*armnetapp.ActiveDirectory{
				{
					AesEncryption:      to.Ptr(true),
					DNS:                to.Ptr("10.10.10.3"),
					Domain:             to.Ptr("10.10.10.3"),
					LdapOverTLS:        to.Ptr(false),
					LdapSigning:        to.Ptr(false),
					OrganizationalUnit: to.Ptr("OU=Engineering"),
					Password:           to.Ptr("ad_password"),
					Site:               to.Ptr("SiteName"),
					SmbServerName:      to.Ptr("SMBServer"),
					Username:           to.Ptr("ad_user_name"),
				}},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Account = armnetapp.Account{
	// 	Name: to.Ptr("account1"),
	// 	Type: to.Ptr("Microsoft.NetApp/netAppAccounts"),
	// 	ID: to.Ptr("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armnetapp.AccountProperties{
	// 		ActiveDirectories: []*armnetapp.ActiveDirectory{
	// 			{
	// 				ActiveDirectoryID: to.Ptr("503d38f9-f17c-f92d-ef26-b0d46374534b"),
	// 				AesEncryption: to.Ptr(true),
	// 				DNS: to.Ptr("10.10.10.3"),
	// 				Domain: to.Ptr("10.10.10.3"),
	// 				LdapOverTLS: to.Ptr(false),
	// 				LdapSigning: to.Ptr(false),
	// 				OrganizationalUnit: to.Ptr("OU=Engineering"),
	// 				Site: to.Ptr("SiteName"),
	// 				SmbServerName: to.Ptr("SMBServer"),
	// 				Username: to.Ptr("ad_user_name"),
	// 		}},
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Create or update the specified NetApp account within the resource group
 *
 * @summary Create or update the specified NetApp account within the resource group
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdateAD.json
 */
async function accountsCreateOrUpdateWithActiveDirectory() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
  const resourceGroupName = process.env["NETAPP_RESOURCE_GROUP"] || "myRG";
  const accountName = "account1";
  const body = {
    activeDirectories: [
      {
        aesEncryption: true,
        dns: "10.10.10.3",
        domain: "10.10.10.3",
        ldapOverTLS: false,
        ldapSigning: false,
        organizationalUnit: "OU=Engineering",
        password: "ad_password",
        site: "SiteName",
        smbServerName: "SMBServer",
        username: "ad_user_name",
      },
    ],
    location: "eastus",
  };
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.accounts.beginCreateOrUpdateAndWait(
    resourceGroupName,
    accountName,
    body,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.NetApp;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/stable/2023-07-01/examples/Accounts_CreateOrUpdateAD.json
// this example is just showing the usage of "Accounts_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
string resourceGroupName = "myRG";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this NetAppAccountResource
NetAppAccountCollection collection = resourceGroupResource.GetNetAppAccounts();

// invoke the operation
string accountName = "account1";
NetAppAccountData data = new NetAppAccountData(new AzureLocation("eastus"))
{
    ActiveDirectories =
    {
    new NetAppAccountActiveDirectory()
    {
    Username = "ad_user_name",
    Password = "ad_password",
    Domain = "10.10.10.3",
    Dns = "10.10.10.3",
    SmbServerName = "SMBServer",
    OrganizationalUnit = "OU=Engineering",
    Site = "SiteName",
    IsAesEncryptionEnabled = true,
    IsLdapSigningEnabled = false,
    IsLdapOverTlsEnabled = false,
    }
    },
};
ArmOperation<NetAppAccountResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, accountName, data);
NetAppAccountResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
NetAppAccountData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
  "name": "account1",
  "type": "Microsoft.NetApp/netAppAccounts",
  "location": "eastus",
  "properties": {
    "provisioningState": "Succeeded",
    "activeDirectories": [
      {
        "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b",
        "site": "SiteName",
        "username": "ad_user_name",
        "password": null,
        "domain": "10.10.10.3",
        "dns": "10.10.10.3",
        "smbServerName": "SMBServer",
        "organizationalUnit": "OU=Engineering",
        "aesEncryption": true,
        "ldapSigning": false,
        "ldapOverTLS": false
      }
    ]
  }
}

Status code:

201

{
  "id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1",
  "name": "account1",
  "type": "Microsoft.NetApp/netAppAccounts",
  "location": "eastus",
  "properties": {
    "provisioningState": "Creating",
    "activeDirectories": [
      {
        "activeDirectoryId": "503d38f9-f17c-f92d-ef26-b0d46374534b",
        "site": "SiteName",
        "username": "ad_user_name",
        "password": null,
        "domain": "10.10.10.3",
        "dns": "10.10.10.3",
        "smbServerName": "SMBServer",
        "organizationalUnit": "OU=Engineering",
        "aesEncryption": true,
        "ldapSigning": false,
        "ldapOverTLS": false
      }
    ]
  }
}

Definitions

Name	Description
accountEncryption	Encryption settings
activeDirectory	Active Directory
ActiveDirectoryStatus	Status of the Active Directory
createdByType	The type of identity that created the resource.
EncryptionIdentity	Identity used to authenticate with key vault.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
KeySource	The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault
KeyVaultProperties	Properties of key vault.
KeyVaultStatus	Status of the KeyVault connection.
ldapSearchScopeOpt	LDAP search scope
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
netAppAccount	NetApp account resource
systemData	Metadata pertaining to creation and last modification of the resource.
UserAssignedIdentity	User assigned identity properties

accountEncryption

Encryption settings

Name	Type	Default Value	Description
identity	EncryptionIdentity		Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'.
keySource	KeySource	Microsoft.NetApp	The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault
keyVaultProperties	KeyVaultProperties		Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'.

activeDirectory

Active Directory

Name	Type	Default Value	Description
activeDirectoryId	string		Id of the Active Directory
adName	string		Name of the active directory machine. This optional parameter is used only while creating kerberos volume
administrators	string[]		Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier
aesEncryption	boolean		If enabled, AES encryption will be enabled for SMB communication.
allowLocalNfsUsersWithLdap	boolean		If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.
backupOperators	string[]		Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier
dns	string		Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain
domain	string		Name of the Active Directory domain
encryptDCConnections	boolean		If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted.
kdcIP	string		kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.
ldapOverTLS	boolean		Specifies whether or not the LDAP traffic needs to be secured via TLS.
ldapSearchScope	ldapSearchScopeOpt		LDAP Search scope options
ldapSigning	boolean		Specifies whether or not the LDAP traffic needs to be signed.
organizationalUnit	string	CN=Computers	The Organizational Unit (OU) within the Windows Active Directory
password	string		Plain text password of Active Directory domain administrator, value is masked in the response
preferredServersForLdapClient	string		Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.
securityOperators	string[]		Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier
serverRootCACertificate	string		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.
site	string		The Active Directory site the service will limit Domain Controller discovery to
smbServerName	string		NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes
status	ActiveDirectoryStatus		Status of the Active Directory
statusDetails	string		Any details in regards to the Status of the Active Directory
username	string		A domain user account with permission to create machine accounts

ActiveDirectoryStatus

Status of the Active Directory

Name	Type	Description
Created	string	Active Directory created but not in use
Deleted	string	Active Directory Deleted
Error	string	Error with the Active Directory
InUse	string	Active Directory in use by SMB Volume
Updating	string	Active Directory Updating

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

EncryptionIdentity

Identity used to authenticate with key vault.

Name	Type	Description
principalId	string	The principal ID (object ID) of the identity used to authenticate with key vault. Read-only.
userAssignedIdentity	string	The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

KeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault

Name	Type	Description
Microsoft.KeyVault	string	Customer-managed key encryption
Microsoft.NetApp	string	Microsoft-managed key encryption

KeyVaultProperties

Properties of key vault.

Name	Type	Description
keyName	string	The name of KeyVault key.
keyVaultId	string	UUID v4 used to identify the Azure Key Vault configuration
keyVaultResourceId	string	The resource ID of KeyVault.
keyVaultUri	string	The Uri of KeyVault.
status	KeyVaultStatus	Status of the KeyVault connection.

KeyVaultStatus

Status of the KeyVault connection.

Name	Type	Description
Created	string	KeyVault connection created but not in use
Deleted	string	KeyVault connection Deleted
Error	string	Error with the KeyVault connection
InUse	string	KeyVault connection in use by SMB Volume
Updating	string	KeyVault connection Updating

ldapSearchScopeOpt

LDAP search scope

Name	Type	Description
groupDN	string	This specifies the group DN, which overrides the base DN for group lookups.
groupMembershipFilter	string	This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server.
userDN	string	This specifies the user DN, which overrides the base DN for user lookups.

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Name	Type	Description
None	string
SystemAssigned	string
SystemAssigned,UserAssigned	string
UserAssigned	string

netAppAccount

NetApp account resource

Name	Type	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	The identity used for the resource.
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.activeDirectories	activeDirectory[]	Active Directories
properties.disableShowmount	boolean	Shows the status of disableShowmount for all volumes under the subscription, null equals false
properties.encryption	accountEncryption	Encryption settings
properties.provisioningState	string	Azure lifecycle management
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserAssignedIdentity

User assigned identity properties

Name	Type	Description
clientId	string	The client ID of the assigned identity.
principalId	string	The principal ID of the assigned identity.