[Release 0.9.8] Merge master into dev

ChangeLog.md

@@ -7,7 +7,6 @@
   * Changed the output format of Get image cmdlets as a table
   * Fixed Set-AzureVMAccessExtension cmdlet
 * Azure Compute (Service Management) cmdlets
-  * Changed the warning message to a non-terminating error message for ResourceNotFound in VM cmdlets
   * Exposed ComputeImageConfig in Get-AzurePlatformVMImage cmdlet
   * Fixed Publish-AzurePlatformExtension and Set-AzurePlatformExtension cmdlets
 * Azure Backup - added the following cmdlets
@@ -44,6 +43,12 @@
   * Get-AzureSqlServerActiveDirectoryAdministrator
   * Set-AzureSqlServerActiveDirectoryAdministrator
   * Remove-AzureSqlServerActiveDirectoryAdministrator
+* SQL Server VM cmdlets (ARM)
+  * New-AzureVMSqlServerAutoPatchingConfig
+  * New-AzureVMSqlServerAutoBackupConfig
+  * Set-AzureVMSqlServerExtension
+  * Get-AzureVMSqlServerExtension
+  * Remove-AzureVMSqlServerExtension
 
 ## 2015.08.17 version 0.9.7
 * Azure Profile cmdlets

src/Common/AzurePSCmdlet.cs

@@ -1,4 +1,4 @@
-// ----------------------------------------------------------------------------------
+// ----------------------------------------------------------------------------------
 //
 // Copyright Microsoft Corporation
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,6 +21,10 @@
 using Microsoft.Azure.Common.Authentication;
 using Microsoft.Azure.Common.Authentication.Models;
 using Microsoft.WindowsAzure.Commands.Common;
+using Newtonsoft.Json;
+using System.IO;
+using System.Management.Automation.Host;
+using System.Threading;
 
 namespace Microsoft.WindowsAzure.Commands.Utilities.Common
 {
@@ -34,6 +38,18 @@ public abstract class AzurePSCmdlet : PSCmdlet, IDisposable
         private RecordingTracingInterceptor _httpTracingInterceptor;
 
         private DebugStreamTraceListener _adalListener;
+        protected static AzurePSDataCollectionProfile _dataCollectionProfile = null;
+
+        protected AzurePSQoSEvent QosEvent;
+
+        protected virtual bool IsUsageMetricEnabled {
+            get { return false; }
+        }
+
+        protected virtual bool IsErrorMetricEnabled
+        {
+            get { return true; }
+        }
 
         /// <summary>
         /// Gets the PowerShell module name used for user agent header.
@@ -60,10 +76,123 @@ public AzurePSCmdlet()
         }
 
         /// <summary>
