[NetAppFiles] Add missing parameter SnapshotName (Azure#25837)

* add snapshotName * add snapshotName not requred * Changelog * revert * snapshotname
azure-sdk · Aug 20, 2024 · 7f43ccb · 7f43ccb
1 parent a6adc8e
commit 7f43ccb
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 19 deletions.
diff --git a/src/NetAppFiles/NetAppFiles/Backups/NewNetAppFilesBackup.cs b/src/NetAppFiles/NetAppFiles/Backups/NewNetAppFilesBackup.cs
@@ -113,12 +113,12 @@ public class NewAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase
         public string Name { get; set; }
 
         [Parameter(
-            Mandatory = true,            
-            HelpMessage = "ResourceId used to identify the Volume")]        
+            Mandatory = true,
+            HelpMessage = "ResourceId used to identify the Volume")]
         public string VolumeResourceId { get; set; }
 
         [Parameter(
-            Mandatory = true,            
+            Mandatory = false,
             HelpMessage = "Label for backup")]
         [ValidateNotNullOrEmpty]
         public string Label { get; set; }
@@ -129,6 +129,12 @@ public class NewAzureRmNetAppFilesBackup : AzureNetAppFilesCmdletBase
         [ValidateNotNullOrEmpty]
         public SwitchParameter UseExistingSnapshot { get; set; }
 
+        [Parameter(
+            Mandatory = false,
+            HelpMessage = "The name of the snapshot, use with UseExistingSnapshot")]
+        [ValidateNotNullOrEmpty]
+        public string SnapshotName { get; set; }
+
         [CmdletParameterBreakingChangeWithVersion("VolumeObject", "12", "0.16", ChangeDescription = ChangeDesc)]
         [Parameter(
             ParameterSetName = ParentObjectParameterSet,
@@ -154,26 +160,27 @@ public override void ExecuteCmdlet()
                 Location = BackupVaultObject.Location;
                 var NameParts = BackupVaultObject.Name.Split('/');
                 AccountName = NameParts[0];
-                BackupVaultName = NameParts[1];                
+                BackupVaultName = NameParts[1];
             }
             if (!ResourceIdentifier.TryParse(VolumeResourceId, out _))
             {
                 throw new Exception($"VolumeResourceId is an invalid resource Id");
             }
 
             var backupBody = new Management.NetApp.Models.Backup()
-            {                
+            {
                 Label = Label,
+                VolumeResourceId = VolumeResourceId,
                 UseExistingSnapshot = UseExistingSnapshot,
-                VolumeResourceId = VolumeResourceId
+                SnapshotName = SnapshotName
             };
 
             if (ShouldProcess(Name, string.Format(PowerShell.Cmdlets.NetAppFiles.Properties.Resources.CreateResourceMessage, ResourceGroupName)))
             {
                 try
                 {
-                    var anfBackupPolicy = AzureNetAppFilesManagementClient.Backups.Create(ResourceGroupName, AccountName, backupVaultName:BackupVaultName, backupName: Name, body: backupBody);
-                    WriteObject(anfBackupPolicy.ConvertToPs());
+                    var anfBackup = AzureNetAppFilesManagementClient.Backups.Create(ResourceGroupName, AccountName, backupVaultName: BackupVaultName, backupName: Name, body: backupBody);
+                    WriteObject(anfBackup.ConvertToPs());
                 }
                 catch (ErrorResponseException ex)
                 {
@@ -182,4 +189,4 @@ public override void ExecuteCmdlet()
             }
         }
     }
-}
+}
diff --git a/src/NetAppFiles/NetAppFiles/ChangeLog.md b/src/NetAppFiles/NetAppFiles/ChangeLog.md
@@ -19,6 +19,8 @@
 -->
 ## Upcoming Release
 * Fixed some minor issues
+* Added `SnapshotName` to `New-AzNetAppFilesBackup`
+* Fixed `New-AzNetAppFilesBackup`, `Label` is not a requred parameter
 
 ## Version 0.17.0
 * Updated to api-version 2024-03-01

