Azure NetAppFiles SDK Sample - Snapshot policy for Java

This project demonstrates how to use a Java sample application to create a snapshot policy for the Microsoft.NetApp resource provider.

In this sample application we perform the following operations:

• Creations
  • NetApp account
  • Snapshot policy
  • Capacity pool
  • Volume
• Updates
  • Snapshot policy
• Deletions
  • Volume
  • Snapshot policy
  • Capacity pool
  • NetApp account

Note: The cleanup execution is disabled by default. If you want to run this end to end with the cleanup, simply change the value of Boolean variable 'cleanup' in main.java.

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

Prerequisites

1. This project is built upon Maven, which must be installed in order to run the sample. See instructions on installing Maven.
2. The sample is written in Java 11. The Maven compiler's target Java version is therefore Java 11, and the JAVA_HOME environment variable must be set to Java 11 or a newer version. See instructions on setting JAVA_HOME for windows, and instructions on setting JAVA_HOME for macOS.
3. Azure subscription
4. Subscription needs to have Azure NetApp Files resource provider registered. For more information, see Register for NetApp Resource Provider.
5. Subscription needs to be enabled for Azure NetApp Files. For more information, see Submit a waitlist request for accessing the service.
6. Resource Group created
7. Virtual Network with a delegated subnet to Microsoft.Netapp/volumes resource. For more information, see Guidelines for Azure NetApp Files network planning. 8.For this sample console application to work, authentication is needed. We will use Service Principal based authentication

   1. Within an Azure Cloud Shell session, make sure you're logged in 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>  

   2. 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.

   3. Set the following environment variables from the output of the creation:

      Powershell

      $env:AZURE_SUBSCRIPTION_ID = <subscriptionId>
      $env:AZURE_CLIENT_ID = <clientId>
      $env:AZURE_CLIENT_SECRET = <clientSecret>
      $env:AZURE_TENANT_ID = <tenantId>

      Bash

      export AZURE_SUBSCRIPTION_ID=<subscriptionId>
      export AZURE_CLIENT_ID=<clientId>
      export AZURE_CLIENT_SECRET=<clientSecret>
      export AZURE_TENANT_ID=<tenantId>

What does netappfiles-java-snapshot-policy-sdk-sample do?

This sample demonstrates how to create a snapshot policy using a NetApp account name in Azure NetApp Files. Similar to other Azure NetApp Files SDK examples, the authentication method is based on a service principal. This project will first create a NetApp account and then a snapshot policy that is tied to that Account. Afterwards, it will create a capacity pool within the account and finally a single volume that uses the newly created snapshot policy.

There is a section in the code dedicated to remove created resources. By default, this script will not remove all created resources; this behavior is controlled by a boolean variable called 'cleanup'. If you want to erase all resources right after the creation operations, set this variable to 'true'.

A snapshot policy uses schedules to create snapshots of volumes that can be hourly, daily, weekly, monthly. The snapshot policy will also determine how many snapshots to keep. The sample will create a snapshot policy with all schedules and then update a single schedule within the policy, changing the value of the schedule's snapshots to keep.

Note: This sample does not have a specific retrieve section, because we perform get operations in several places throughout the code.

How the project is structured

The following table describes all files within this solution:

\^ == src/main/java/snapshotpolicy/sdk/sample

How to run the console application

1. Clone the SDK sample locally:

   git clone https://github.com/Azure-Samples/netappfiles-java-snapshot-policy-sdk-sample

2. Change folder to .\netappfiles-java-snapshot-policy-sdk-sample.
3. Make sure you have the azureauth.json and its environment variable with the path to it defined (as previously described).
4. Make sure the JAVA_HOME environment variable is pointing to version 11 of Java or newer (see Prerequisites for instructions).
5. In the main.java class, change the values of the variables within the runAsync() function to reflect your environment:
6. Compile the console application:

   mvn clean compile

7. Run the console application:

   mvn exec:java -Dexec.mainClass="snapshotpolicy.sdk.sample.main"

Sample output

References

• Manage snapshots by using Azure NetApp Files
• Resource limits for Azure NetApp Files
• Azure Cloud Shell
• Azure NetApp Files documentation
• Download Azure SDKs