-        /// Cmdlet begin process. Write to logs, setup Http Tracing and initialize profile and adds user agent.
+        /// Initialize the data collection profile
+        /// </summary>
+        protected static void InitializeDataCollectionProfile()
+        {
+            if (_dataCollectionProfile != null && _dataCollectionProfile.EnableAzureDataCollection.HasValue)
+            {
+                return;
+            }
+
+            // Get the value of the environment variable for Azure PS data collection setting.
+            string value = Environment.GetEnvironmentVariable(AzurePSDataCollectionProfile.EnvironmentVariableName);
+            if (!string.IsNullOrWhiteSpace(value))
+            {
+                if (string.Equals(value, bool.FalseString, StringComparison.OrdinalIgnoreCase))
+                {
+                    // Disable data collection only if it is explictly set to 'false'.
+                    _dataCollectionProfile = new AzurePSDataCollectionProfile(true);
+                }
+                else if (string.Equals(value, bool.TrueString, StringComparison.OrdinalIgnoreCase))
+                {
+                    // Enable data collection only if it is explictly set to 'true'.
+                    _dataCollectionProfile = new AzurePSDataCollectionProfile(false);
+                }
+            }
+
+            // If the environment value is null or empty, or not correctly set, try to read the setting from default file location.
+            if (_dataCollectionProfile == null)
+            {
+                string fileFullPath = Path.Combine(AzureSession.ProfileDirectory, AzurePSDataCollectionProfile.DefaultFileName);
+                if (File.Exists(fileFullPath))
+                {
+                    string contents = File.ReadAllText(fileFullPath);
+                    _dataCollectionProfile = JsonConvert.DeserializeObject<AzurePSDataCollectionProfile>(contents);
+                }
+            }
+
+            // If the environment variable or file content is not set, create a new profile object.
+            if (_dataCollectionProfile == null)
+            {
+                _dataCollectionProfile = new AzurePSDataCollectionProfile();
+            }
+        }
+
+        /// <summary>
+        /// Get the data collection profile
+        /// </summary>
+        protected static AzurePSDataCollectionProfile GetDataCollectionProfile()
+        {
+            if (_dataCollectionProfile == null)
+            {
+                InitializeDataCollectionProfile();
+            }
+
+            return _dataCollectionProfile;
+        }
+
+        /// <summary>
+        /// Check whether the data collection is opted in from user
+        /// </summary>
+        /// <returns>true if allowed</returns>
+        public static bool IsDataCollectionAllowed()
+        {
+            if (_dataCollectionProfile != null &&
+                _dataCollectionProfile.EnableAzureDataCollection.HasValue &&
+                _dataCollectionProfile.EnableAzureDataCollection.Value)
+            {
+                return true;
+            }
+
+            return false;
+        }
+
+        /// <summary>
+        /// Save the current data collection profile Json data into the default file path
+        /// </summary>
+        /// <param name="profile"></param>
+        protected abstract void SaveDataCollectionProfile();
+
+        protected bool CheckIfInteractive()
+        {
+            bool interactive = true;
+            if (this.Host == null || this.Host.UI == null || this.Host.UI.RawUI == null)
+            {
+                interactive = false;
+            }
+            else
+            {
+                try
+                {
+                    var test = this.Host.UI.RawUI.KeyAvailable;
+                }
+                catch
+                {
+                    interactive = false;
+                }
+            }
+
+            if (!interactive && !_dataCollectionProfile.EnableAzureDataCollection.HasValue)
+            {
+                _dataCollectionProfile.EnableAzureDataCollection = false;
+            }
+            return interactive;
+        }
+
+        /// <summary>
+        /// Prompt for the current data collection profile
+        /// </summary>
+        /// <param name="profile"></param>
+        protected abstract void PromptForDataCollectionProfileIfNotExists();
+
+        /// <summary>
+        /// Cmdlet begin process. Write to logs, setup Http Tracing and initialize profile
         /// </summary>
         protected override void BeginProcessing()
         {
+            PromptForDataCollectionProfileIfNotExists();
+            InitializeQosEvent();
             if (string.IsNullOrEmpty(ParameterSetName))
             {
                 WriteDebugWithTimestamp(string.Format("{0} begin processing without ParameterSet.", this.GetType().Name));
@@ -95,6 +224,7 @@ protected override void BeginProcessing()
         /// </summary>
         protected override void EndProcessing()
         {
+            LogQosEvent();
             string message = string.Format("{0} end processing.", this.GetType().Name);
             WriteDebugWithTimestamp(message);
 
@@ -125,6 +255,13 @@ protected bool IsVerbose()
         protected new void WriteError(ErrorRecord errorRecord)
         {
             FlushDebugMessages();
+            if (QosEvent != null && errorRecord != null)
+            {
+                QosEvent.Exception = errorRecord.Exception;
+                QosEvent.IsSuccess = false;
+                LogQosEvent(true);
+            }
+
             base.WriteError(errorRecord);
         }
 
@@ -234,6 +371,45 @@ private void FlushDebugMessages()
             }
         }
 
+        protected abstract void InitializeQosEvent();
+
+        /// <summary>
+        /// Invoke this method when the cmdlet is completed or terminated.
+        /// </summary>
+        protected void LogQosEvent(bool waitForMetricSending = false)
+        {
+            if (QosEvent == null)
+            {
+                return;
+            }
+
+            QosEvent.FinishQosEvent();
+
+            if (!IsUsageMetricEnabled && (!IsErrorMetricEnabled || QosEvent.IsSuccess))
+            {
+                return;
+            }
+
+            if (!IsDataCollectionAllowed())
+            {
+                return;
+            }
+
+            WriteDebug(QosEvent.ToString());
+
+            try
+            {
+                MetricHelper.LogQoSEvent(QosEvent, IsUsageMetricEnabled, IsErrorMetricEnabled);
+                MetricHelper.FlushMetric(waitForMetricSending);
+                WriteDebug("Finish sending metric.");
+            }
+            catch (Exception e)
+            {
+                //Swallow error from Application Insights event collection.
+                WriteWarning(e.ToString());
+            }
+        }
+
         /// <summary>
         /// Asks for confirmation before executing the action.
         /// </summary>
@@ -244,10 +420,19 @@ private void FlushDebugMessages()
         /// <param name="action">The action code</param>
         protected void ConfirmAction(bool force, string actionMessage, string processMessage, string target, Action action)
         {
+            if (QosEvent != null)
+            {
+                QosEvent.PauseQoSTimer();
+            }
+
             if (force || ShouldContinue(actionMessage, ""))
             {
                 if (ShouldProcess(target, processMessage))
-                {
+                {                 
+                    if (QosEvent != null)
+                    {
+                        QosEvent.ResumeQosTimer();
+                    }
                     action();
                 }
             }

src/Common/Commands.Common/AzurePSDataCollectionProfile.cs

@@ -0,0 +1,39 @@
+// ----------------------------------------------------------------------------------
+//
+// 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.IO;
+using Newtonsoft.Json;
+using Microsoft.Azure.Common.Authentication;
+
+namespace Microsoft.WindowsAzure.Commands.Common
+{
+    public class AzurePSDataCollectionProfile
+    {
+        public const string EnvironmentVariableName = "Azure_PS_Data_Collection";
+        public static string DefaultFileName = "AzureDataCollectionProfile.json";
+
+        public AzurePSDataCollectionProfile()
+        {
+        }
+
+        public AzurePSDataCollectionProfile(bool enable)
+        {
+            EnableAzureDataCollection = enable;
+        }
+
+        [JsonProperty(PropertyName = "enableAzureDataCollection")]
+        public bool? EnableAzureDataCollection { get; set; }
+    }
+}