Skip to content

quickstart-dotnet-core-app.md

Latest commit

 

History

History
182 lines (128 loc) · 7.21 KB

quickstart-dotnet-core-app.md

File metadata and controls

182 lines (128 loc) · 7.21 KB
title Quickstart for Azure App Configuration with .NET | Microsoft Docs
description In this quickstart, create a .NET app with Azure App Configuration to centralize storage and management of application settings separate from your code.
services azure-app-configuration
author maud-lv
ms.service azure-app-configuration
ms.devlang csharp
ms.topic quickstart
ms.custom devx-track-csharp, mode-other, devx-track-dotnet
ms.date 09/30/2025
ms.author malev

Quickstart: Create a .NET app with App Configuration

In this quickstart, you incorporate Azure App Configuration into a .NET console app to centralize storage and management of application settings separate from your code.

Prerequisites

Add a key-value

Add the following key-value to the App Configuration store and leave Label and Content Type with their default values. For more information about how to add key-values to a store using the Azure portal or the CLI, go to Create a key-value.

Key Value
TestApp:Settings:Message Data from Azure App Configuration

Create a .NET console app

You can use the .NET command-line interface (CLI) to create a new .NET console app project. The advantage of using the .NET CLI over Visual Studio is that it's available across the Windows, macOS, and Linux platforms. Alternatively, use the preinstalled tools available in the Azure Cloud Shell.

  1. Create a new folder for your project.

  2. In the new folder, run the following command to create a new .NET console app project:

    dotnet new console

Connect to an App Configuration store

You can connect to your App Configuration store using Microsoft Entra ID (recommended), or a connection string.

  1. Add NuGet package references by running the following command:

    Microsoft Entra ID (recommended)

    dotnet add package Microsoft.Extensions.Configuration.AzureAppConfiguration
dotnet add package Azure.Identity

    Connection string

    dotnet add package Microsoft.Extensions.Configuration.AzureAppConfiguration

  2. Run the following command to restore packages for your project:

    dotnet restore

  3. Open the Program.cs file, and add the following namespaces:

    Microsoft Entra ID (recommended)

    using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Configuration.AzureAppConfiguration;
using Azure.Identity;

    Connection string

    using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Configuration.AzureAppConfiguration;

  4. Connect to your App Configuration store by calling the AddAzureAppConfiguration method in the Program.cs file.

    Microsoft Entra ID (recommended)

    You use the DefaultAzureCredential to authenticate to your App Configuration store. Follow the instructions to assign your credential the App Configuration Data Reader role. Be sure to allow sufficient time for the permission to propagate before running your application.

    var builder = new ConfigurationBuilder();
builder.AddAzureAppConfiguration(options =>
{
    string endpoint = Environment.GetEnvironmentVariable("Endpoint");
    options.Connect(new Uri(endpoint), new DefaultAzureCredential());
});

var config = builder.Build();
Console.WriteLine(config["TestApp:Settings:Message"] ?? "Hello world!");

    Connection string

    var builder = new ConfigurationBuilder();
builder.AddAzureAppConfiguration(Environment.GetEnvironmentVariable("ConnectionString"));

var config = builder.Build();
Console.WriteLine(config["TestApp:Settings:Message"] ?? "Hello world!");

Build and run the app locally

  1. Set an environment variable.

    Microsoft Entra ID (recommended)

    Set the environment variable named Endpoint to the endpoint of your App Configuration store found under the Overview of your store in the Azure portal.

    If you use the Windows command prompt, run the following command and restart the command prompt to allow the change to take effect:

    setx Endpoint "<endpoint-of-your-app-configuration-store>"

    If you use PowerShell, run the following command:

    $Env:Endpoint = "<endpoint-of-your-app-configuration-store>"

    If you use macOS or Linux, run the following command:

    export Endpoint='<endpoint-of-your-app-configuration-store>'

    Connection string

    Set the environment variable named ConnectionString to the read-only connection string of your App Configuration store found under Access keys of your store in the Azure portal.

    If you use the Windows command prompt, run the following command and restart the command prompt to allow the change to take effect:

    setx ConnectionString "<connection-string-of-your-app-configuration-store>"

    If you use PowerShell, run the following command:

    $Env:ConnectionString = "<connection-string-of-your-app-configuration-store>"

    If you use macOS or Linux, run the following command:

    export ConnectionString='<connection-string-of-your-app-configuration-store>'

  2. Run the following command to build the console app:

    dotnet build

  3. After the build successfully completes, run the following command to run the app locally:

    dotnet run

    :::image type="content" source="./media/quickstarts/dotnet-core-app-run.png" alt-text="Screenshot of a terminal window showing the app running locally.":::

Clean up resources

[!INCLUDE azure-app-configuration-cleanup]

Next steps

In this quickstart, you created a new App Configuration store and used it with a .NET console app via the App Configuration provider. To learn how to configure your .NET app to dynamically refresh configuration settings, continue to the next tutorial.

[!div class="nextstepaction"] Enable dynamic configuration