page_type	languages	products	description
sample	powershell	azure azure-netapp-files	This project demonstrates how to create and update a Snapshot Policy for Microsoft.NetApp resource provider using PowerShell module.

Azure NetAppFiles Script Sample - Snapshot Policy for PowerShell

This project demonstrates how to use a PowerShell sample script to create and update a Snapshot Policy for the Microsoft.NetApp resource provider.

In this sample script we perform the following operations:

• Creations
  • Azure NetApp Files Account
  • Snapshot Policy
  • Capacity Pool
  • Volume
• Updates
  • Snapshot Policy
• Deletions
  • Volume
  • Capacity Pool
  • Snapshot Policy
  • Azure NetApp Files Account

Note: The cleanup execution is disabled by default. If you want to run this end to end with the cleanup, please change value of boolean variable 'CleanupResources' in CreateANFVolumeWithSnapshot.ps1

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

Prerequisites

1. Azure Subscription.
2. Subscription needs to have Azure NetApp Files resource provider registered. For more information, see Register for NetApp Resource Provider.
3. Resource Group created.
4. Virtual Network with a delegated subnet to Microsoft.Netapp/volumes resource. For more information, please refer to Guidelines for Azure NetApp Files network planning

What is netappfiles-powershell-snapshot-policy-script-sample doing?

This sample is dedicated to demonstrate how to create a Snapshot Policy using an ANF Account name in Azure NetApp Files. ANF 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 'CleanupResources' in the CreateANFVolumeWithSnapshot.ps1 class. If you want to erase all resources right after the creation operations, set this variable to 'true'. If any of the earlier operations fail for any reason, the cleanup of resources will have to be done manually.

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.

How the project is structured

The following table describes all files within this solution:

Folder	FileName	Description
Root	CreateANFVolumeWithSnapshot.ps1	Authenticates and executes all operations

How to run the script

1. Clone it locally

   git clone https://github.com/Azure-Samples/netappfiles-powershell-snapshot-policy-script-sample.git

2. Change folder to .netappfiles-powershell-snapshot-policy-script-sample\src
3. Open CreateANFVolumeWithSnapshot.ps1 and edit all the parameters
   • Save and close
   • Run the following command

   CreateANFVolumeWithSnapshot.ps1

Sample output

References

• Manage snapshots
• Resource limits for Azure NetApp Files
• Azure Cloud Shell
• Azure NetApp Files documentation
• Azure NetApp Files PowerShell