AppConfiguration-DotnetProvider

Microsoft.Extensions.Configuration.AzureAppConfiguration 7.2.0 - May 2, 2024

Enhancements

• Added support for .NET 8 as a target framework. #530
• Improved JSON key-value deserialization. #537
• Updated Azure.Data.AppConfiguration reference to 1.4.1. #514.

Microsoft.Azure.AppConfiguration.AspNetCore 7.2.0 - May 2, 2024

Enhancements

• Added support for .NET 8 as a target framework. #530
• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.2.0. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 7.2.0 - May 2, 2024

Enhancements

• Added support for .NET 8 as a target framework. #530
• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.2.0. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 8.0.0-preview.2 - March 18, 2024

Bug Fixes

• Fixed a bug where a FormatException may be thrown for a variant feature flag when the configuration value was not set to a string or null. With this fix, the configuration value of a variant can be a string, number, boolean, array, or JSON object. #531

Microsoft.Azure.AppConfiguration.AspNetCore 8.0.0-preview.2 - March 18, 2024

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 8.0.0-preview.2. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 8.0.0-preview.2 - March 18, 2024

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 8.0.0-preview.2. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 8.0.0-preview - February 28, 2024

Enhancements

• Added new fields to feature flag telemetry metadata, including FeatureFlagId, FeatureFlagReference, and ETag. #517

Bug Fixes

• Fixed a bug where a feature flag would not be parsed correctly by the Microsoft.FeatureManagement library if the flag was enabled but had no filters. #525

Microsoft.Azure.AppConfiguration.AspNetCore 8.0.0-preview - February 28, 2024

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 8.0.0-preview. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 8.0.0-preview - February 28, 2024

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 8.0.0-preview. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 7.1.0 - February 26, 2024

Enhancements

• This is the first stable release of the Replica Auto-Discovery enhancement that was introduced in 7.1.0-preview.

Bug Fixes

• Fixed a bug where the provider would throw a KeyVaultReferenceException instead of retrying for transient errors while connecting to Key Vault during startup, even if the startup timeout had not elapsed. #516

Microsoft.Azure.AppConfiguration.AspNetCore 7.1.0 - February 26, 2024

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.1.0. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 7.1.0 - February 26, 2024

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.1.0. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 7.1.0-preview - January 19, 2024

Enhancements

• Replica Auto-Discovery: For App Configuration stores with geo-replication enabled, the provider will now automatically discover any additional replicas and attempt to connect to them when it fails to connect to user-provided endpoints in code. This capability allows applications to leverage geo-replication for enhanced resiliency without code change and redeployment. Replica discovery is enabled by default and can be disabled by setting the new AzureAppConfigurationOptions.ReplicaDiscoveryEnabled property equal to false. #442.

• Added support for the variants, allocation, and telemetry properties for feature flags introduced in version 4.0.0-preview of the Microsoft.FeatureManagement library. #476

Bug Fixes

• Fixed a bug where passing a null value for the key parameter to AzureAppConfigurationRefreshOptions.Register would throw a NullReferenceException. #503
• Fixed a bug with AzureAppConfigurationOptions.Select, FeatureFlagOptions.Select, and AzureAppConfigurationOptions.SelectSnapshot where additional calls with the same filters after the first call were ignored. The provider will now correctly use only the last call with duplicate filters to preserve the expected precedence. #490

Microsoft.Azure.AppConfiguration.AspNetCore 7.1.0-preview - January 19, 2024

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.1.0-preview. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 7.1.0-preview - January 19, 2024

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.1.0-preview. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 7.0.0 - November 21, 2023

Breaking Changes

• AddAzureAppConfiguration now throws ArgumentException for invalid inputs even if the optional parameter is equal to true. #318

Enhancements

• This is the first stable release of the following API introduced in the 7.0.0-preview release. #387

  public AzureAppConfigurationOptions SelectSnapshot(string name)
  

