Add Interface to Send Auth Info to Telemetry

src/Authentication.Abstractions/AuthenticationInfo.cs

@@ -0,0 +1,48 @@
+// ----------------------------------------------------------------------------------
+//
+// 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.Collections.Concurrent;
+using System;
+using System.Collections.Generic;
+
+namespace Microsoft.Azure.Commands.Common.Authentication.Abstractions
+{
+    public class AuthenticationInfo : IAuthenticationInfo
+    {
+        /// <summary>
+        /// Class name of the TokenCredential, stands for the authentication method
+        /// </summary>
+        public string TokenCredentialName { get; set; }
+
+        /// <summary>
+        /// Authority Uri to do the authentiation
+        /// </summary>
+        public string AuthorityUri { get; set; }
+
+        /// <summary>
+        /// Authentication process succeed or not.
+        /// </summary>
+        public bool AuthenticationSuccess { get; set; } = false;
+
+        /// <summary>
+        /// Additional properties for AuthenticationInfo
+        /// </summary>
+        public IDictionary<string, string> ExtendedProperties { get; } = new ConcurrentDictionary<string, string>(StringComparer.OrdinalIgnoreCase);
+
+        /// <summary>
+        /// Key to show whether token cache is enabled or not.
+        /// </summary>
+        public const string TokenCacheEnabled = "TokenCacheEnabled";
+    }
+}

src/Authentication.Abstractions/Interfaces/IAuthenticationFactory.cs

@@ -94,5 +94,10 @@ IAccessToken Authenticate(
         /// <param name="account">The account to remove credentials for</param>
         /// <param name="tokenCache">The TokenCache to remove credentials from</param>
         void RemoveUser(IAzureAccount account, IAzureTokenCache tokenCache);
+
+        /// <summary>
+        /// Get the information to be recorded in Telemetry
+        /// </summary>
+        IAuthenticationInfo GetDataForTelemetry();
     }
 }

src/Authentication.Abstractions/Interfaces/IAuthenticationInfo.cs

@@ -0,0 +1,34 @@
+// ----------------------------------------------------------------------------------
+//
+// 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.
+// ----------------------------------------------------------------------------------
+
+namespace Microsoft.Azure.Commands.Common.Authentication.Abstractions
+{
+    public interface IAuthenticationInfo : IExtensibleModel
+    {
+        /// <summary>
+        /// Class name of the TokenCredential, stands for the authentication method
+        /// </summary>
+        string TokenCredentialName { get; set; }
+
+        /// <summary>
+        /// Authority Uri to do the authentiation
+        /// </summary>
+        string AuthorityUri { get; set; }
+
+        /// <summary>
+        /// Authentication process succeed or not.
+        /// </summary>
+        bool AuthenticationSuccess { get; set; }
+    }
+}

src/Common/AzurePSCmdlet.cs

@@ -430,6 +430,8 @@ protected override void EndProcessing()
             WriteWarningMessageForVersionUpgrade();
             WriteSecretsWarningMessage();
 
+            _qosEvent.AuthInfo = AzureSession.Instance.AuthenticationFactory.GetDataForTelemetry();
+
             if (MetricHelper.IsCalledByUser()
                 && SurveyHelper.GetInstance().ShouldPromptAzSurvey()
                 && (AzureSession.Instance.TryGetComponent<IConfigManager>(nameof(IConfigManager), out var configManager)

src/Common/MetricHelper.cs

@@ -292,6 +292,18 @@ public void SetPSHost(PSHost host)
         {
         }
 
+        private static void PopulateAuthenticationInfoFromQos(IAuthenticationInfo info, IDictionary<string, string> eventProperties)
+        {
+            eventProperties[$"auth-info-{nameof(info.TokenCredentialName).ToLower()}"] = info.TokenCredentialName;
+            eventProperties[$"auth-info-{nameof(info.AuthorityUri).ToLower()}"] = info.AuthorityUri;
+            eventProperties[$"auth-info-{nameof(info.AuthenticationSuccess).ToLower()}"] = info.AuthenticationSuccess.ToString();
+
+            foreach (var property in info.ExtendedProperties)
+            {
+                eventProperties[$"auth-info-{property.Key.ToLower()}"] = property.Value;
+            }
+        }
+
         private void PopulatePropertiesFromQos(AzurePSQoSEvent qos, IDictionary<string, string> eventProperties, bool populateException = false)
         {
             if (qos == null)
@@ -454,6 +466,7 @@ private void PopulatePropertiesFromQos(AzurePSQoSEvent qos, IDictionary<string,
 
             PopulateConfigMetricsFromQos(qos, eventProperties);
             PopulateSanitizerPropertiesFromQos(qos, eventProperties);
+            PopulateAuthenticationInfoFromQos(qos.AuthInfo, eventProperties);
 
             if (qos.InputFromPipeline != null)
             {
@@ -678,6 +691,8 @@ public class AzurePSQoSEvent
 
     public SanitizerTelemetry SanitizerInfo { get; set; }
 
+    public IAuthenticationInfo AuthInfo { get; set; }
+
     public AzurePSQoSEvent()
     {
         StartTime = DateTimeOffset.Now;