Skip to content
This repository was archived by the owner on Feb 15, 2024. It is now read-only.

Commit c4fac0d

Browse files
authored
Merge pull request #5 from b-juche/patch-2
edit ReadMe
2 parents 89e7e5b + 7f13c08 commit c4fac0d

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,32 @@ description: "This project demonstrates how to use Powershell with NetApp Files
1010

1111
# Azure NetAppFiles SDK NFSv3/NFS4.1 Sample Powershell
1212

13-
This project demonstrates how to deploy NFSv3/NFSv4.1 protocol type volume using Powershell and Azure NetApp Files SDK.
13+
This project demonstrates how to deploy a volume with the NFSv3/NFSv4.1 protocol type by using Powershell and Azure NetApp Files SDK.
1414

1515
In this sample application we perform the following operations:
1616

1717
* Creation
1818
* ANF Account
19-
* Capacity pool
19+
* Capacity pool
2020
* NFS Volume
2121

22-
* Deletion, the clean up process takes place (not enabled by default, please set the parameter CleanupResources to $true if you want the clean up code to take a place),deleting all resources in the reverse order following the hierarchy otherwise we can't remove resources that have nested resources still live.
22+
* Deletion
23+
The clean-up process takes place, deleting all resources in the reverse order following the hierarchy. You cannot remove resources that have nested resources still live.
24+
25+
Note that the clean-up operation is not enabled by default. You need to set the parameter CleanupResources to $true for the clean-up code to take effect.
2326

2427

2528
If you don't already have a Microsoft Azure subscription, you can get a FREE trial account [here](http://go.microsoft.com/fwlink/?LinkId=330212).
2629

2730
## Prerequisites
2831

2932
1. Azure Subscription
30-
1. Subscription needs to be enabled for Azure NetApp Files. For more information, please refer to [this](https://docs.microsoft.com/azure/azure-netapp-files/azure-netapp-files-register#waitlist) document.
31-
1. Resource Group created
32-
1. Virtual Network with a delegated subnet to Microsoft.Netapp/volumes resource. For more information, please refer to [Guidelines for Azure NetApp Files network planning](https://docs.microsoft.com/en-us/azure/azure-netapp-files/azure-netapp-files-network-topologies)
33-
1. Azure PowerShell, please refer to [Install Azure PowerShell](https://docs.microsoft.com/en-us/powershell/azure/install-az-ps?view=azps-4.8.0)
34-
1. Run the following PS command:
35-
* Install-Module Az.NetAppFiles
33+
1. Subscription needs to be enabled for Azure NetApp Files. See [Submit a waitlist request for accessing the service](https://docs.microsoft.com/azure/azure-netapp-files/azure-netapp-files-register#waitlist).
34+
1. Resource Group must be created
35+
1. Virtual Network with a delegated subnet to Microsoft.Netapp/volumes resource. For more information, see [Guidelines for Azure NetApp Files network planning](https://docs.microsoft.com/en-us/azure/azure-netapp-files/azure-netapp-files-network-topologies).
36+
1. Azure PowerShell. See [Install Azure PowerShell](https://docs.microsoft.com/en-us/powershell/azure/install-az-ps?view=azps-4.8.0).
37+
1. Run the following PS command:
38+
`Install-Module Az.NetAppFiles`
3639

3740

3841
# How the project is structured
@@ -42,18 +45,18 @@ The following table describes all files within this solution:
4245
| Folder | FileName | Description |
4346
|------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
4447
| src | CreateANFVolume.ps | Authenticates and executes all operations |
45-
| src\Common | CommonSDK.psm1 | PowerShell module that exposes some functions to perform creation and deletion Azure NetApp Files resource that calls the actual Az.NetAppFiles cmdlets |
46-
| src\Common | Utils.psm1 | Static class that exposes a few methods that helps on various tasks, like writting a log to the console for example. |
47-
| src\Common | AzureAuth.psm1 | PoweShell module that exposes functions to connect to Azure and choose target subscription |
48+
| src\Common | CommonSDK.psm1 | PowerShell module that exposes some functions to perform creation and deletion of Azure NetApp Files resource that calls the actual Az.NetAppFiles cmdlets |
49+
| src\Common | Utils.psm1 | Static class that exposes a few methods that are helpful for various tasks, such as writing a log to the console for example. |
50+
| src\Common | AzureAuth.psm1 | PoweShell module that exposes functions to connect to Azure and choose the target subscription |
4851

4952
# How to run the PowerShell script
5053

51-
1. Clone it locally
54+
1. Clone the repository locally
5255
```powershell
5356
git clone https://github.com/Azure-Samples/netappfiles-powershell-nfs-sdk-sample.git
5457
```
5558
56-
1. Modes: There are two options to run the script
59+
1. Use the basic mode or the advanced mode. There are two options to run the script:
5760
5861
Basic mode - Single script create Azure NetApp files with no validation.
5962
* Change folder to **netappfiles-powershell-nfs-sdk-sample\src\Basic**
@@ -102,15 +105,15 @@ The following table describes all files within this solution:
102105
103106
# Troubleshoot
104107
105-
If you encounter the below issue when running the PoweShell command
108+
If you encounter the following issue when running the PoweShell command:
106109
107110
```
108111
.\CreateANFVolume.ps1 : .\CreateANFVolume.ps1 cannot be loaded. The file .\CreateANFVolume.ps1 is not digitally signed. You cannot
109112
run this script on the current system.
110113
```
111114
112-
Run the following command
113-
Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Bypass
115+
Run the following command:
116+
`Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Bypass`
114117
115118
# References
116119

0 commit comments

Comments
 (0)