• Added support for the requirement_type property for feature flags introduced in version 2.6.0-preview of the Microsoft.FeatureManagement library. #406

• The initial configuration load now uses time-based retries instead of count-based retries in case of failures. The time-based retry often works more effectively in real-world scenarios, making applications more resilient to transient errors during startup. By default, the retry timeout is set to 100 seconds in AzureAppConfigurationOptions.StartupOptions.Timeout, but you can customize it using the following new API. #458

  public AzureAppConfigurationOptions ConfigureStartupOptions(Action<StartupOptions> configure)
  

• Added netstandard2.1 as a target framework. #482

Microsoft.Azure.AppConfiguration.AspNetCore 7.0.0 - November 21, 2023

• Removed .NET Core 3.1 as a target framework as .NET Core 3.1 is out of support. #482
• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.0.0. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 7.0.0 - November 21, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.0.0. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 6.1.1 - October 25, 2023

• Added improvements for request tracing.

Microsoft.Azure.AppConfiguration.AspNetCore 6.1.1 - October 25, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 6.1.1. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 6.1.1 - October 25, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 6.1.1. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 7.0.0-preview.2 - August 24, 2023

• Includes all changes made in 6.1.0.

Microsoft.Azure.AppConfiguration.AspNetCore 7.0.0-preview.2 - August 24, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.0.0-preview.2. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 7.0.0-preview.2 - August 24, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.0.0-preview.2. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 6.1.0 - August 17, 2023

• Fixed a bug where TryRefreshAsync could throw an AggregateException after a network timeout while trying to get key-values from Azure App Configuration. #440
• Designated a new environment variable AZURE_APP_CONFIGURATION_PROVIDER_DISABLED that when equal to "true" will disable Azure App Configuration in your application. #429
• Added a new warning log that indicates when the provider fails over to a different endpoint. #431

Microsoft.Azure.AppConfiguration.AspNetCore 6.1.0 - August 17, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 6.1.0. See the release notes for more information on the changes.
• Fixed an issue where accessing HttpContext could sometimes throw a NullReferenceException in middleware used alongside Azure App Configuration middleware. #432

Microsoft.Azure.AppConfiguration.Functions.Worker 6.1.0 - August 17, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 6.1.0. See the release notes for more information on the changes.
• Fixed an issue where accessing HttpContext could sometimes throw a NullReferenceException in middleware used alongside Azure App Configuration middleware. #432

Microsoft.Extensions.Configuration.AzureAppConfiguration 7.0.0-preview - July 20, 2023

Breaking Changes:

• Feature flags are now parsed and transformed into feature management configuration even if AzureAppConfigurationOptions.UseFeatureFlags is not called. AzureAppConfigurationOptions.UseFeatureFlags is still used to configure feature flag options. #422

Enhancements

• Added the following new API for adding a snapshot's key-values to the configuration. #422

  public AzureAppConfigurationOptions SelectSnapshot(string name)
  

Microsoft.Azure.AppConfiguration.AspNetCore 7.0.0-preview - July 20, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.0.0-preview. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 7.0.0-preview - July 20, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 7.0.0-preview. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 6.0.1 - May 3, 2023

• Fixed a bug where ASP.NET (.NET Framework) applications would fail to refresh the configuration. #410

Microsoft.Azure.AppConfiguration.AspNetCore 6.0.1 - May 3, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 6.0.1. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 6.0.1 - May 3, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 6.0.1. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 6.0.0 - March 28, 2023

Breaking Changes:

