Address Mark's code review comments - add copyright headers, document classes, remove excessive positional parameters

Author: Nicholas King

src/ResourceManager/Websites/Commands.Websites/Cmdlets/BackupRestore/AzureWebAppBackup.cs

@@ -1,27 +1,112 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
 
 using System;
 using Microsoft.Azure.Management.WebSites.Models;
 
 namespace Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps
 {
+    /// <summary>
+    /// A simple class containing fields for all metadata associated with a backup.
+    /// </summary>
     public class AzureWebAppBackup
     {
+        /// <summary>
+        /// The resource group of the web app
+        /// </summary>
         public string ResourceGroupName { get; set; }
+        
+        /// <summary>
+        /// The name of the web app
+        /// </summary>
         public string Name { get; set; }
+
+        /// <summary>
+        /// The name of the web app slot
+        /// </summary>
         public string Slot { get; set; }
+
+        /// <summary>
+        /// SAS URL for the storage account container which contains this backup
+        /// </summary>
         public string StorageAccountUrl { get; set; }
+
+        /// <summary>
+        /// Name of the blob which contains data for this backup
+        /// </summary>
         public string BlobName { get; set; }
+
+        /// <summary>
+        /// Databases that are included in this backup
+        /// </summary>
         public DatabaseBackupSetting[] Databases { get; set; }
+
+        /// <summary>
+        /// The numberic ID of this backup
+        /// </summary>
         public int? BackupId { get; set; }
+
+        /// <summary>
+        /// The user-friendly name of this backup
+        /// </summary>
         public string BackupName { get; set; }
+
+        /// <summary>
+        /// The status of the backup. Possible values are InProgress, Failed, Succeeded,
+        /// TimedOut, Created, Skipped, PartiallySucceeded, DeleteInProgress, DeleteFailed,
+        /// Deleted. 
+        /// </summary>
         public string BackupStatus { get; set; }
+
+        /// <summary>
+        /// True if this backup was automatically created due to a backup schedule
+        /// </summary>
         public bool? Scheduled { get; set; }
+
+        /// <summary>
+        /// The size of this backup in bytes
+        /// </summary>
         public long? BackupSizeInBytes { get; set; }
+
+        /// <summary>
+        /// Size of the original web app which has been backed up
+        /// </summary>
         public long? WebsiteSizeInBytes { get; set; }
+
+        /// <summary>
+        /// Time when the backup was requested
+        /// </summary>
         public DateTime? Created { get; set; }
+
+        /// <summary>
+        /// Time when the web app was last restored from this backup
+        /// </summary>
         public DateTime? LastRestored { get; set; }
+
+        /// <summary>
+        /// Time when the backup finished
+        /// </summary>
         public DateTime? Finished { get; set; }
+
+        /// <summary>
+        /// Log of any failures or warnings associated with this backup
+        /// </summary>
         public string Log { get; set; }
+
+        /// <summary>
+        /// Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.
+        /// </summary>
         public string CorrelationId { get; set; }
     }
 }

src/ResourceManager/Websites/Commands.Websites/Cmdlets/BackupRestore/AzureWebAppBackupConfiguration.cs

@@ -1,20 +1,75 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
 
 using System;
 using Microsoft.Azure.Management.WebSites.Models;
 
 namespace Microsoft.Azure.Commands.WebApps.Cmdlets.WebApps
 {
+    /// <summary>
+    /// A simple class containing fields for all metadata associated with a backup configuration.
+    /// </summary>
     public class AzureWebAppBackupConfiguration
     {
+        /// <summary>
+        /// The name of the web app
+        /// </summary>
         public string Name { get; set; }
+
+        /// <summary>
+        /// The resource group of the web app
+        /// </summary>
         public string ResourceGroupName { get; set; }
+
+        /// <summary>
+        /// SAS URL for the storage account container to use for scheduled backups
+        /// </summary>
         public string StorageAccountUrl { get; set; }
+
+        /// <summary>
+        /// Numeric part of backup frequency. For example, for weekly backups, FrequencyInterval = 7 and FrequencyUnit = Day.
+        /// </summary>
         public int? FrequencyInterval { get; set; }
+
+        /// <summary>
+        /// Unit of backup frequency. Valid options are Hour and Day. For example, for weekly backups, FrequencyInterval = 7 and FrequencyUnit = Day.
+        /// </summary>
         public string FrequencyUnit { get; set; }
+
+        /// <summary>
+        /// Number of days the automatic backups should be retained before being automatically deleted.
+        /// </summary>
         public int? RetentionPeriodInDays { get; set; }
+
+        /// <summary>
+        /// The time when the first automatic backup should be created.
+        /// </summary>
         public DateTime? StartTime { get; set; }
+
+        /// <summary>
+        /// The databases to be backed up automatically along with the website
+        /// </summary>
         public DatabaseBackupSetting[] Databases { get; set; }
+
+        /// <summary>
+        /// True if one backup should always be left in the storage account regardless of retention period.
+        /// </summary>
         public bool? KeepAtLeastOneBackup { get; set; }
+
+        /// <summary>
+        /// True if the automatic backups are enabled.
+        /// </summary>
         public bool? Enabled { get; set; }
     }
 }

