From 7469113f9c22463b583d905763b97a896004f6db Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Au=C3=B0unn?= Date: Mon, 4 Nov 2024 14:09:46 +0000 Subject: [PATCH] [NetAppFiles] Remove deprected properties from backups (#26564) * Remove deprected properties from backups * update test * update help * Remove ProgressAction * update help and changelog * update help * update changelog --------- Co-authored-by: Vincent Dai <23257217+vidai-msft@users.noreply.github.com> --- .../ScenarioTests/BackupTests.ps1 | 2 +- .../Backups/GetNetAppFilesBackup.cs | 55 +---------- .../Backups/NewNetAppFilesBackup.cs | 45 --------- .../Backups/RemoveNetAppFilesBackup.cs | 47 ---------- .../Backups/RestoreNetAppFilesBackupFiles.cs | 35 ------- .../Backups/UpdateNetAppFilesBackup.cs | 35 ------- src/NetAppFiles/NetAppFiles/ChangeLog.md | 1 + .../NetAppFiles/help/Az.NetAppFiles.md | 3 + .../help/Get-AzNetAppFilesBackup.md | 85 +++-------------- ...t-AzNetAppFilesSnapshotPolicyVolumeList.md | 18 ++-- .../help/New-AzNetAppFilesBackup.md | 75 ++------------- .../help/Remove-AzNetAppFilesBackup.md | 91 +++---------------- .../help/Restore-AzNetAppFilesBackupFile.md | 62 ++----------- .../help/Update-AzNetAppFilesBackup.md | 61 ++----------- 14 files changed, 58 insertions(+), 557 deletions(-) diff --git a/src/NetAppFiles/NetAppFiles.Test/ScenarioTests/BackupTests.ps1 b/src/NetAppFiles/NetAppFiles.Test/ScenarioTests/BackupTests.ps1 index f33b73f783b3..7b902a3b4955 100644 --- a/src/NetAppFiles/NetAppFiles.Test/ScenarioTests/BackupTests.ps1 +++ b/src/NetAppFiles/NetAppFiles.Test/ScenarioTests/BackupTests.ps1 @@ -166,7 +166,7 @@ function Test-BackupCrud Start-TestSleep -Seconds 30 # Assert-ThrowsContains{ Get-AzNetAppFilesVolumeGroupIdListForLDAPUser -ResourceGroupName $resourceGroup -AccountName $accName -PoolName $poolName -VolumeName $volName1 -Username $userName} 'Group Id list can be fetched for LDAP enabled volumes only. Please check that the volume is LDAP enabled' - Assert-ThrowsContains{New-AzNetAppFilesBackup -ResourceGroupName $resourceGroup -Location $backupLocation -AccountName $accName1 -BackupVaultName $backupVaultName -Name $backupName1 -Label $label -VolumeResourceId "bogus Id" } 'is an invalid resource Id' + Assert-ThrowsContains{New-AzNetAppFilesBackup -ResourceGroupName $resourceGroup -AccountName $accName1 -BackupVaultName $backupVaultName -Name $backupName1 -Label $label -VolumeResourceId "bogus Id" } 'is an invalid resource Id' # create and check Backup $retrievedBackup = New-AzNetAppFilesBackup -ResourceGroupName $resourceGroup -AccountName $accName1 -BackupVaultName $backupVaultName -Name $backupName1 -Label $label -VolumeResourceId $retrievedVolume.Id diff --git a/src/NetAppFiles/NetAppFiles/Backups/GetNetAppFilesBackup.cs b/src/NetAppFiles/NetAppFiles/Backups/GetNetAppFilesBackup.cs index e4c0de5737d4..9dd5f9ecbfb1 100644 --- a/src/NetAppFiles/NetAppFiles/Backups/GetNetAppFilesBackup.cs +++ b/src/NetAppFiles/NetAppFiles/Backups/GetNetAppFilesBackup.cs @@ -65,32 +65,6 @@ public class GetAzureRmNetAppFilesBackup: AzureNetAppFilesCmdletBase nameof(ResourceGroupName))] public string AccountName { get; set; } - public const String ChangeDesc = "Parameter is being deprecated without being replaced"; - [CmdletParameterBreakingChangeWithVersion("PoolName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF pool")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools", - nameof(ResourceGroupName), - nameof(AccountName))] - public string PoolName { get; set; } - - [CmdletParameterBreakingChangeWithVersion("VolumeName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF volume")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", - nameof(ResourceGroupName), - nameof(AccountName), - nameof(PoolName))] - public string VolumeName { get; set; } - [Parameter( Mandatory = false, ParameterSetName = FieldsParameterSet, @@ -115,9 +89,7 @@ public class GetAzureRmNetAppFilesBackup: AzureNetAppFilesCmdletBase [ResourceNameCompleter( "Microsoft.NetApp/netAppAccounts/backups", nameof(ResourceGroupName), - nameof(AccountName), - nameof(PoolName), - nameof(VolumeName))] + nameof(AccountName))] public string Name { get; set; } [Parameter( @@ -126,22 +98,6 @@ public class GetAzureRmNetAppFilesBackup: AzureNetAppFilesCmdletBase HelpMessage = "Filter list of backups, this filter accepts volumeResourceId")] public string Filter { get; set; } - [CmdletParameterBreakingChangeWithVersion("AccountBackupName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - HelpMessage = "The name of the ANF backup", - ParameterSetName = AccountBackupFieldsParameterSet)] - [Parameter( - Mandatory = false, - HelpMessage = "The name of the ANF backup", - ParameterSetName = ParentObjectParameterSet)] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/backups", - nameof(ResourceGroupName), - nameof(AccountName))] - public string AccountBackupName { get; set; } - [Parameter( Mandatory = true, ValueFromPipelineByPropertyName = true, @@ -150,15 +106,6 @@ public class GetAzureRmNetAppFilesBackup: AzureNetAppFilesCmdletBase [ValidateNotNullOrEmpty] public string ResourceId { get; set; } - [CmdletParameterBreakingChangeWithVersion("VolumeObject", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - ParameterSetName = ParentObjectParameterSet, - Mandatory = false, - ValueFromPipeline = true, - HelpMessage = "The Volume object containing the backup to return")] - [ValidateNotNullOrEmpty] - public PSNetAppFilesVolume VolumeObject { get; set; } - [Parameter( ParameterSetName = ParentObjectParameterSet, Mandatory = true, diff --git a/src/NetAppFiles/NetAppFiles/Backups/NewNetAppFilesBackup.cs b/src/NetAppFiles/NetAppFiles/Backups/NewNetAppFilesBackup.cs index a860c86101d5..65b5ace62274 100644 --- a/src/NetAppFiles/NetAppFiles/Backups/NewNetAppFilesBackup.cs +++ b/src/NetAppFiles/NetAppFiles/Backups/NewNetAppFilesBackup.cs @@ -44,15 +44,6 @@ public class NewAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase [ResourceGroupCompleter()] public string ResourceGroupName { get; set; } - [CmdletParameterBreakingChangeWithVersion("Location", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The location of the resource")] - [ValidateNotNullOrEmpty] - [LocationCompleter("Microsoft.NetApp/netAppAccounts/backupvaults/backups")] - public string Location { get; set; } - [Parameter( Mandatory = true, ParameterSetName = FieldsParameterSet, @@ -63,32 +54,6 @@ public class NewAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase nameof(ResourceGroupName))] public string AccountName { get; set; } - public const String ChangeDesc = "Parameter is being deprecated without being replaced"; - [CmdletParameterBreakingChangeWithVersion("PoolName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF pool")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools", - nameof(ResourceGroupName), - nameof(AccountName))] - public string PoolName { get; set; } - - [CmdletParameterBreakingChangeWithVersion("VolumeName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF volume")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", - nameof(ResourceGroupName), - nameof(AccountName), - nameof(PoolName))] - public string VolumeName { get; set; } - [Parameter( Mandatory = true, ParameterSetName = FieldsParameterSet, @@ -135,15 +100,6 @@ public class NewAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase [ValidateNotNullOrEmpty] public string SnapshotName { get; set; } - [CmdletParameterBreakingChangeWithVersion("VolumeObject", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - ParameterSetName = ParentObjectParameterSet, - Mandatory = false, - ValueFromPipeline = true, - HelpMessage = "The volume for the new backup object")] - [ValidateNotNullOrEmpty] - public PSNetAppFilesVolume VolumeObject { get; set; } - [Parameter( ParameterSetName = ParentObjectParameterSet, Mandatory = true, @@ -157,7 +113,6 @@ public override void ExecuteCmdlet() if (ParameterSetName == ParentObjectParameterSet) { ResourceGroupName = BackupVaultObject.ResourceGroupName; - Location = BackupVaultObject.Location; var NameParts = BackupVaultObject.Name.Split('/'); AccountName = NameParts[0]; BackupVaultName = NameParts[1]; diff --git a/src/NetAppFiles/NetAppFiles/Backups/RemoveNetAppFilesBackup.cs b/src/NetAppFiles/NetAppFiles/Backups/RemoveNetAppFilesBackup.cs index 61033536c1c4..ff4907261bcb 100644 --- a/src/NetAppFiles/NetAppFiles/Backups/RemoveNetAppFilesBackup.cs +++ b/src/NetAppFiles/NetAppFiles/Backups/RemoveNetAppFilesBackup.cs @@ -65,32 +65,6 @@ public class RemoveAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase nameof(ResourceGroupName))] public string AccountName { get; set; } - public const String ChangeDesc = "Parameter is being deprecated without being replaced"; - [CmdletParameterBreakingChangeWithVersion("PoolName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF pool")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools", - nameof(ResourceGroupName), - nameof(AccountName))] - public string PoolName { get; set; } - - [CmdletParameterBreakingChangeWithVersion("VolumeName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF volume")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", - nameof(ResourceGroupName), - nameof(AccountName), - nameof(PoolName))] - public string VolumeName { get; set; } - [Parameter( Mandatory = true, ParameterSetName = FieldsParameterSet, @@ -119,18 +93,6 @@ public class RemoveAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase nameof(BackupVault))] public string Name { get; set; } - [CmdletParameterBreakingChangeWithVersion("AccountBackupName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - HelpMessage = "The name of the ANF backup", - ParameterSetName = AccountBackupFieldsParameterSet)] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/backups", - nameof(ResourceGroupName), - nameof(AccountName))] - public string AccountBackupName { get; set; } - [Parameter( Mandatory = true, ValueFromPipelineByPropertyName = true, @@ -139,15 +101,6 @@ public class RemoveAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase [ValidateNotNullOrEmpty] public string ResourceId { get; set; } - [CmdletParameterBreakingChangeWithVersion("VolumeObject", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - ParameterSetName = ParentObjectParameterSet, - Mandatory = false, - ValueFromPipeline = true, - HelpMessage = "The volume object containing the backup to return")] - [ValidateNotNullOrEmpty] - public PSNetAppFilesVolume VolumeObject { get; set; } - [Parameter( ParameterSetName = ParentObjectParameterSet, Mandatory = true, diff --git a/src/NetAppFiles/NetAppFiles/Backups/RestoreNetAppFilesBackupFiles.cs b/src/NetAppFiles/NetAppFiles/Backups/RestoreNetAppFilesBackupFiles.cs index 65f36c47793f..1244f1d594fb 100644 --- a/src/NetAppFiles/NetAppFiles/Backups/RestoreNetAppFilesBackupFiles.cs +++ b/src/NetAppFiles/NetAppFiles/Backups/RestoreNetAppFilesBackupFiles.cs @@ -68,32 +68,6 @@ public class RestoreNetAppFilesBackupFiles : AzureNetAppFilesCmdletBase nameof(AccountName))] public string Name { get; set; } - public const String ChangeDesc = "Parameter is being deprecated without being replaced"; - [CmdletParameterBreakingChangeWithVersion("PoolName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF pool")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools", - nameof(ResourceGroupName), - nameof(AccountName))] - public string PoolName { get; set; } - - [CmdletParameterBreakingChangeWithVersion("VolumeName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF volume")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", - nameof(ResourceGroupName), - nameof(AccountName), - nameof(PoolName))] - public string VolumeName { get; set; } - [Parameter( Mandatory = true, ParameterSetName = FieldsParameterSet, @@ -132,15 +106,6 @@ public class RestoreNetAppFilesBackupFiles : AzureNetAppFilesCmdletBase [ValidateNotNullOrEmpty] public string ResourceId { get; set; } - [CmdletParameterBreakingChangeWithVersion("VolumeObject", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - ParameterSetName = ParentObjectParameterSet, - Mandatory = false, - ValueFromPipeline = true, - HelpMessage = "The volume object containing the backup to restore files from")] - [ValidateNotNullOrEmpty] - public PSNetAppFilesVolume VolumeObject { get; set; } - [Parameter( ParameterSetName = ParentObjectParameterSet, Mandatory = true, diff --git a/src/NetAppFiles/NetAppFiles/Backups/UpdateNetAppFilesBackup.cs b/src/NetAppFiles/NetAppFiles/Backups/UpdateNetAppFilesBackup.cs index eac39ceac1a1..77725d85eea7 100644 --- a/src/NetAppFiles/NetAppFiles/Backups/UpdateNetAppFilesBackup.cs +++ b/src/NetAppFiles/NetAppFiles/Backups/UpdateNetAppFilesBackup.cs @@ -80,32 +80,6 @@ public class UpdateAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase nameof(AccountName))] public string Name { get; set; } - public const String ChangeDesc = "Parameter is being deprecated without being replaced"; - [CmdletParameterBreakingChangeWithVersion("PoolName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF pool")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools", - nameof(ResourceGroupName), - nameof(AccountName))] - public string PoolName { get; set; } - - [CmdletParameterBreakingChangeWithVersion("VolumeName", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - Mandatory = false, - ParameterSetName = FieldsParameterSet, - HelpMessage = "The name of the ANF volume")] - [ValidateNotNullOrEmpty] - [ResourceNameCompleter( - "Microsoft.NetApp/netAppAccounts/capacityPools/volumes", - nameof(ResourceGroupName), - nameof(AccountName), - nameof(PoolName))] - public string VolumeName { get; set; } - [Parameter( Mandatory = true, ParameterSetName = FieldsParameterSet, @@ -138,15 +112,6 @@ public class UpdateAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase [ValidateNotNullOrEmpty] public string ResourceId { get; set; } - [CmdletParameterBreakingChangeWithVersion("VolumeObject", "12", "0.16", ChangeDescription = ChangeDesc)] - [Parameter( - ParameterSetName = ParentObjectParameterSet, - Mandatory = false, - ValueFromPipeline = true, - HelpMessage = "The volume object containing the backup to return")] - [ValidateNotNullOrEmpty] - public PSNetAppFilesVolume VolumeObject { get; set; } - [Parameter( ParameterSetName = ParentObjectParameterSet, Mandatory = true, diff --git a/src/NetAppFiles/NetAppFiles/ChangeLog.md b/src/NetAppFiles/NetAppFiles/ChangeLog.md index 8b10ad19f198..a88bbbcb8070 100644 --- a/src/NetAppFiles/NetAppFiles/ChangeLog.md +++ b/src/NetAppFiles/NetAppFiles/ChangeLog.md @@ -18,6 +18,7 @@ - Additional information about change #1 --> ## Upcoming Release +* Removed parameters `Location`, `PoolName`, `VolumeName` from `Get-AzNetAppFilesBackup`, `New-AzNetAppFilesBackup`, `Update-AzNetAppFilesBackup`, `Remove-AzNetAppFilesBackup` and `Restore-AzNetAppFilesBackupFile` ## Version 0.18.0 * Fixed some minor issues diff --git a/src/NetAppFiles/NetAppFiles/help/Az.NetAppFiles.md b/src/NetAppFiles/NetAppFiles/help/Az.NetAppFiles.md index 1292d5ec7bdc..a3a40b066814 100644 --- a/src/NetAppFiles/NetAppFiles/help/Az.NetAppFiles.md +++ b/src/NetAppFiles/NetAppFiles/help/Az.NetAppFiles.md @@ -50,6 +50,9 @@ Gets details of an Azure NetApp Files (ANF) snapshot. ### [Get-AzNetAppFilesSnapshotPolicy](Get-AzNetAppFilesSnapshotPolicy.md) Gets details of an Azure NetApp Files (ANF) snapshot policy. +### [Get-AzNetAppFilesSnapshotPolicyVolumeList](Get-AzNetAppFilesSnapshotPolicyVolumeList.md) +Get Volumes for Azure NetApp Files (ANF) Snapshot Policy + ### [Get-AzNetAppFilesSubvolume](Get-AzNetAppFilesSubvolume.md) Gets details of an Azure NetApp Files (ANF) subvolume. diff --git a/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesBackup.md b/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesBackup.md index e2b1b0667ad6..4b7ee1085f17 100644 --- a/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesBackup.md +++ b/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesBackup.md @@ -14,22 +14,21 @@ Gets details of an Azure NetApp Files (ANF) Backup. ### ByFieldsParameterSet (Default) ``` -Get-AzNetAppFilesBackup -ResourceGroupName -AccountName [-PoolName ] - [-VolumeName ] [-BackupVaultName ] [-Name ] [-Filter ] - [-DefaultProfile ] [] +Get-AzNetAppFilesBackup -ResourceGroupName -AccountName [-BackupVaultName ] + [-Name ] [-Filter ] [-DefaultProfile ] + [] ``` ### ByAccountBackupFieldsParameterSet ``` -Get-AzNetAppFilesBackup -ResourceGroupName -AccountName [-AccountBackupName ] +Get-AzNetAppFilesBackup -ResourceGroupName -AccountName [-DefaultProfile ] [] ``` ### ByParentObjectParameterSet ``` -Get-AzNetAppFilesBackup [-Name ] [-AccountBackupName ] [-VolumeObject ] - -BackupVaultObject [-DefaultProfile ] - [] +Get-AzNetAppFilesBackup [-Name ] -BackupVaultObject + [-DefaultProfile ] [] ``` ### ByResourceIdParameterSet @@ -45,34 +44,21 @@ The **Get-AzNetAppFilesBackup** cmdlet gets details of an ANF backup. ### Example 1 ```powershell -Get-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -PoolName "MyPool" -VolumeName "MyVolume" -Name "MyBackup" +Get-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -BackupVaultName "MyVault" -Name "MyVolumeBackup" ``` -This command gets the backup named "MyAnfAccount" from the volume named "MyVolume". +This command gets the backup named "MyVolumeBackup" from the Backup Vault "MyVault". ### Example 2 ```powershell -Get-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -AccountBackupName "MyBackup" +$volumeResourceId = "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/MyAccount/capacityPools/MyPool/volumes/MyVolume" +Get-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -BackupVaultName "MyVault" -Filter $volumeResourceId ``` -This command gets the backup named "MyAnfAccount" from the Account named "MyAccount". +This command gets the backups for the volume with resource Id volume with resource Id $volumeResourceId from the Backup Vault "MyVault". -## PARAMETERS - -### -AccountBackupName -The name of the ANF backup -```yaml -Type: System.String -Parameter Sets: ByAccountBackupFieldsParameterSet, ByParentObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +## PARAMETERS ### -AccountName The name of the ANF account @@ -164,21 +150,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolName -The name of the ANF pool - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The resource group of the ANF account @@ -209,36 +180,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VolumeName -The name of the ANF volume - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VolumeObject -The volume object containing the backup to return - -```yaml -Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume -Parameter Sets: ByParentObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). @@ -246,8 +187,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String -### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume - ### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupVault ## OUTPUTS diff --git a/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSnapshotPolicyVolumeList.md b/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSnapshotPolicyVolumeList.md index 0846edc57889..d96aaf049fae 100644 --- a/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSnapshotPolicyVolumeList.md +++ b/src/NetAppFiles/NetAppFiles/help/Get-AzNetAppFilesSnapshotPolicyVolumeList.md @@ -50,7 +50,7 @@ This command gets a list of Volumes associated with the backup policy named "MyB The name of the ANF account ```yaml -Type: String +Type: System.String Parameter Sets: ByFieldsParameterSet Aliases: @@ -65,7 +65,7 @@ Accept wildcard characters: False The credentials, account, tenant, and subscription used for communication with Azure. ```yaml -Type: IAzureContextContainer +Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer Parameter Sets: (All) Aliases: AzContext, AzureRmContext, AzureCredential @@ -80,7 +80,7 @@ Accept wildcard characters: False The name of the ANF snapshot policy ```yaml -Type: String +Type: System.String Parameter Sets: ByFieldsParameterSet Aliases: SnapshotPolicyName @@ -92,7 +92,7 @@ Accept wildcard characters: False ``` ```yaml -Type: String +Type: System.String Parameter Sets: ByParentObjectParameterSet Aliases: SnapshotPolicyName @@ -107,7 +107,7 @@ Accept wildcard characters: False The resource group of the ANF account ```yaml -Type: String +Type: System.String Parameter Sets: ByFieldsParameterSet Aliases: @@ -122,7 +122,7 @@ Accept wildcard characters: False The resource id of the ANF Snapshot Policy ```yaml -Type: String +Type: System.String Parameter Sets: ByResourceIdParameterSet Aliases: @@ -137,7 +137,7 @@ Accept wildcard characters: False The Snapshot Policy object ```yaml -Type: PSNetAppFilesSnapshotPolicy +Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesSnapshotPolicy Parameter Sets: ByParentObjectParameterSet Aliases: @@ -152,7 +152,7 @@ Accept wildcard characters: False Prompts you for confirmation before running the cmdlet. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: cf @@ -168,7 +168,7 @@ Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.SwitchParameter Parameter Sets: (All) Aliases: wi diff --git a/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackup.md b/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackup.md index 31ae1e0060b5..32c9eec16994 100644 --- a/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackup.md +++ b/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackup.md @@ -14,9 +14,8 @@ Creates a new Azure NetApp Files (ANF) backup. ### ByFieldsParameterSet (Default) ``` -New-AzNetAppFilesBackup -ResourceGroupName [-Location ] -AccountName - [-PoolName ] [-VolumeName ] -BackupVaultName -Name - -VolumeResourceId [-Label ] [-UseExistingSnapshot] [-SnapshotName ] +New-AzNetAppFilesBackup -ResourceGroupName -AccountName -BackupVaultName + -Name -VolumeResourceId [-Label ] [-UseExistingSnapshot] [-SnapshotName ] [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -24,7 +23,7 @@ New-AzNetAppFilesBackup -ResourceGroupName [-Location ] -Accoun ### ByParentObjectParameterSet ``` New-AzNetAppFilesBackup -Name -VolumeResourceId [-Label ] [-UseExistingSnapshot] - [-SnapshotName ] [-VolumeObject ] -BackupVaultObject + [-SnapshotName ] -BackupVaultObject [-DefaultProfile ] [-WhatIf] [-Confirm] [] ``` @@ -36,10 +35,12 @@ The **New-AzNetAppFilesBackup** cmdlet creates a backup for an ANF volume. ### Example 1 ```powershell -New-AzNetAppFilesBackup -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAccount" -PoolName "MyPool" -VolumeName "MyVolume" -Name "MyVolumeBackup" -Label "ALabel" +$volumeResourceId = "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/MyAccount/capacityPools/MyPool/volumes/MyVolume" +New-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -BackupVaultName "MyVault" -Name "MyVolumeBackup" -Label "ALabel" -VolumeResourceId $volumeResourceId ``` -This command creates the new ANF backup for volume named account "MyVolume". +This command creates the new ANF backup in vault MyVault for volume with resource Id $volumeResourceId. + ## PARAMETERS @@ -118,21 +119,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Location -The location of the resource - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Name The name of the ANF backup @@ -148,21 +134,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolName -The name of the ANF pool - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The resource group of the ANF account @@ -208,36 +179,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VolumeName -The name of the ANF volume - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VolumeObject -The volume for the new backup object - -```yaml -Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume -Parameter Sets: ByParentObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -VolumeResourceId ResourceId used to identify the Volume @@ -289,8 +230,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume - ### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupVault ## OUTPUTS diff --git a/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesBackup.md b/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesBackup.md index 35a118f3df7b..303c369fbdd9 100644 --- a/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesBackup.md +++ b/src/NetAppFiles/NetAppFiles/help/Remove-AzNetAppFilesBackup.md @@ -14,24 +14,23 @@ Deletes an Azure NetApp Files (ANF) backup. ### ByFieldsParameterSet (Default) ``` -Remove-AzNetAppFilesBackup -ResourceGroupName [-AccountName ] [-PoolName ] - [-VolumeName ] -BackupVaultName -Name [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] - [] +Remove-AzNetAppFilesBackup -ResourceGroupName [-AccountName ] -BackupVaultName + -Name [-PassThru] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### ByAccountBackupFieldsParameterSet ``` -Remove-AzNetAppFilesBackup -ResourceGroupName -AccountName [-AccountBackupName ] - [-PassThru] [-DefaultProfile ] [-WhatIf] - [-Confirm] [] +Remove-AzNetAppFilesBackup -ResourceGroupName -AccountName [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ByParentObjectParameterSet ``` -Remove-AzNetAppFilesBackup -Name [-VolumeObject ] - -BackupVaultObject [-PassThru] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] +Remove-AzNetAppFilesBackup -Name -BackupVaultObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ByResourceIdParameterSet @@ -54,35 +53,14 @@ The **Remove-AzNetAppFilesBackup** cmdlet deletes an ANF account. ### Example 1 ```powershell -Remove-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -PoolName "MyPool" -VolumeName "MyVolume" -Name "MyBackup" +Remove-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -BackupVaultName "MyVault" -Name "MyVolumeBackup" ``` -This command deletes the new ANF backup with a the name "MyBackup" for volume "MyVolume". +This command deletes the new ANF backup with a the name "MyVolumeBackup" from Backup Vault "MyVault". -### Example 2 -```powershell -Remove-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -AccountBackupName "MyBackup" -``` - -This command deletes the new ANF backup with a the name "MyBackup" for account "MyAccount". ## PARAMETERS -### -AccountBackupName -The name of the ANF backup - -```yaml -Type: System.String -Parameter Sets: ByAccountBackupFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AccountName The name of the ANF account @@ -200,21 +178,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolName -The name of the ANF pool - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The resource group of the ANF account @@ -245,36 +208,6 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -VolumeName -The name of the ANF volume - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VolumeObject -The volume object containing the backup to return - -```yaml -Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume -Parameter Sets: ByParentObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -313,8 +246,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String -### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume - ### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupVault ### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup diff --git a/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesBackupFile.md b/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesBackupFile.md index 22baf7a3e701..fa5fb2c23ea0 100644 --- a/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesBackupFile.md +++ b/src/NetAppFiles/NetAppFiles/help/Restore-AzNetAppFilesBackupFile.md @@ -15,18 +15,17 @@ Create a new Backup Restore Files request ### ByFieldsParameterSet (Default) ``` Restore-AzNetAppFilesBackupFile -ResourceGroupName -AccountName -Name - [-PoolName ] [-VolumeName ] -BackupVaultName -FileList - [-RestoreFilePath ] -DestinationVolumeId [-PassThru] - [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + -BackupVaultName -FileList [-RestoreFilePath ] -DestinationVolumeId + [-PassThru] [-DefaultProfile ] [-WhatIf] + [-Confirm] [] ``` ### ByParentObjectParameterSet ``` Restore-AzNetAppFilesBackupFile -Name -FileList [-RestoreFilePath ] - -DestinationVolumeId [-VolumeObject ] - -BackupVaultObject [-PassThru] [-DefaultProfile ] - [-WhatIf] [-Confirm] [] + -DestinationVolumeId -BackupVaultObject [-PassThru] + [-DefaultProfile ] [-WhatIf] [-Confirm] + [] ``` ### ByResourceIdParameterSet @@ -52,7 +51,7 @@ Restore the specified files from the specified backup to the active filesystem ```powershell $fileList = New-Object string[] 1 $fileList[0] = "/dir1/customer1.db" -Restore-AzNetAppFilesBackupFile -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -VolumeName "MyVolume" -BackupName "MyBackup" -FileList $fileList -DestinationVolumeId "destinationVolumeResourceId" +Restore-AzNetAppFilesBackupFile -ResourceGroupName "MyRG" -AccountName "MyAccount" -BackupVaultName "MyVault" -BackupName "MyBackup" -FileList $fileList -DestinationVolumeId "destinationVolumeResourceId" ``` This command Restores the file customer1.db from "MyBackup" to the specified destingation volume @@ -194,21 +193,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolName -The name of the ANF pool - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The resource group of the ANF account @@ -256,36 +240,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VolumeName -The name of the ANF volume - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VolumeObject -The volume object containing the backup to restore files from - -```yaml -Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume -Parameter Sets: ByParentObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -324,8 +278,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String -### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume - ### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupVault ### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup diff --git a/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesBackup.md b/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesBackup.md index c71e86ccd17a..f690d129b4db 100644 --- a/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesBackup.md +++ b/src/NetAppFiles/NetAppFiles/help/Update-AzNetAppFilesBackup.md @@ -15,17 +15,15 @@ Updates an Azure NetApp Files (ANF) backup to the optional modifiers provided. ### ByFieldsParameterSet (Default) ``` Update-AzNetAppFilesBackup -ResourceGroupName -Location -AccountName -Name - [-PoolName ] [-VolumeName ] -BackupVaultName [-Label ] [-Tag ] - [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + -BackupVaultName [-Label ] [-Tag ] [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### ByParentObjectParameterSet ``` Update-AzNetAppFilesBackup -Name [-Label ] [-Tag ] - [-VolumeObject ] -BackupVaultObject - [-DefaultProfile ] [-WhatIf] [-Confirm] - [] + -BackupVaultObject [-DefaultProfile ] + [-WhatIf] [-Confirm] [] ``` ### ByResourceIdParameterSet @@ -49,10 +47,10 @@ The **Update-AzNetAppFilesBackup** cmdlet modifies an ANF backup. ### Example 1 ```powershell -Update-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -Name "BackupName" -Label "updatedLabel" +Update-AzNetAppFilesBackup -ResourceGroupName "MyRG" -AccountName "MyAccount" -BackupVaultName "MyVault" -Name "BackupName" -Label "updatedLabel" ``` -This command performs an update on the given backup modifying the username to that provided. +This command performs an update on the given backup modifying the label to that provided. ## PARAMETERS @@ -176,21 +174,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolName -The name of the ANF pool - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ResourceGroupName The resource group of the ANF account @@ -236,36 +219,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VolumeName -The name of the ANF volume - -```yaml -Type: System.String -Parameter Sets: ByFieldsParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -VolumeObject -The volume object containing the backup to return - -```yaml -Type: Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume -Parameter Sets: ByParentObjectParameterSet -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -Confirm Prompts you for confirmation before running the cmdlet. @@ -304,8 +257,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### System.String -### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesVolume - ### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackupVault ### Microsoft.Azure.Commands.NetAppFiles.Models.PSNetAppFilesBackup