• Removed IConfigurationRefresher.SetDirty API in favor of IConfigurationRefresher.ProcessPushNotification API for push-model based configuration refresh. Unlike the SetDirty method, the ProcessPushNotification method guarantees that all configuration changes up to the triggering event are loaded in the following configuration refresh. For more details on the ProcessPushNotification API, refer to this tutorial. #357
• Removed .NET 5 as a target framework as .NET 5 is out of support. #391
• Feature Management V2 schema support, which was introduced in 5.2.0-preview release, has been removed from this stable release. #315
• Removed IConfigurationRefresher.LoggerFactory API, but refresh logs are still available through standard ASP.NET Core logging if services.AddAzureAppConfiguration() is invoked in your ConfigureServices method. #367
• IConfigurationRefresher.ProcessPushNotification now validates that the push notification was triggered for one of the registered AppConfig stores. If no matching AppConfig store is registered, the push notification is ignored and the refresh operation will not be triggered. #319

Enhancements

• This is the first stable release of the following API introduced in 5.3.0-preview release. #178

  public AzureAppConfigurationOptions Connect(IEnumerable<Uri> endpoints, TokenCredential credential)
  

• Added the following new API for additional App Configuration geo-replication support. #385

  public AzureAppConfigurationOptions Connect(IEnumerable<string> connectionStrings)
  

  The new API allows you to provide an ordered list of connection strings of your App Configuration store and its replicas.

• Added the following new API for performing custom transformations on App Configuration settings. #157

  public AzureAppConfigurationOptions Map(Func<ConfigurationSetting, ValueTask<ConfigurationSetting>> mapper)
  

• For .NET 7 or later, added support for refreshing configuration when AzureAppConfigurationProvider is nested under ChainedConfigurationProvider. #168

• Added support for Azure SDK logging in addition to standard ASP.NET Core logging. Refresh logs are available under the "Microsoft-Extensions-Configuration-AzureAppConfiguration-Refresh" category. To enable Azure SDK logs, refer to these instructions. #367

Microsoft.Azure.AppConfiguration.AspNetCore 6.0.0 - March 28, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 6.0.0. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 6.0.0 - March 28, 2023

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 6.0.0. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 5.2.0 - November 29, 2022

• Added support for .NET 7 as a target framework. #366
• Fixed a bug where passing an empty string for the label filter to AzureAppConfigurationOptions.Select would select key-values with all labels. #311
• Fixed a bug where calls to AzureAppConfigurationOptions.Select would be incorrectly ignored if the key-values were already selected by a previous call. #349
• Fixed a bug where AddAzureAppConfiguration could throw an exception on invalid feature flags even with the optional parameter set to true. #348
• Upgraded the package references Azure.Security.KeyVault.Secrets to 4.3.0 and System.Text.Json to 4.7.2. #351

Microsoft.Azure.AppConfiguration.AspNetCore 5.2.0 - November 29, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.2.0. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 5.2.0 - November 29, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.2.0. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 5.3.0-preview - July 27, 2022

• Added the following new API for the App Configuration geo-replication support. #178

  public AzureAppConfigurationOptions Connect(IEnumerable<Uri> endpoints, TokenCredential credential)
  

  The new API allows you to provide an ordered list of replica endpoints of your App Configuration store. The App Configuration provider will fail over to other replicas when a replica is not accessible (either the service is unavailable or there are networking issues). A sample application can be found here.

Microsoft.Azure.AppConfiguration.AspNetCore 5.3.0-preview - July 27, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.3.0-preview. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 5.3.0-preview - July 27, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.3.0-preview. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 5.2.0-preview - July 18, 2022

• Added support for Feature Management V2 schema introduced in Microsoft.FeatureManagement 3.0.0-preview library. #315

Microsoft.Azure.AppConfiguration.AspNetCore 5.2.0-preview - July 18, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.2.0-preview. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 5.2.0-preview - July 18, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.2.0-preview. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 5.1.0 - July 18, 2022

• Added support for .NET 6 as a target framework. #290
• Removed support for Feature Management V2 schema introduced in Microsoft.FeatureManagement 3.0.0-preview library. #315

Microsoft.Azure.AppConfiguration.AspNetCore 5.1.0 - July 18, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.1.0. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 5.1.0 - July 18, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.1.0. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 5.1.0-preview - May 20, 2022

