Working with Azure App Configuration in ASP.NET Core

Posted by Anuraj on Saturday, November 16, 2019 Reading time :3 minutes

ASPNET Core Azure

This post is about Azure App Configuration and how to use it with ASP.NET Core applications. Azure App Configuration service helps developers to manage application settings and feature flags centrally for the applications running on cloud. Use App Configuration to store all the settings for your application and secure their accesses in one place. You can find more details about Azure App Configuration from What is Azure App Configuration?

First, you need to create an Azure App Configuration instance. You need to sign in to the Azure portal. In the upper-left corner of the pane, select Create a resource. In the Search the Marketplace box, enter App Configuration and select Enter. From the search results click on the App Configuration and click on Create. This service is currently running in Preview and unlike other services, the settings is very minimal.

SettingDescription
Resource NameGlobally unique resource name to use for the App Configuration store resource
SubscriptionSelect the Azure subscription that you want to use.
Resource groupSelect or create a resource group for your App Configuration store resource.
LocationLocation of your Azure App Configuration

Here is the details of the one I am creating.

Create new Azure App Configuration

And click on the create button.

Once the resource created, you will get notified by the Azure portal. Once the App Configuration is created, go to the resource and click on the Configuration explorer. And click on Create and choose key-value. And add the following settings.

KeyValue
DemoApp:Settings:LayoutGrid

I am adding only one setting - the layout option. It can be grid or list. By default Grid option is applied. The key is similar to the ASP.NET Core configuration key.

Create new Azure App Configuration

Next we will create the ASP.NET Core application - you can use dotnet new mvc -o HelloAzureAppConfig. Since we are using Azure App Configuration connection strings, it is recommended to use App Secrets. You can do this by adding UserSecretsId element after the TargetFramework element, like the following.

<Project Sdk="Microsoft.NET.Sdk.Web">
  <PropertyGroup>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <UserSecretsId>b8630d47-7884-4b26-ac9e-257014e70ab6</UserSecretsId>
  </PropertyGroup>
</Project>

Now you can copy the Azure App Configuration connection string from Azure portal. You can do it from Access Keys blade. Right now I am only reading the configuration, you can choose the Read-Only Keys tab and copy the connection string. Next we will add this connection string to our app secrets. You can do this by running the dotnet user-secrets command.

dotnet user-secrets set ConnectionStrings:AzureAppConfig <your_connection_string>

You need one nuget package to access the Azure App Configuration. You need to add the Microsoft.Azure.AppConfiguration.AspNetCore package, find the appropriate version and run the dotnet add package command.

Now we need to modify the Program.cs file to use read from Azure App Configuration like the following.

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }
    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            webBuilder.ConfigureAppConfiguration((hostingContext, config) =>
            {
                var settings = config.Build();
                config.AddAzureAppConfiguration(settings["ConnectionStrings:AzureAppConfig"]);
            }).UseStartup<Startup>());
}

Now you’re completed the configuration and you can access the value of the configuration like this from the controller.

private readonly ILogger<HomeController> _logger;
private readonly IConfiguration _configuration;

public HomeController(ILogger<HomeController> logger, IConfiguration configuration)
{
    _logger = logger;
    _configuration = configuration;
}

public IActionResult Index()
{
    var layout_config = _configuration["DemoApp:Settings:Layout"];
    return View();
}

And you can read the value from View files by injecting the Configuration class to the view like this.

@using Microsoft.Extensions.Configuration
@inject IConfiguration Configuration
@{
    ViewData["Title"] = "Home Page";
}

<h2>@Configuration["DemoApp:Settings:Layout"]</h2>

Or you can add the first two lines of code to the viewimports.cshtml file and use the configuration values in all the views.

You can configure your application to update the values based on the configuration changes trigger, you need to configure the application configuration middleware to accomplish this. You can get more details about this from Use dynamic configuration in an ASP.NET Core app

In this post we discussed about Azure App Configuration and how to use it in ASP.NET Core MVC Application. Azure App Configuration help us to import configuration values from your existing App Services or existing configuration files using the Import / Export. So you don’t need to manually create it. Azure App Configuration also works with other platforms like ASP.NET or Java.

Happy Programming :)

What do you think? I would like to hear your thoughts, suggestions, and questions in the comments section below.


Similar Posts


Did you like this article? Share it with your friends

Facebook Twitter Google+ LinkedIn Reddit StumbleUpon



Translate
Subscribe
BMC logoBuy me a coffee


Copyright © 2019 - Anuraj P. Blog content licensed under the Creative Commons CC BY 2.5 | Unless otherwise stated or granted, code samples licensed under the MIT license. This is a personal blog. The opinions expressed here represent my own and not those of my employer. Hosted with ❤ by GitHub