src/ResourceManager/Websites/Commands.Websites/Cmdlets/BackupRestore/BackupRestoreUtils.cs

@@ -1,3 +1,16 @@
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
 
 using System;
 using System.Linq;

src/ResourceManager/Websites/Commands.Websites/Cmdlets/BackupRestore/EditAzureWebAppBackupConfiguration.cs

@@ -12,7 +12,6 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
-
 using System;
 using System.Collections.Generic;
 using System.Linq;

src/ResourceManager/Websites/Commands.Websites/Cmdlets/BackupRestore/NewAzureRmWebAppDatabaseBackupSetting.cs

@@ -1,4 +1,18 @@
-using System;
+// ----------------------------------------------------------------------------------
+//
+// Copyright Microsoft Corporation
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// ----------------------------------------------------------------------------------
+
+using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Management.Automation;

src/ResourceManager/Websites/Commands.Websites/Cmdlets/BackupRestore/NewAzureWebAppBackup.cs

@@ -33,7 +33,7 @@ public class NewAzureWebAppBackup : WebAppOptionalSlotBaseCmdlet
         [Parameter(Position = 4, Mandatory = false, HelpMessage = "The name of the backup.", ValueFromPipelineByPropertyName = true)]
         public string BackupName { get; set; }
 
-        [Parameter(Position = 5, Mandatory = false, HelpMessage = "The databases to backup.", ValueFromPipelineByPropertyName = true)]
+        [Parameter(Mandatory = false, HelpMessage = "The databases to backup.", ValueFromPipelineByPropertyName = true)]
         public DatabaseBackupSetting[] Databases;
 
         public override void ExecuteCmdlet()

src/ResourceManager/Websites/Commands.Websites/Cmdlets/BackupRestore/RemoveAzureWebAppBackup.cs

@@ -12,7 +12,6 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
-
 using System;
 using System.Collections.Generic;
 using System.Linq;

src/ResourceManager/Websites/Commands.Websites/Cmdlets/BackupRestore/RestoreAzureWebAppBackup.cs

@@ -12,7 +12,6 @@
 // limitations under the License.
 // ----------------------------------------------------------------------------------
 
-
 using System.Collections.Generic;
 using System.Management.Automation;
 using Microsoft.Azure.Commands.WebApps.Utilities;
@@ -34,13 +33,13 @@ public class RestoreAzureWebAppBackup : WebAppOptionalSlotBaseCmdlet
         [ValidateNotNullOrEmpty]
         public string BlobName;
 
-        [Parameter(Position = 5, Mandatory = false, HelpMessage = "The databases to restore. Must match the list of databases in the backup.", ValueFromPipelineByPropertyName = true)]
+        [Parameter(Mandatory = false, HelpMessage = "The databases to restore. Must match the list of databases in the backup.", ValueFromPipelineByPropertyName = true)]
         public DatabaseBackupSetting[] Databases { get; set; }
 
-        [Parameter(Position = 6, Mandatory = false, HelpMessage = "If specified, an existing web app will be overwritten by the contents of the backup.", ValueFromPipelineByPropertyName = true)]
+        [Parameter(Mandatory = false, HelpMessage = "If specified, an existing web app will be overwritten by the contents of the backup.", ValueFromPipelineByPropertyName = true)]
         public SwitchParameter Overwrite;
 
-        [Parameter(Position = 7, Mandatory = false, HelpMessage = "If specified, custom domains are removed automatically during restore. Otherwise, custom domains are added to the site object when it is being restored, but the restore might fail due to conflicts.", ValueFromPipelineByPropertyName = true)]
+        [Parameter(Mandatory = false, HelpMessage = "If specified, custom domains are removed automatically during restore. Otherwise, custom domains are added to the site object when it is being restored, but the restore might fail due to conflicts.", ValueFromPipelineByPropertyName = true)]
         public SwitchParameter IgnoreConflictingHostNames { get; set; }
 
         public override void ExecuteCmdlet()

src/ResourceManager/Websites/Commands.Websites/Models.WebApp/WebAppOptionalSlotBaseCmdlet.cs

@@ -8,8 +8,8 @@ namespace Microsoft.Azure.Commands.WebApps
     // For some cmdlets, the slot is optional, but will be used if specified.
     public class WebAppOptionalSlotBaseCmdlet : WebAppBaseClientCmdLet
     {
-        protected const string ParameterSet1Name = "S1";
-        protected const string ParameterSet2Name = "S2";
+        protected const string ParameterSet1Name = "FromResourceName";
+        protected const string ParameterSet2Name = "FromWebApp";
 
         [Parameter(ParameterSetName = ParameterSet1Name, Position = 0, Mandatory = true,
             HelpMessage = "The name of the resource group.", ValueFromPipelineByPropertyName = true)]