• Added support for Feature Management V2 schema introduced in Microsoft.FeatureManagement 3.0.0-preview library. #315

Microsoft.Azure.AppConfiguration.AspNetCore 5.1.0-preview - May 20, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.1.0-preview. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 5.1.0-preview - May 20, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.1.0-preview. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 5.0.0 - Feb 02, 2022

• Added deprecation warning to the IConfigurationRefresher.SetDirty API. IConfigurationRefresher.ProcessPushNotification API should be used instead for push-model based configuration refresh. Refer to this tutorial for more details about the ProcessPushNotification API. #301

Microsoft.Azure.AppConfiguration.AspNetCore 5.0.0 - Feb 02, 2022

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.0.0. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 5.0.1 - Feb 03, 2022

• Moved the UseAzureAppConfiguration extension method to Microsoft.Extensions.Hosting namespace. #299
• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.0.0. See the release notes for more information on the changes.

Microsoft.Extensions.Configuration.AzureAppConfiguration 5.0.0-preview - December 16, 2021

Breaking Changes:

• Removed all offline caching capabilities. #135

• Added support for parsing and using sync-token from push notifications received from Event Grid. Using sync-token ensures that users get the latest key-values from App Configuration on any subsequent request. The following new APIs were added:

  EventGridEventExtensions.TryCreatePushNotification(this EventGridEvent eventGridEvent, out PushNotification pushNotification)
  IConfigurationRefresher.ProcessPushNotification(PushNotification pushNotification, TimeSpan? maxDelay = null)
  

  To use sync-token in a push refresh enabled application, the existing SetDirty() call can be replaced by the following code. Depending on the event handler you're using, you may need to convert the received event to an EventGridEvent object. For example, if you are using Service Bus as the event handler, the code will look like this:

  serviceBusClient.RegisterMessageHandler(
                 handler: (message, cancellationToken) =>
                 {
                    EventGridEvent eventGridEvent = EventGridEvent.Parse(BinaryData.FromBytes(message.Body));
  
                    if (eventGridEvent.TryCreatePushNotification(out PushNotification pushNotification))
                    {
                       _refresher.ProcessPushNotification(pushNotification, maxDelay); 
                    }
  
                    return Task.CompletedTask;
                 },
                 exceptionReceivedHandler: (exceptionargs) =>
                 {
                       Console.WriteLine($"{exceptionargs.Exception}");
                       return Task.CompletedTask;
                 });
  

  The next call to RefreshAsync() or TryRefreshAsync() will get the latest key-values from your App Config store. #278

• Added support for CancellationToken during refresh operations. The following APIs were updated in IConfigurationRefresher interface: #281

  Task RefreshAsync(CancellationToken cancellationToken = default);
  Task<bool> TryRefreshAsync(CancellationToken cancellationToken = default);
  

• Added support for logging errors during refresh operations. #273

• Ensured that Key Vault secret refresh interval cannot be less than 1 second. #284

• Upgraded Microsoft.Extensions packages from version 2.1.1 to 3.1.18. #272

Microsoft.Azure.AppConfiguration.AspNetCore 5.0.0-preview - December 16, 2021

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 5.0.0-preview. See the release notes for more information on the changes.

Microsoft.Azure.AppConfiguration.Functions.Worker 5.0.0-preview - December 16, 2021

• Added middleware to support dynamic configuration in Azure Functions running in an isolated process. Refer to Azure Functions documentation for more details about running C# Azure Functions in an isolated process. #287

Microsoft.Extensions.Configuration.AzureAppConfiguration 4.5.1 - November 8, 2021

• Fixed a bug where the cache expiration time was not being updated after failed refresh operations. #283

Microsoft.Azure.AppConfiguration.AspNetCore 4.5.1 - November 8, 2021

• Updated Microsoft.Extensions.Configuration.AzureAppConfiguration reference to 4.5.1.