Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

format the help markdown file of Az.NetAppFiles #18455

Merged
merged 3 commits into from
Jun 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Get the status of the replication

### Example 1
```powershell
Get-AzNetAppFilesReplicationStatus -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -PoolName "MyDestinationPool" -VolumeName "MyVol"
Get-AzNetAppFilesReplicationStatus -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyVol"
```

```output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,10 @@ The **Get-AzNetAppFilesSubvolume** cmdlet gets details of an ANF Subvolume.

### Example 1
```powershell
PS C:\> Get-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume"
Get-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume"
```

```output
ResourceGroupName : myrg
Id : /subscriptions/69a75bda-882e-44d5-8431-63421204132a/resourceGroups/myrg/providers/Microsoft.NetApp/netAppAccounts/myanfaccount/capacityPools/myanfpool/volumes/myanfvolume/subvolumes/myanfsubvolume
Name : myanfaccount/myanfpool/myanfvolume/myanfsubvolume
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,16 @@ Get-AzNetAppFilesSubvolumeMetadata -Name <String> -VolumeObject <PSNetAppFilesVo
```

## DESCRIPTION
The **Get-AzNetAppFilesSubvolume** cmdlet gets metadata details of an ANF Subvolume.
The **Get-AzNetAppFilesSubvolumeMetadata** cmdlet gets metadata details of an ANF Subvolume.

## EXAMPLES

### Example 1
```powershell
PS C:\> Get-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume"
Get-AzNetAppFilesSubvolumeMetadata -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume"
```

```output
ResourceGroupName : myrg
Id : /subscriptions/69a75bda-882e-44d5-8431-63421204132a/resourceGroups/myrg/providers/Microsoft.NetApp/netAppAccounts/myanfaccount/capacityPools/myanfpool/volumes/myanfvolume/subvolumes/myanfsubvolume
Name : myanfaccount/myanfpool/myanfvolume/myanfsubvolume
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The **Get-AzNetAppFilesVolumeGroup** cmdlet gets details of an ANF VolumeGroup.

### Example 1
```powershell
PS C:\> Get-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyAnfVolumeGroup"
Get-AzNetAppFilesVolumeGroup -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyAnfVolumeGroup"
```

This command gets the volume named MyAnfVolumeGroup from the Account "MyAnfAccount".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The **New-AzNetAppFilesActiveDirectory** cmdlet creates a new active directory c
### Example 1
```powershell
$pwd_secure_string = Read-Host "Enter a Password" -AsSecureString
New-AzNetAppFilesActiveDirectory -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAccount" -AdName "MyADName" -Username "AdUserName" -Password $pwd_secure_string -Domain "AdDomain" -Dns "192.0.2.2" -SmbServerName "AdSmbServerName"
New-AzNetAppFilesActiveDirectory -ResourceGroupName "MyRG" -AccountName "MyAccount" -AdName "MyADName" -Username "AdUserName" -Password $pwd_secure_string -Domain "AdDomain" -Dns "192.0.2.2" -SmbServerName "AdSmbServerName"
```

