updated param help messages

Author: Sambit Rath

src/RecoveryServices/RecoveryServices.Backup/Cmdlets/Item/EnableAzureRmRecoveryServicesBackupProtection.cs

@@ -100,31 +100,41 @@ public class EnableAzureRmRecoveryServicesBackupProtection : RSBackupVaultCmdlet
         /// <summary>
         /// List of Disk LUNs to include in backup
         /// </summary>
-        [Parameter(Mandatory = false, ParameterSetName = AzureVMClassicComputeParameterSet)]
-        [Parameter(Mandatory = false, ParameterSetName = AzureVMComputeParameterSet)]
-        [Parameter(Mandatory = false, ParameterSetName = ModifyProtectionParameterSet)]
+        [Parameter(Mandatory = false, ParameterSetName = AzureVMClassicComputeParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.inclusionDiskList)]
+        [Parameter(Mandatory = false, ParameterSetName = AzureVMComputeParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.inclusionDiskList)]
+        [Parameter(Mandatory = false, ParameterSetName = ModifyProtectionParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.inclusionDiskList)]
         public string[] InclusionDisksList { get; set; }
 
         /// <summary>
         /// List of Disk LUNs to exclude in backup
         /// </summary>
-        [Parameter(Mandatory = false, ParameterSetName = AzureVMClassicComputeParameterSet)]
-        [Parameter(Mandatory = false, ParameterSetName = AzureVMComputeParameterSet)]
-        [Parameter(Mandatory = false, ParameterSetName = ModifyProtectionParameterSet)]
+        [Parameter(Mandatory = false, ParameterSetName = AzureVMClassicComputeParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.exclusionDiskList)]
+        [Parameter(Mandatory = false, ParameterSetName = AzureVMComputeParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.exclusionDiskList)]
+        [Parameter(Mandatory = false, ParameterSetName = ModifyProtectionParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.exclusionDiskList)]
         public string[] ExclusionDisksList { get; set; }
 
         /// <summary>
         /// Reset Disk Exclusion Settings
         /// </summary>
-        [Parameter(Mandatory = false, ParameterSetName = ModifyProtectionParameterSet)]
+        [Parameter(Mandatory = false, ParameterSetName = ModifyProtectionParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.resetExclusionSettings)]
         public SwitchParameter ResetExclusionSettings { get; set; }
 
         /// <summary>
         /// Backup OS disks of VM only
         /// </summary>
-        [Parameter(Mandatory = false, ParameterSetName = AzureVMClassicComputeParameterSet)]
-        [Parameter(Mandatory = false, ParameterSetName = AzureVMComputeParameterSet)]
-        [Parameter(Mandatory = false, ParameterSetName = ModifyProtectionParameterSet)]
+        [Parameter(Mandatory = false, ParameterSetName = AzureVMClassicComputeParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.excludeAllDataDisks)]
+        [Parameter(Mandatory = false, ParameterSetName = AzureVMComputeParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.excludeAllDataDisks)]
+        [Parameter(Mandatory = false, ParameterSetName = ModifyProtectionParameterSet,
+            HelpMessage = ParamHelpMsgs.Item.excludeAllDataDisks)]
         public SwitchParameter ExcludeAllDataDisks { get; set; }
 
         public override void ExecuteCmdlet()

src/RecoveryServices/RecoveryServices.Backup/ParamHelpMsgs.cs

@@ -95,6 +95,10 @@ internal static class Item
             public const string EnableCompression = "A switch which will specify that the requested on-demand SQL backup should be compressed.";
             public const string ParentID = "Specified the ARM ID of an Instance or AG.";
             public const string FriendlyName = "FriendlyName of the backed up item";
+            public const string inclusionDiskList = "List of Disk LUNs to include in backup";
+            public const string exclusionDiskList = "List of Disk LUNs to exclude in backup";
+            public const string resetExclusionSettings = "Specifies to reset disk exclusion setting associated with the item";
+            public const string excludeAllDataDisks = "Option to specify to backup OS disks only";
         }
 
         internal static class ProtectableItem

src/RecoveryServices/RecoveryServices/help/Enable-AzRecoveryServicesBackupProtection.md

@@ -85,7 +85,7 @@ Accept wildcard characters: False
 ```
 
 ### -ExcludeAllDataDisks
-{{ Fill ExcludeAllDataDisks Description }}
+Option to specify to backup OS disks only
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter
@@ -100,7 +100,7 @@ Accept wildcard characters: False
 ```
 
 ### -ExclusionDisksList
-{{ Fill ExclusionDisksList Description }}
+List of Disk LUNs to exclude in backup
 
 ```yaml
 Type: System.String[]
@@ -115,7 +115,7 @@ Accept wildcard characters: False
 ```
 
 ### -InclusionDisksList
-{{ Fill InclusionDisksList Description }}
+List of Disk LUNs to include in backup
 
 ```yaml
 Type: System.String[]
@@ -192,7 +192,7 @@ Accept wildcard characters: False
 ```
 
 ### -ResetExclusionSettings
-{{ Fill ResetExclusionSettings Description }}
+Specifies to reset disk exclusion setting associated with the item
 
 ```yaml
 Type: System.Management.Automation.SwitchParameter