mark Instrumentation Key APIs Obsolete

BASE/src/Microsoft.ApplicationInsights/Extensibility/Implementation/TelemetryConfigurationFactory.cs

@@ -477,7 +477,9 @@ private static void SelectInstrumentationKey(TelemetryConfiguration configuratio
             else if (PlatformSingleton.Current.TryGetEnvironmentVariable(InstrumentationKeyEnvironmentVariable, out string instrumentationKeyEnVar))
             {
                 CoreEventSource.Log.TelemetryConfigurationFactoryFoundInstrumentationKeyEnvironmentVariable(variableName: InstrumentationKeyEnvironmentVariable);
+#pragma warning disable CS0618 // Type or member is obsolete
                 configuration.InstrumentationKey = instrumentationKeyEnVar;
+#pragma warning restore CS0618 // Type or member is obsolete
             }
 
             // SANITY CHECK - If Ikey is null, this means that neither the InstrumentationKey nor ConnectionString were set.

BASE/src/Microsoft.ApplicationInsights/Extensibility/Implementation/Tracing/HeartbeatProvider.cs

@@ -103,7 +103,9 @@ public string InstrumentationKey
             {
                 if (this.telemetryClient != null)
                 {
+#pragma warning disable CS0618 // Type or member is obsolete
                     this.telemetryClient.InstrumentationKey = value;
+#pragma warning restore CS0618 // Type or member is obsolete
                 }
             }
         }

BASE/src/Microsoft.ApplicationInsights/Extensibility/TelemetryConfiguration.cs

@@ -74,14 +74,17 @@ static TelemetryConfiguration()
         /// Initializes a new instance of the TelemetryConfiguration class.
         /// </summary>
         [EditorBrowsable(EditorBrowsableState.Never)]
+#pragma warning disable CS0618 // Type or member is obsolete
         public TelemetryConfiguration() : this(string.Empty, null)
+#pragma warning restore CS0618 // Type or member is obsolete
         {
         }
 
         /// <summary>
         /// Initializes a new instance of the TelemetryConfiguration class.
         /// </summary>
         /// <param name="instrumentationKey">The instrumentation key this configuration instance will provide.</param>
