[RS Backup] Fixing 7349803 (documentation fixes) for Item in Cmdlet Layer

Author: dragonfly91

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/Item/DisableAzureRmRecoveryServicesBackupProtection.cs

@@ -28,17 +28,25 @@
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
     /// <summary>
-    /// Enable Azure Backup protection
+    /// Disable protection of an item protected by the recovery services vault. 
+    /// Returns the corresponding job created in the service to track this operation.
     /// </summary>
     [Cmdlet(VerbsLifecycle.Disable, "AzureRmRecoveryServicesBackupProtection"), 
     OutputType(typeof(JobBase))]
     public class DisableAzureRmRecoveryServicesBackupProtection : RecoveryServicesBackupCmdletBase
     {
+        /// <summary>
+        /// The protected item whose protection needs to be disabled.
+        /// </summary>
         [Parameter(Position = 1, Mandatory = true, HelpMessage = ParamHelpMsgs.Item.ProtectedItem, 
             ValueFromPipeline = true)]
         [ValidateNotNullOrEmpty]
         public ItemBase Item { get; set; }
 
+        /// <summary>
+        /// If this option is used, all the data backed up for this item will 
+        /// also be deleted and restoring the data will not be possible.
+        /// </summary>
         [Parameter(Position = 2, Mandatory = false, 
             HelpMessage = ParamHelpMsgs.Item.RemoveProtectionOption)]
         public SwitchParameter RemoveRecoveryPoints
@@ -47,6 +55,9 @@ public SwitchParameter RemoveRecoveryPoints
             set { DeleteBackupData = value; }
         }
 
+        /// <summary>
+        /// Prevents the confirmation dialog when specified.
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Item.ForceOption)]
         public SwitchParameter Force { get; set; }
 

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

@@ -28,7 +28,8 @@
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
     /// <summary>
-    /// Enable Azure Backup protection
+    /// Enable protection of an item with the recovery services vault. 
+    /// Returns the corresponding job created in the service to track this operation.
     /// </summary>
     [Cmdlet(VerbsLifecycle.Enable, "AzureRmRecoveryServicesBackupProtection", 
         DefaultParameterSetName = AzureVMComputeParameterSet), OutputType(typeof(JobBase))]
@@ -38,26 +39,41 @@ public class EnableAzureRmRecoveryServicesBackupProtection : RecoveryServicesBac
         internal const string AzureVMComputeParameterSet = "AzureVMComputeEnableProtection";
         internal const string ModifyProtectionParameterSet = "ModifyProtection";
 
+        /// <summary>
+        /// Policy to be associated with this item as part of the protection operation.
+        /// </summary>
         [Parameter(Position = 1, Mandatory = true, HelpMessage = ParamHelpMsgs.Policy.ProtectionPolicy)]
         [ValidateNotNullOrEmpty]
         public PolicyBase Policy { get; set; }
 
+        /// <summary>
+        /// Name of the Azure VM whose representative item needs to be protected.
+        /// </summary>
         [Parameter(Position = 2, Mandatory = true, ValueFromPipelineByPropertyName = true, 
             ParameterSetName = AzureVMClassicComputeParameterSet, HelpMessage = ParamHelpMsgs.Item.AzureVMName)]
         [Parameter(Mandatory = true, ValueFromPipelineByPropertyName = true, 
             ParameterSetName = AzureVMComputeParameterSet, HelpMessage = ParamHelpMsgs.Item.AzureVMName)]
         public string Name { get; set; }
 
+        /// <summary>
+        /// Service name of the classic Azure VM whose representative item needs to be protected.
+        /// </summary>
         [Parameter(Position = 3, Mandatory = true, ValueFromPipelineByPropertyName = true,
             ParameterSetName = AzureVMClassicComputeParameterSet, 
             HelpMessage = ParamHelpMsgs.Item.AzureVMServiceName)]
         public string ServiceName { get; set; }
 
+        /// <summary>
+        /// Resource group name of the compute Azure VM whose representative item needs to be protected.
+        /// </summary>
         [Parameter(Position = 3, Mandatory = true, ValueFromPipelineByPropertyName = true, 
             ParameterSetName = AzureVMComputeParameterSet, 
             HelpMessage = ParamHelpMsgs.Item.AzureVMResourceGroupName)]
         public string ResourceGroupName { get; set; }
 
+        /// <summary>
+        /// Item whose protection needs to be modified.
+        /// </summary>
         [Parameter(Position = 4, Mandatory = true, ParameterSetName = ModifyProtectionParameterSet, 
             HelpMessage = ParamHelpMsgs.Item.ProtectedItem, ValueFromPipeline = true)]
         [ValidateNotNullOrEmpty]

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/Item/GetAzureRmRecoveryServicesBackupItem.cs

@@ -24,7 +24,8 @@
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
     /// <summary>
-    /// Get list of items
+    /// Get list of items associated with the recovery services vault 
+    /// according to the filters passed via the cmdlet parameters.
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmRecoveryServicesBackupItem", 
         DefaultParameterSetName = GetItemsForContainerParamSet), OutputType(typeof(ItemBase),
@@ -34,28 +35,46 @@ public class GetAzureRmRecoveryServicesBackupItem : RecoveryServicesBackupCmdlet
         internal const string GetItemsForContainerParamSet = "GetItemsForContainer";
         internal const string GetItemsForVaultParamSet = "GetItemsForVault";
 
+        /// <summary>
+        /// When this option is specified, only those items which belong to this container will be returned.
+        /// </summary>
         [Parameter(Mandatory = true, Position = 1, HelpMessage = ParamHelpMsgs.Item.Container,
             ParameterSetName = GetItemsForContainerParamSet)]
         [ValidateNotNullOrEmpty]
         public ContainerBase Container { get; set; }
 
+        /// <summary>
+        /// Backup management type of the items to be returned.
+        /// </summary>
         [Parameter(Mandatory = true, Position = 1, HelpMessage = ParamHelpMsgs.Common.BackupManagementType,
             ParameterSetName = GetItemsForVaultParamSet)]
         [ValidateNotNullOrEmpty]
         public BackupManagementType BackupManagementType { get; set; }
 
+        /// <summary>
+        /// Friendly name of the item to be returned.
+        /// </summary>
         [Parameter(Mandatory = false, Position = 2, HelpMessage = ParamHelpMsgs.Item.AzureVMName)]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
+        /// <summary>
+        /// Status of protection of the item to be returned.
+        /// </summary>
         [Parameter(Mandatory = false, Position = 3, HelpMessage = ParamHelpMsgs.Item.ProtectionStatus)]
         [ValidateNotNullOrEmpty]
         public ItemProtectionStatus ProtectionStatus { get; set; }
 
+        /// <summary>
+        /// State of protection of the item to be returned.
+        /// </summary>
         [Parameter(Mandatory = false, Position = 4, HelpMessage = ParamHelpMsgs.Item.Status)]
         [ValidateNotNullOrEmpty]
         public ItemProtectionState ProtectionState { get; set; }
 
+        /// <summary>
+        /// Workload type of the item to be returned.
+        /// </summary>
         [Parameter(Mandatory = true, Position = 5, HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
         [ValidateNotNullOrEmpty]
         public WorkloadType WorkloadType { get; set; }