diff --git a/src/NetAppFiles/NetAppFiles/Helpers/BackupExtensions.cs b/src/NetAppFiles/NetAppFiles/Helpers/BackupExtensions.cs
@@ -25,7 +25,7 @@ public static PSNetAppFilesBackup ConvertToPs(this Management.NetApp.Models.Back
         {
             var psBackup = new PSNetAppFilesBackup
             {
-                ResourceGroupName = new ResourceIdentifier(backup.Id).ResourceGroupName,                
+                ResourceGroupName = new ResourceIdentifier(backup.Id).ResourceGroupName,
                 Id = backup.Id,
                 Name = backup.Name,
                 BackupId = backup.BackupId,
@@ -36,6 +36,7 @@ public static PSNetAppFilesBackup ConvertToPs(this Management.NetApp.Models.Back
                 Size = backup.Size,
                 VolumeResourceId = backup.VolumeResourceId,
                 UseExistingSnapshot = backup.UseExistingSnapshot,
+                SnapshotName = backup.SnapshotName,
                 CreationDate = backup.CreationDate
             };
             return psBackup;
@@ -76,4 +77,4 @@ public static PSNetAppFilesVolumeRestoreStatus ConvertToPs(this Management.NetAp
             return psRestoreStatus;
         }
     }
-}
+}
diff --git a/src/NetAppFiles/NetAppFiles/Models/PSNetAppFilesBackup.cs b/src/NetAppFiles/NetAppFiles/Models/PSNetAppFilesBackup.cs
@@ -105,6 +105,13 @@ public class PSNetAppFilesBackup
         /// false for scheduled backups and true/false for manual backups
         /// </remarks>
         public bool? UseExistingSnapshot { get; set; }
-
+
+        /// <summary>
+        /// Gets or sets SnapshotName
+        /// </summary>
+        /// <remarks>
+        ///  The name of the snapshot
+        /// </remarks>        
+        public string SnapshotName { get; set; }
     }
 }
diff --git a/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackup.md b/src/NetAppFiles/NetAppFiles/help/New-AzNetAppFilesBackup.md
@@ -16,15 +16,16 @@ Creates a new Azure NetApp Files (ANF) backup.
 ```
 New-AzNetAppFilesBackup -ResourceGroupName <String> [-Location <String>] -AccountName <String>
  [-PoolName <String>] [-VolumeName <String>] -BackupVaultName <String> -Name <String>
- -VolumeResourceId <String> -Label <String> [-UseExistingSnapshot] [-DefaultProfile <IAzureContextContainer>]
- [-WhatIf] [-Confirm] [<CommonParameters>]
+ -VolumeResourceId <String> [-Label <String>] [-UseExistingSnapshot] [-SnapshotName <String>]
+ [-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
 ```
 
 ### ByParentObjectParameterSet
 ```
-New-AzNetAppFilesBackup -Name <String> -VolumeResourceId <String> -Label <String> [-UseExistingSnapshot]
- [-VolumeObject <PSNetAppFilesVolume>] -BackupVaultObject <PSNetAppFilesBackupVault>
- [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm]
+New-AzNetAppFilesBackup -Name <String> -VolumeResourceId <String> [-Label <String>] [-UseExistingSnapshot]
+ [-SnapshotName <String>] [-VolumeObject <PSNetAppFilesVolume>] -BackupVaultObject <PSNetAppFilesBackupVault>
+ [-DefaultProfile <IAzureContextContainer>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
@@ -110,7 +111,7 @@ Type: System.String
 Parameter Sets: (All)
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -162,6 +163,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: System.Management.Automation.ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -ResourceGroupName
 The resource group of the ANF account
 
@@ -177,6 +193,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -SnapshotName
+The name of the snapshot, use with UseExistingSnapshot
+
+```yaml
+Type: System.String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -UseExistingSnapshot
 Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups
 
@@ -295,4 +326,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 [Get-AzNetAppFilesVolume](./Get-AzNetAppFilesVolume.md)
 [New-AzNetAppFilesVolume](./New-AzNetAppFilesVolume.md)
 [Update-AzNetAppFilesVolume](./Update-AzNetAppFilesVolume.md)
-[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md)
+[Remove-AzNetAppFilesVolume](./Remove-AzNetAppFilesVolume.md)