+        [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
         public TelemetryConfiguration(string instrumentationKey) : this(instrumentationKey, null)
         {
         }
@@ -91,6 +94,7 @@ public TelemetryConfiguration(string instrumentationKey) : this(instrumentationK
         /// </summary>
         /// <param name="instrumentationKey">The instrumentation key this configuration instance will provide.</param>
         /// <param name="channel">The telemetry channel to provide with this configuration instance.</param>
+        [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
         public TelemetryConfiguration(string instrumentationKey, ITelemetryChannel channel)
         {
             this.instrumentationKey = instrumentationKey ?? throw new ArgumentNullException(nameof(instrumentationKey));
@@ -149,8 +153,9 @@ internal set
         /// </remarks>
         public string InstrumentationKey
         {
-            get { return this.instrumentationKey; }
+            get => this.instrumentationKey;
 
+            [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
             set { this.instrumentationKey = value ?? throw new ArgumentNullException(nameof(this.InstrumentationKey)); }
         }
 
@@ -296,7 +301,9 @@ public string ConnectionString
                         ConnectionString = value,
                     };
 
+#pragma warning disable CS0618 // Type or member is obsolete
                     this.InstrumentationKey = endpointProvider.GetInstrumentationKey();
+#pragma warning restore CS0618 // Type or member is obsolete
 
                     this.EndpointContainer = new EndpointContainer(endpointProvider);
 

BASE/src/Microsoft.ApplicationInsights/TelemetryClient.cs

@@ -79,7 +79,9 @@ public TelemetryContext Context
         /// </summary>
         public string InstrumentationKey
         {
-            get { return this.Context.InstrumentationKey; }
+            get => this.Context.InstrumentationKey;
+
+            [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
             set { this.Context.InstrumentationKey = value; }
         }
 

LOGGING/src/ILogger/ApplicationInsightsLoggingBuilderExtensions.cs

@@ -34,6 +34,7 @@ public static ILoggingBuilder AddApplicationInsights(this ILoggingBuilder builde
         /// <param name="builder">The <see cref="ILoggingBuilder"/> to use.</param>
         /// <param name="instrumentationKey">Application insights instrumentation key.</param>
         /// <returns>Logging builder with Application Insights added to it.</returns>
+        [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
         public static ILoggingBuilder AddApplicationInsights(this ILoggingBuilder builder, string instrumentationKey)
         {
             if (builder == null)
@@ -53,6 +54,7 @@ public static ILoggingBuilder AddApplicationInsights(this ILoggingBuilder builde
         /// <param name="instrumentationKey">Application insights instrumentation key.</param>
         /// <param name="configureApplicationInsightsLoggerOptions">Action to configure ApplicationInsights logger.</param>
         /// <returns>Logging builder with Application Insights added to it.</returns>
+        [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
         public static ILoggingBuilder AddApplicationInsights(
             this ILoggingBuilder builder,
             string instrumentationKey,

NETCORE/src/Microsoft.ApplicationInsights.AspNetCore/Extensions/ApplicationInsightsExtensions.cs

@@ -44,6 +44,7 @@ public static IApplicationBuilder UseApplicationInsightsExceptionTelemetry(this
         /// <param name="services">The <see cref="IServiceCollection"/> instance.</param>
         /// <param name="instrumentationKey">Instrumentation key to use for telemetry.</param>
         /// <returns>The <see cref="IServiceCollection"/>.</returns>
+        [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
         public static IServiceCollection AddApplicationInsightsTelemetry(
             this IServiceCollection services,
             string instrumentationKey)

NETCORE/src/Microsoft.ApplicationInsights.WorkerService/ApplicationInsightsExtensions.cs

@@ -21,6 +21,7 @@ public static partial class ApplicationInsightsExtensions
         /// <param name="services">The <see cref="IServiceCollection"/> instance.</param>
         /// <param name="instrumentationKey">Instrumentation key to use for telemetry.</param>
         /// <returns>The <see cref="IServiceCollection"/>.</returns>
+        [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
         public static IServiceCollection AddApplicationInsightsTelemetryWorkerService(
             this IServiceCollection services,
             string instrumentationKey)

NETCORE/src/Shared/Extensions/ApplicationInsightsExtensions.cs

@@ -160,6 +160,7 @@ public static IServiceCollection ConfigureTelemetryModule<T>(
         /// <param name="endpointAddress">Sets telemetry endpoint address.</param>
         /// <param name="instrumentationKey">Sets instrumentation key.</param>
         /// <returns>The <see cref="IConfigurationBuilder"/>.</returns>
+        [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
         [SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "We made a mistake here, but we can't remove it from the public API now.")]
         public static IConfigurationBuilder AddApplicationInsightsSettings(this IConfigurationBuilder configurationSourceRoot,  bool? developerMode = null, string endpointAddress = null, string instrumentationKey = null)
             => configurationSourceRoot.AddApplicationInsightsSettings(connectionString: null, developerMode: developerMode, endpointAddress: endpointAddress, instrumentationKey: instrumentationKey);
@@ -173,6 +174,7 @@ public static IConfigurationBuilder AddApplicationInsightsSettings(this IConfigu
         /// <param name="endpointAddress">Sets telemetry endpoint address.</param>
         /// <param name="instrumentationKey">Sets instrumentation key.</param>
         /// <returns>The <see cref="IConfigurationBuilder"/>.</returns>
+        [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
         [SuppressMessage("ApiDesign", "RS0026:Do not add multiple public overloads with optional parameters", Justification = "We made a mistake here, but we can't remove it from the public API now.")]
         public static IConfigurationBuilder AddApplicationInsightsSettings(
             this IConfigurationBuilder configurationSourceRoot,
@@ -248,7 +250,10 @@ internal static void AddTelemetryConfiguration(
 
                 if (config.TryGetValue(primaryKey: InstrumentationKeyForWebSites, backupKey: InstrumentationKeyFromConfig, value: out string instrumentationKey))
                 {
+                    // TODO: CONSIDER WARNING ABOUT USING IKEY IN CONFIGURATION
+#pragma warning disable CS0618 // Type or member is obsolete
                     serviceOptions.InstrumentationKey = instrumentationKey;
+#pragma warning restore CS0618 // Type or member is obsolete
                 }
 
                 if (config.TryGetValue(primaryKey: DeveloperModeForWebSites, backupKey: DeveloperModeFromConfig, value: out string developerModeValue))

NETCORE/src/Shared/Extensions/ApplicationInsightsServiceOptions.cs

@@ -4,6 +4,7 @@ namespace Microsoft.ApplicationInsights.AspNetCore.Extensions
     namespace Microsoft.ApplicationInsights.WorkerService
 #endif
 {
+    using System;
     using System.Reflection;
     using Microsoft.ApplicationInsights.DependencyCollector;
 
@@ -59,6 +60,7 @@ public class ApplicationInsightsServiceOptions
         /// <summary>
         /// Gets or sets the default instrumentation key for the application.
         /// </summary>
+        [Obsolete("InstrumentationKey based global ingestion is being deprecated. Transition to using connection strings for data ingestion. https://aka.ms/MigrateToConnectionString")]
         public string InstrumentationKey { get; set; }
 
         /// <summary>
@@ -161,10 +163,12 @@ internal void CopyPropertiesTo(ApplicationInsightsServiceOptions target)
                 target.EndpointAddress = this.EndpointAddress;
             }
 
+#pragma warning disable CS0618 // Type or member is obsolete
             if (!string.IsNullOrEmpty(this.InstrumentationKey))
             {
                 target.InstrumentationKey = this.InstrumentationKey;
             }
+#pragma warning restore CS0618 // Type or member is obsolete
 
             if (!string.IsNullOrEmpty(this.ConnectionString))
             {

NETCORE/src/Shared/Implementation/TelemetryConfigurationOptionsSetup.cs

@@ -72,10 +72,12 @@ public void Configure(TelemetryConfiguration configuration)
         {
             try
             {
+#pragma warning disable CS0618 // Type or member is obsolete
                 if (this.applicationInsightsServiceOptions.InstrumentationKey != null)
                 {
                     configuration.InstrumentationKey = this.applicationInsightsServiceOptions.InstrumentationKey;
                 }
+#pragma warning restore CS0618 // Type or member is obsolete
 
                 if (this.telemetryModuleConfigurators.Any())
                 {

WEB/Src/WindowsServer/WindowsServer/UnhandledExceptionTelemetryModule.cs

@@ -62,7 +62,9 @@ public void Dispose()
 
         private static void CopyConfiguration(TelemetryConfiguration source, TelemetryConfiguration target)
         {
-            target.InstrumentationKey = source.InstrumentationKey;            
+#pragma warning disable CS0618 // Type or member is obsolete
+            target.InstrumentationKey = source.InstrumentationKey;
+#pragma warning restore CS0618 // Type or member is obsolete
 
             foreach (var telemetryInitializer in source.TelemetryInitializers)
             {