This project demonstrates how to create SMB volumes using Microsoft.NetApp resource provider Go SDK.

In this sample application we perform the following operations:

• Creation
  • NetApp Files Account
  • Capacity Pool
  • SMB Volume
• Deletions (when cleanup variable is set to true)
  • Volume
  • Capacity Pool
  • Account

If you don't already have a Microsoft Azure subscription, you can get a FREE trial account here.

1. Go installed (if not installed yet, follow the official instructions)

2. Azure Subscription

3. Subscription needs to have Azure NetApp Files resource provider registered. For more information, see Register for NetApp Resource Provider.

4. Resource Group created

5. Virtual Network with a delegated subnet to Microsoft.Netapp/volumes resource. For more information, please refer to Guidelines for Azure NetApp Files network planning

6. Active Directory infrastructure setup with one or more DNS servers from the AD domain (usually the Domain Controllers) available in the same virtual network where you're setting up Azure NetApp Files. If you want to setup an Active Directory test environment, please refer to Create a new Windows VM and create a new AD Forest, Domain and DC for a quick setup, then you can create the subnet delegated to Microsoft.Netapp/volumes in the vnet that is created.

7. Adjust variable contents within var() block at example.go file to match your environment

8. For this sample Go console application work, we need to authenticate and the chosen method for this sample is using service principals.

   1. For this sample Go console application work, we need to authenticate and the chosen method for this sample is using service principals:

   • Within an Azure Cloud Shell session, make sure you're logged on at the subscription where you want to be associated with the service principal by default

     az account show

     If this is not the correct subscription, use

     az account set -s <subscription name or id>  

   • Create a service principal using Azure CLI

     az ad sp create-for-rbac --sdk-auth

     Note: this command will automatically assign RBAC contributor role to the service principal at subscription level, you can narrow down the scope to the specific resource group where your tests will create the resources.

   • Copy the output content and paste it in a file called azureauth.json and secure it with file system permissions (make sure it is not inside of any repo)

   • Set an environment variable pointing to the file path you just created, here is an example with Powershell and bash:

     Powershell

     [Environment]::SetEnvironmentVariable("AZURE_AUTH_LOCATION", "C:\sdksample\azureauth.json", "User")

     Bash

     export AZURE_AUTH_LOCATION=/sdksamples/azureauth.json

   Note: for other Azure Active Directory authentication methods for Go, please refer to Authentication methods in the Azure SDK for Go.

This sample project is focused on demonstrating how to create an SMB enabled volume, similar to other examples, the authentication method is based on a service principal, this project will create one ANF Account with an Active Directory object, one capacity pool and finally, a single SMB volume using Standard service level tier. When executing this application, the user will be prompted to provide the password for the Active Directory User that have permissions to domain join computers in AD.

In addition, we use some non-sensitive information from the file-based authentication file that in the initial stages we get the subscription ID and this is used for the test we perform to check if the subnet provided exists before starting creating any ANF resources, failing execution if they're missing.

Authentication is made on each operation where we obtain an authorizer to pass to each client we instantiate (in Azure Go SDK for NetAppFiles each resource has its own client). For more information about the authentication process used, refer to Use file-based authentication section of Authentication methods in the Azure SDK for Go document.

Lastly, the clean up process takes place (not enabled by default, please change variable shouldCleanUp to true at example.go file var() section to enable it), deleting all resources in the reverse order following the hierarchy otherwise we can't remove resources that have nested resources. If there is an error during the application execution, clean up does might not take place and you will need to manually perform this task. You will notice that the clean up process uses a function called WaitForNoANFResource while other parts of the code uses WaitForANFResource, at this moment this is required so we can workaround a current ARM behavior of reporting that the object was deleted when in fact its deletion is still in progress, similarly, stating that volume is fully created while this is still finishing up. Also, we will see some functions called GetANF<resource type>, these were created in this sample to be able to get the name of the resource without its hierarchy represented in the <resource type>.name property, which cannot be used directly in other methods of Azure NetApp Files client like get.

Note: Please refer to Resource limits for Azure NetApp Files to understand ANF's most current limits.

1. Go to your GOPATH folder and create the following path

   # PowerShell example
   cd $env:GOPATH/src
   mkdir ./github.com/Azure-Samples

   # Bash example
   cd $GOPATH/src
   mkdir -p ./github.com/Azure-Samples

2. Clone it locally

   cd github.com/Azure-Samples
   git clone https://github.com/Azure-Samples/netappfiles-go-smb-sdk-sample.git

3. Change folder to netappfiles-go-smb-sdk-sample/netappfiles-go-smb-sdk-sample

   cd netappfiles-go-smb-sdk-sample/netappfiles-go-smb-sdk-sample

4. Make sure you have the azureauth.json and its environment variable with the path to it defined (as previously described at prerequisites)

5. Edit file example.go var() block and change the variables contents as appropriate (names are self-explanatory).

6. Run the sample

   go run .

Sample output

• Create an SMB volume for Azure NetApp Files
• Authentication methods in the Azure SDK for Go
• Azure SDK for Go Samples - contains other resource types samples
• Resource limits for Azure NetApp Files
• Azure Cloud Shell
• Azure NetApp Files documentation
• Azure SDK for Go