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

Author: dragonfly91

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/ProtectionPolicy/GetAzureRmRecoveryServicesBackupProtectionPolicy.cs

@@ -27,7 +27,8 @@
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
     /// <summary>
-    /// Get list of protection policies
+    /// Gets the list of protection policies associated with this recovery services vault
+    /// according to the filters passed via the cmdlet parameters.
     /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmRecoveryServicesBackupProtectionPolicy", DefaultParameterSetName = NoParamSet), 
             OutputType(typeof(PolicyBase), typeof(IList<PolicyBase>))]
@@ -38,18 +39,27 @@ public class GetAzureRmRecoveryServicesBackupProtectionPolicy : RecoveryServices
         protected const string NoParamSet = "NoParamSet";
         protected const string WorkloadBackupMangementTypeParamSet = "WorkloadBackupManagementTypeParamSet";
 
+        /// <summary>
+        /// Name of the policy to be fetched.
+        /// </summary>
         [Parameter(ParameterSetName = PolicyNameParamSet, Position = 1, 
             Mandatory = true, HelpMessage = ParamHelpMsgs.Policy.Name)]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
+        /// <summary>
+        /// Workload type of the policy to be fetched
+        /// </summary>
         [Parameter(ParameterSetName = WorkloadParamSet, Position = 2, 
             Mandatory = true, HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
         [Parameter(ParameterSetName = WorkloadBackupMangementTypeParamSet, Position = 2, 
             Mandatory = true, HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
         [ValidateNotNullOrEmpty]
         public WorkloadType? WorkloadType { get; set; }
 
+        /// <summary>
+        /// Backup management type of the policy to be fetched
+        /// </summary>
         [Parameter(ParameterSetName = WorkloadBackupMangementTypeParamSet, Position = 3, 
             Mandatory = true, HelpMessage = ParamHelpMsgs.Common.BackupManagementType)]
         [ValidateNotNullOrEmpty]

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/ProtectionPolicy/GetAzureRmRecoveryServicesBackupRetentionPolicyObject.cs

@@ -23,15 +23,25 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
+    /// <summary>
+    /// Returns a retention policy PS object which can be modified in the PS shell 
+    /// and fed to other cmdlets which accept it.
+    /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmRecoveryServicesBackupRetentionPolicyObject"),
     OutputType(typeof(RetentionPolicyBase))]
     public class GetAzureRmRecoveryServicesBackupRetentionPolicyObject : RecoveryServicesBackupCmdletBase
     {
+        /// <summary>
+        /// Workload type of the policy to be created.
+        /// </summary>
         [Parameter(Mandatory = true, Position = 0, 
             HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
         [ValidateNotNullOrEmpty]
         public WorkloadType WorkloadType { get; set; }
 
+        /// <summary>
+        /// Backup management type of the policy to be created.
+        /// </summary>
         [Parameter(Mandatory = false, Position = 1, 
             HelpMessage = ParamHelpMsgs.Common.BackupManagementType)]
         [ValidateNotNullOrEmpty]

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/ProtectionPolicy/GetAzureRmRecoveryServicesBackupSchedulePolicyObject.cs

@@ -23,15 +23,25 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
+    /// <summary>
+    /// Returns a schedule policy PS object which can be modified in the PS shell 
+    /// and fed to other cmdlets which accept it.
+    /// </summary>
     [Cmdlet(VerbsCommon.Get, "AzureRmRecoveryServicesBackupSchedulePolicyObject"), 
     OutputType(typeof(SchedulePolicyBase))]
     public class GetAzureRmRecoveryServicesBackupSchedulePolicyObject : RecoveryServicesBackupCmdletBase
     {
+        /// <summary>
+        /// Workload type of the policy to be created.
+        /// </summary>
         [Parameter(Mandatory = true, Position = 0, 
             HelpMessage = ParamHelpMsgs.Common.WorkloadType)]
         [ValidateNotNullOrEmpty]
         public WorkloadType WorkloadType { get; set; }
 
+        /// <summary>
+        /// Backup management type of the policy to be created.
+        /// </summary>
         [Parameter(Mandatory = false, Position = 1, 
             HelpMessage = ParamHelpMsgs.Common.BackupManagementType)]
         [ValidateNotNullOrEmpty]

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/ProtectionPolicy/NewAzureRmRecoveryServicesBackupProtectionPolicy.cs

@@ -27,30 +27,45 @@
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
     /// <summary>
-    /// Create new protection policy
+    /// Creates a new protection policy based on the parameters provided in to the recovery services vault.
     /// </summary>
     [Cmdlet(VerbsCommon.New, "AzureRmRecoveryServicesBackupProtectionPolicy"), OutputType(typeof(PolicyBase))]
     public class NewAzureRmRecoveryServicesBackupProtectionPolicy : RecoveryServicesBackupCmdletBase
     {
+        /// <summary>
+        /// Name of the policy to be created
+        /// </summary>
         [Parameter(Position = 1, Mandatory = true, HelpMessage = ParamHelpMsgs.Policy.Name)]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
+        /// <summary>
+        /// Workload type that is managed by this policy
+        /// </summary>
         [Parameter(Position = 2, Mandatory = true, HelpMessage = ParamHelpMsgs.Common.WorkloadType,
             ValueFromPipelineByPropertyName = true)]
         [ValidateNotNullOrEmpty]
         public WorkloadType WorkloadType { get; set; }
 
+        /// <summary>
+        /// Backup management type of the policy to be created
+        /// </summary>
         [Parameter(Position = 3, Mandatory = false, HelpMessage = ParamHelpMsgs.Common.BackupManagementType,
             ValueFromPipelineByPropertyName = true)]
         [ValidateNotNullOrEmpty]
         public BackupManagementType? BackupManagementType { get; set; }
 
+        /// <summary>
+        /// Retention policy object associated with the policy to be created
+        /// </summary>
         [Parameter(Position = 4, Mandatory = false, HelpMessage = ParamHelpMsgs.Policy.RetentionPolicy, 
             ValueFromPipelineByPropertyName = true)]
         [ValidateNotNullOrEmpty]
         public RetentionPolicyBase RetentionPolicy { get; set; }
 
+        /// <summary>
+        /// Schedule policy object assoicated with the policy to be created
+        /// </summary>
         [Parameter(Position = 5, Mandatory = false, HelpMessage = ParamHelpMsgs.Policy.SchedulePolicy, 
             ValueFromPipelineByPropertyName = true)]
         [ValidateNotNullOrEmpty]

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/ProtectionPolicy/PolicyCmdletHelpers.cs

@@ -30,10 +30,17 @@
 
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {   
+    /// <summary>
+    /// Class hosting helper methods for policy related cmdlets.
+    /// </summary>
     public class PolicyCmdletHelpers 
     {
         public static Regex policyNameRgx = new Regex(@"^[A-Za-z][-A-Za-z0-9]*[A-Za-z0-9]$");
 
+        /// <summary>
+        /// Validates name of the policy
+        /// </summary>
+        /// <param name="policyName">Name of the policy</param>
         public static void ValidateProtectionPolicyName(string policyName)
         {
             if(string.IsNullOrEmpty(policyName))
@@ -53,6 +60,12 @@ public static void ValidateProtectionPolicyName(string policyName)
             }
         }
 
+        /// <summary>
+        /// Fetches policies by name
+        /// </summary>
+        /// <param name="policyName">Name of the policy to be fetched</param>
+        /// <param name="serviceClientAdapter">Service client adapter with which to make calls</param>
+        /// <returns></returns>
         public static ProtectionPolicyResponse GetProtectionPolicyByName(string policyName,
                                                  ServiceClientAdapter serviceClientAdapter)
         {

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/ProtectionPolicy/RemoveAzureRmRecoveryServicesBackupProtectionPolicy.cs

@@ -27,7 +27,7 @@
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
     /// <summary>
-    /// Update existing protection policy
+    /// Deletes an existing protection policy from the recovery services vault
     /// </summary>
     [Cmdlet(VerbsCommon.Remove, "AzureRmRecoveryServicesBackupProtectionPolicy", 
         DefaultParameterSetName = PolicyNameParameterSet)]
@@ -36,17 +36,26 @@ public class RemoveAzureRmRecoveryServicesBackupProtectionPolicy : RecoveryServi
         internal const string PolicyNameParameterSet = "PolicyName";
         internal const string PolicyObjectParameterSet = "PolicyObject";
 
+        /// <summary>
+        /// Name of the policy to be deleted
+        /// </summary>
         [Parameter(Position = 1, Mandatory = true, HelpMessage = ParamHelpMsgs.Policy.Name, 
             ParameterSetName = PolicyNameParameterSet)]
         [ValidateNotNullOrEmpty]
         public string Name { get; set; }
 
+        /// <summary>
+        /// Policy object to be deleted
+        /// </summary>
         [Parameter(Position = 1, Mandatory = true, HelpMessage = ParamHelpMsgs.Policy.ProtectionPolicy, 
             ValueFromPipeline = true,
             ParameterSetName = PolicyObjectParameterSet)]
         [ValidateNotNullOrEmpty]
         public PolicyBase Policy { get; set; }
 
+        /// <summary>
+        /// When provided, force delete policy, without asking for user confirmation
+        /// </summary>
         [Parameter(Mandatory = false, HelpMessage = ParamHelpMsgs.Common.ConfirmationMessage)]
         public SwitchParameter Force { get; set; }
 

src/ResourceManager/RecoveryServices.Backup/Commands.RecoveryServices.Backup/Cmdlets/ProtectionPolicy/SetAzureRmRecoveryServicesBackupProtectionPolicy.cs

@@ -28,21 +28,30 @@
 namespace Microsoft.Azure.Commands.RecoveryServices.Backup.Cmdlets
 {
     /// <summary>
-    /// Update existing protection policy
+    /// Update existing protection policy in the recovery services vault
     /// </summary>
     [Cmdlet(VerbsCommon.Set, "AzureRmRecoveryServicesBackupProtectionPolicy"), 
     OutputType(typeof(List<CmdletModel.JobBase>))]
     public class SetAzureRmRecoveryServicesBackupProtectionPolicy : RecoveryServicesBackupCmdletBase
     {
+        /// <summary>
+        /// Policy object to be modified
+        /// </summary>
         [Parameter(Position = 1, Mandatory = true, HelpMessage = ParamHelpMsgs.Policy.ProtectionPolicy, 
             ValueFromPipeline = true)]
         [ValidateNotNullOrEmpty]
         public PolicyBase Policy { get; set; }
 
+        /// <summary>
+        /// Retention policy object to be modified
+        /// </summary>
         [Parameter(Position = 2, Mandatory = false, HelpMessage = ParamHelpMsgs.Policy.RetentionPolicy)]
         [ValidateNotNullOrEmpty]
         public RetentionPolicyBase RetentionPolicy { get; set; }
 
+        /// <summary>
+        /// Schedule policy object to be modified
+        /// </summary>
         [Parameter(Position = 3, Mandatory = false, HelpMessage = ParamHelpMsgs.Policy.SchedulePolicy)]
         [ValidateNotNullOrEmpty]
         public SchedulePolicyBase SchedulePolicy { get; set; }