This command gets the AD password from promt into a secreates the new Active Directory configuration for the ANF account "MyAnfAccount".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ New-AzNetAppFilesBackupPolicy -Name <String> [-Enabled] [-DailyBackupsToKeep <In
```

## DESCRIPTION
The **New-AzNetAppFilesActiveDirectory** cmdlet creates a new backup policy for an ANF account.
The **New-AzNetAppFilesBackupPolicy** cmdlet creates a new backup policy for an ANF account.

## EXAMPLES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ Each ExportPolicy object consists of a set of ExportPolicy rules that can be app

### Example 1
```powershell
PS C:\> $exportPolicyRule = New-NetAppFilesAzExportPolicyRuleObject -RuleIndex 1 -AllowedClients '0.0.0.0/0' -UnixReadOnly -UnixReadWrite -Cifs -Nfsv3
PS C:\> $exportPolicyRules = $($exportPolicyRule)
PS C:\> $newExportPolicy = New-NetAppFilesAzExportPolicyObject -Rules $exportPolicyRules
PS C:\> New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -l "westus2" -CreationToken "MyAnfVolume" -UsageThreshold 1099511627776 -ServiceLevel "Premium" -SubnetId "/subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/MySubNetName" -ExportPolicy $newExportPolicy
$exportPolicyRule = New-AzNetAppFilesExportPolicyRuleObject -RuleIndex 1 -AllowedClient '0.0.0.0/0' -UnixReadOnly -UnixReadWrite -Cifs -Nfsv3
$exportPolicyRules = $($exportPolicyRule)
$newExportPolicy = New-AzNetAppFilesExportPolicyObject -Rule $exportPolicyRules
New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -Location "westus2" -CreationToken "MyAnfVolume" -UsageThreshold 1099511627776 -ServiceLevel "Premium" -SubnetId "/subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/MySubNetName" -ExportPolicy $newExportPolicy
```

This example creates an ExportPolicyRule in variable $exportPolicyRule, sets it an export policy object $exportPolicyRules that is then used in the creation of an AFN volume "MyAnfVolume""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ New-AzNetAppFilesExportPolicyRuleObject is a helper cmdlet that creates an expor

### Example 1
```powershell
PS C:\> $exportPolicyRule = New-AzNetAppFilesExportPolicyRuleObject -RuleIndex 1 -AllowedClients '0.0.0.0/0' -UnixReadOnly -UnixReadWrite -Cifs -Nfsv3
PS C:\> $exportPolicyRules = $($exportPolicyRule)
PS C:\> $newExportPolicy = New-AzNetAppFilesExportPolicyObject -Rules $exportPolicyRules
PS C:\> New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -l "westus2" -CreationToken "MyAnfVolume" -UsageThreshold 1099511627776 -ServiceLevel "Premium" -SubnetId "/subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/MySubNetName" -ExportPolicy $newExportPolicy
$exportPolicyRule = New-AzNetAppFilesExportPolicyRuleObject -RuleIndex 1 -AllowedClient '0.0.0.0/0' -UnixReadOnly -UnixReadWrite -Cifs -Nfsv3
$exportPolicyRules = $($exportPolicyRule)
$newExportPolicy = New-AzNetAppFilesExportPolicyObject -Rule $exportPolicyRules
New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -Location "westus2" -CreationToken "MyAnfVolume" -UsageThreshold 1099511627776 -ServiceLevel "Premium" -SubnetId "/subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/MySubNetName" -ExportPolicy $newExportPolicy
```

This example creates an ExportPolicyRule in variable $exportPolicyRule, sets it an export policy object $exportPolicyRules that is then used in the creation of an AFN volume "MyAnfVolume""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ New-AzNetAppFilesSnapshotPolicy -Name <String> [-Enabled] -HourlySchedule <PSNet
```

## DESCRIPTION
The **New-AzNetAppFilesActiveDirectory** cmdlet creates a new snapshot policy for an ANF account.
The **New-AzNetAppFilesSnapshotPolicy** cmdlet creates a new snapshot policy for an ANF account.

## EXAMPLES

### Example 1
```powershell
$hourlySchedule = @{
$hourlySchedule = @{
Minute = 2
SnapshotsToKeep = 6
}
Expand All @@ -46,18 +46,18 @@ $hourlySchedule = @{
SnapshotsToKeep = 6
}
$weeklySchedule = @{
Minute = 2
Hour = 1
Minute = 2
Hour = 1
Day = "Sunday,Monday"
SnapshotsToKeep = 6
}
$monthlySchedule = @{
Minute = 2
Hour = 1
Minute = 2
Hour = 1
DaysOfMonth = "2,11,21"
SnapshotsToKeep = 6
}
New-AzNetAppFilesSnapshotPolicy -ResourceGroupName "MyRG" -l "westus2" -AccountName "MyAccount" -Name "MySnapshotPolicy" -Enabled -HourlySchedule $hourlySchedule -DailySchedule $dailySchedule -WeeklySchedule $weeklySchedule -MonthlySchedule $monthlySchedule
New-AzNetAppFilesSnapshotPolicy -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAccount" -Name "MySnapshotPolicy" -Enabled -HourlySchedule $hourlySchedule -DailySchedule $dailySchedule -WeeklySchedule $weeklySchedule -MonthlySchedule $monthlySchedule
```

This command creates the new ANF snapshot policy for ANF account named account "MyAccount".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ New-AzNetAppFilesSubvolume -Name <String> -Path <String> -Size <Int64> [-ParentP
```

## DESCRIPTION
The **New-AzNetAppFilesVolume** cmdlet creates an ANF subvolume.
The **New-AzNetAppFilesSubvolume** cmdlet creates an ANF subvolume.

## EXAMPLES

### Example 1
```powershell
PS C:\> New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MySubvolume" -l "westus2" "
New-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MySubvolume" -Location "westus2"
```

This command creates the new ANF subvolume "MySubvolume" for the parent volume "MyAnfVolume".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,13 @@ New-AzNetAppFilesVolumeGroup -PoolName <String> [-Name <String>] [-GroupDescript
```

## DESCRIPTION
The **New-AzNetAppFilesVolume** cmdlet creates an ANF VolumeGroup.
The **New-AzNetAppFilesVolumeGroup** cmdlet creates an ANF VolumeGroup.

## EXAMPLES

### Example 1
```powershell
PS C:\> New-AzNetAppFilesVolumeGroup -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfVolumeGroupName" -l "westus2" -GroupDescription "MyAnfVolumeGroup Description" -ApplicationIdentifier "SH1" -ProximityPlacementGroup "MyPPGResourceId" -Vnet "MyAnfVnet" -SystemRole "PRIMARY" -NodeMemory 100
New-AzNetAppFilesVolumeGroup -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolumeGroupName" -Location "westus2" -GroupDescription "MyAnfVolumeGroup Description" -ApplicationIdentifier "SH1" -ProximityPlacementGroup "MyPPGResourceId" -Vnet "MyAnfVnet" -SystemRole "PRIMARY" -NodeMemory 100
```

This command creates the new "PRIMARY" ANF VolumeGroup "MyAnfVolumeGroup" within the Account "MyAnfAccount" using the proximityPlacementGroup "MyPPGResourceId", the vnet "MyAnfVnet", and NodeMemory of 100
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The **Remove-AzNetAppFilesSubvolume** cmdlet deletes an ANF subvolume.

### Example 1
```powershell
PS C:\> Remove-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume"
Remove-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume"
```

This command deletes the ANF volume "MyAnfSubvolume".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ Remove-AzNetAppFilesVolumeGroup [-Name <String>] -InputObject <PSNetAppFilesBack
```

## DESCRIPTION
The **Remove-AzNetAppFilesVolume** cmdlet deletes an empty ANF VolumeGroup.
The **Remove-AzNetAppFilesVolumeGroup** cmdlet deletes an empty ANF VolumeGroup.

## EXAMPLES

### Example 1
```powershell
PS C:\> Remove-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyAnfVolumeGroup"
Remove-AzNetAppFilesVolumeGroup -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -Name "MyAnfVolumeGroup"
```

This command deletes the ANF volume "MyAnfVolumeGroup" if it has no volumes under the group.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Restore the specified files from the specified snapshot to the active filesystem

### Example 1
```powershell
PS C:\> Restore-AzNetAppFilesSnapshotFile -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyVolume" -Name "MySnapshotName" -FilePath "/dir1/customer1.db" -DestintationPath "/AVSdataStore"
Restore-AzNetAppFilesSnapshotFile -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyVolume" -Name "MySnapshotName" -FilePath "/dir1/customer1.db" -DestinationPath "/AVSdataStore"
```

This command Restores the files provided in FilePath to the directory /AVSdataStore from the MyVolume snapshot called MySnapshotName
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ Set-AzNetAppFilesSnapshotPolicy -Name <String> [-Enabled] -HourlySchedule <PSNet
```

## DESCRIPTION
The **Set-AzNetAppFilesPool** cmdlet modifies an ANF Snapshot Policy.
The **Set-AzNetAppFilesSnapshotPolicy** cmdlet modifies an ANF Snapshot Policy.

## EXAMPLES

### Example 1
```powershell
$hourlySchedule = @{
$hourlySchedule = @{
Minute = 2
SnapshotsToKeep = 6
}
Expand All @@ -54,18 +54,18 @@ $hourlySchedule = @{
SnapshotsToKeep = 6
}
$weeklySchedule = @{
Minute = 2
Hour = 1
Minute = 2
Hour = 1
Day = "Sunday,Monday"
SnapshotsToKeep = 6
}
$monthlySchedule = @{
Minute = 2
Hour = 1
Minute = 2
Hour = 1
DaysOfMonth = "2,11,21"
SnapshotsToKeep = 6
}
Set-AzNetAppFilesSnapshotPolicy -ResourceGroupName "MyRG" -l "westus2" -AccountName "MyAccount" -Name "MySnapshotPolicy" -Enabled -HourlySchedule $hourlySchedule -DailySchedule $dailySchedule -WeeklySchedule $weeklySchedule -MonthlySchedule $monthlySchedule
Set-AzNetAppFilesSnapshotPolicy -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAccount" -Name "MySnapshotPolicy" -Enabled -HourlySchedule $hourlySchedule -DailySchedule $dailySchedule -WeeklySchedule $weeklySchedule -MonthlySchedule $monthlySchedule
```

This command creates the new ANF snapshot policy for ANF account named account "MyAccount".
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Update-AzNetAppFilesActiveDirectory [-Dns <String[]>] [-Domain <String>] [-Site
```

## DESCRIPTION
The **Update-AzNetAppFilesAccount** cmdlet modifies an ANF active directory configuration.
The **Update-AzNetAppFilesActiveDirectory** cmdlet modifies an ANF active directory configuration.

## EXAMPLES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The **Update-AzNetAppFilesSubvolume** cmdlet updates an ANF subvolume.

### Example 1
```powershell
PS C:\> Update-AzNetAppFilesVolume -ResourceGroupName "MyRG" -l "westus2" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume" -Size Size
Update-AzNetAppFilesSubvolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyAnfVolume" -Name "MyAnfSubvolume" -Size Size
```

This command updates the ANF volume "MyAnfSubvolume" with the new size. This will truncate the subvolume to the provided size in bytes.
Expand Down