Microsoft.Extensions.Configuration.Binder 10.0.0-preview.5.25277.114

About

Provides the functionality to bind an object to data in configuration providers for Microsoft.Extensions.Configuration. This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the Microsoft.Extensions.Configuration.ConfigurationBinder.Get extension method on the IConfiguration object. To use this package, you also need to install a package for the configuration provider, for example, Microsoft.Extensions.Configuration.Json for the JSON provider.

The types contained in this assembly use Reflection at runtime which is not friendly with linking or AOT. To better support linking and AOT as well as provide more efficient strongly-typed binding methods - this package also provides a source generator. This generator is enabled by default when a project sets PublishAot but can also be enabled using <EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>.

Key Features

  • Configuring existing type instances from a configuration section (Bind)
  • Constructing new configured type instances from a configuration section (Get & GetValue)
  • Generating source to bind objects from a configuration section without a runtime reflection dependency.

How to Use

The following example shows how to bind a JSON configuration section to .NET objects.

using System;
using Microsoft.Extensions.Configuration;

class Settings
{
    public string Server { get; set; }
    public string Database { get; set; }
    public Endpoint[] Endpoints { get; set; }
}

class Endpoint
{
    public string IPAddress { get; set; }
    public int Port { get; set; }
}

class Program
{
    static void Main()
    {
        // Build a configuration object from JSON file
        IConfiguration config = new ConfigurationBuilder()
            .AddJsonFile("appsettings.json")
            .Build();

        // Bind a configuration section to an instance of Settings class
        Settings settings = config.GetSection("Settings").Get<Settings>();

        // Read simple values
        Console.WriteLine($"Server: {settings.Server}");
        Console.WriteLine($"Database: {settings.Database}");

        // Read nested objects
        Console.WriteLine("Endpoints: ");

        foreach (Endpoint endpoint in settings.Endpoints)
        {
            Console.WriteLine($"{endpoint.IPAddress}:{endpoint.Port}");
        }
    }
}

To run this example, include an appsettings.json file with the following content in your project:

{
  "Settings": {
    "Server": "example.com",
    "Database": "Northwind",
    "Endpoints": [
      {
        "IPAddress": "192.168.0.1",
        "Port": "80"
      },
      {
        "IPAddress": "192.168.10.1",
        "Port": "8080"
      }
    ]
  }
}

You can include a configuration file using a code like this in your .csproj file:

<ItemGroup>
  <Content Include="appsettings.json">
    <CopyToOutputDirectory>Always</CopyToOutputDirectory>
  </Content>
</ItemGroup>

You can add the following property to enable the source generator. This requires a .NET 8.0 SDK or later.

<PropertyGroup>
  <EnableConfigurationBindingGenerator>true</EnableConfigurationBindingGenerator>
</PropertyGroup>

Main Types

The main types provided by this library are:

  • Microsoft.Extensions.Configuration.ConfigurationBinder
  • Microsoft.Extensions.Configuration.BinderOptions

Additional Documentation

Feedback & Contributing

Microsoft.Extensions.Configuration.Binder is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Showing the top 20 packages that depend on Microsoft.Extensions.Configuration.Binder.

Packages Downloads
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
91
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
74
Microsoft.AspNetCore.Server.Kestrel.Core
Core components of ASP.NET Core Kestrel cross-platform web server.
73
Microsoft.AspNetCore.App
Provides a default set of APIs for building an ASP.NET Core application. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
73
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
68
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
66
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
64
Microsoft.AspNetCore.App
Provides a default set of APIs for building an ASP.NET Core application. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
62
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
60
Serilog.Extensions.Logging.File
Add file logging to ASP.NET Core apps with one line of code.
59
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
59
Microsoft.AspNetCore.App
Provides a default set of APIs for building an ASP.NET Core application. This package requires the ASP.NET Core runtime. This runtime is installed by the .NET Core SDK, or can be acquired separately using installers available at https://aka.ms/dotnet-download.
58
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
58
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
55
Serilog.Extensions.Logging.File
Add file logging to ASP.NET Core apps with one line of code.
55
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging.
53
Microsoft.AspNetCore.App
Microsoft.AspNetCore.App
53
Serilog.Extensions.Logging.File
Add file logging to ASP.NET Core apps with one line of code.
52
Microsoft.AspNetCore.Server.Kestrel.Core
Core components of ASP.NET Core Kestrel cross-platform web server.
51
App.Metrics.Extensions.Configuration
Microsoft.Extensions.Configuration support for App Metrics e.g. appsettings.json
50

https://go.microsoft.com/fwlink/?LinkID=799421

.NET Framework 4.6.2

.NET 8.0

.NET 9.0

.NET 10.0

.NET Standard 2.0

Version Downloads Last updated
10.0.0-preview.5.25277.114 1 06/09/2025
10.0.0-preview.4.25258.110 4 05/23/2025
10.0.0-preview.3.25171.5 4 04/17/2025
10.0.0-preview.2.25163.2 7 03/19/2025
10.0.0-preview.1.25080.5 8 03/15/2025
9.0.6 0 06/10/2025
9.0.5 1 05/19/2025
9.0.4 4 04/10/2025
9.0.3 6 03/18/2025
9.0.2 9 02/17/2025
9.0.1 10 01/20/2025
9.0.0 10 12/13/2024
9.0.0-rc.2.24473.5 18 10/08/2024
9.0.0-rc.1.24431.7 16 09/21/2024
9.0.0-preview.7.24405.7 14 08/15/2024
9.0.0-preview.6.24327.7 17 07/11/2024
9.0.0-preview.5.24306.7 18 06/19/2024
9.0.0-preview.4.24266.19 18 05/22/2024
9.0.0-preview.3.24172.9 19 04/18/2024
9.0.0-preview.2.24128.5 22 03/15/2024
9.0.0-preview.1.24080.9 16 06/27/2024
8.0.2 15 07/11/2024
8.0.1 18 06/01/2024
8.0.0 20 12/06/2023
8.0.0-rc.2.23479.6 16 12/06/2023
8.0.0-rc.1.23419.4 20 11/05/2023
8.0.0-preview.7.23375.6 14 12/06/2023
8.0.0-preview.6.23329.7 17 12/06/2023
8.0.0-preview.5.23280.8 19 12/06/2023
8.0.0-preview.4.23259.5 14 08/23/2023
8.0.0-preview.3.23174.8 27 08/25/2023
8.0.0-preview.2.23128.3 12 08/27/2023
8.0.0-preview.1.23110.8 18 08/26/2023
7.0.4 19 06/10/2023
7.0.3 23 06/10/2023
7.0.2 16 06/10/2023
7.0.1 18 06/09/2023
7.0.0 19 06/10/2023
7.0.0-rc.2.22472.3 17 08/24/2023
7.0.0-rc.1.22426.10 12 06/27/2024
7.0.0-preview.7.22375.6 16 08/24/2023
7.0.0-preview.6.22324.4 18 08/23/2023
7.0.0-preview.5.22301.12 17 08/25/2023
7.0.0-preview.4.22229.4 13 08/24/2023
7.0.0-preview.3.22175.4 20 08/24/2023
7.0.0-preview.2.22152.2 18 08/24/2023
7.0.0-preview.1.22076.8 16 08/22/2023
6.0.2-mauipre.1.22102.15 16 08/26/2023
6.0.2-mauipre.1.22054.8 20 08/21/2023
6.0.1 10 12/13/2024
6.0.0 35 11/25/2021
6.0.0-rc.2.21480.5 19 08/21/2023
6.0.0-rc.1.21451.13 16 08/24/2023
6.0.0-preview.7.21377.19 16 08/27/2023
6.0.0-preview.6.21352.12 14 08/23/2023
6.0.0-preview.5.21301.5 13 08/23/2023
6.0.0-preview.4.21253.7 20 08/26/2023
6.0.0-preview.3.21201.4 17 06/27/2024
6.0.0-preview.2.21154.6 16 08/26/2023
6.0.0-preview.1.21102.12 17 08/26/2023
5.0.0 26 02/11/2021
5.0.0-rc.2.20475.5 29 07/13/2023
5.0.0-rc.1.20451.14 16 08/22/2023
5.0.0-preview.8.20407.11 19 08/25/2023
5.0.0-preview.7.20364.11 12 08/22/2023
5.0.0-preview.6.20305.6 19 08/13/2023
5.0.0-preview.5.20278.1 20 08/24/2023
5.0.0-preview.4.20251.6 16 08/21/2023
5.0.0-preview.3.20215.2 30 08/21/2023
5.0.0-preview.2.20160.3 16 08/24/2023
5.0.0-preview.1.20120.4 15 08/21/2023
3.1.32 15 06/12/2023
3.1.31 17 06/11/2023
3.1.30 15 06/11/2023
3.1.29 17 06/12/2023
3.1.28 16 06/11/2023
3.1.27 19 06/12/2023
3.1.26 20 06/11/2023
3.1.25 14 06/12/2023
3.1.24 17 06/11/2023
3.1.23 14 06/12/2023
3.1.22 14 06/11/2023
3.1.21 15 06/12/2023
3.1.20 16 06/11/2023
3.1.19 16 06/11/2023
3.1.18 18 06/12/2023
3.1.17 18 06/11/2023
3.1.16 28 06/11/2023
3.1.15 13 06/12/2023
3.1.14 96 06/22/2021
3.1.13 15 06/12/2023
3.1.12 17 12/07/2023
3.1.11 20 09/05/2022
3.1.10 18 06/28/2022
3.1.9 14 06/10/2023
3.1.8 18 06/10/2023
3.1.7 16 06/11/2023
3.1.6 15 06/09/2023
3.1.5 32 10/11/2020
3.1.4 17 01/13/2021
3.1.3 16 06/10/2023
3.1.2 19 07/21/2022
3.1.1 21 12/20/2020
3.1.0 43 05/09/2022
3.1.0-preview3.19553.2 16 08/23/2023
3.1.0-preview2.19525.4 16 08/21/2023
3.1.0-preview1.19506.1 15 08/23/2023
3.0.3 17 03/20/2023
3.0.2 17 06/10/2023
3.0.1 19 06/10/2023
3.0.0 32 12/30/2020
3.0.0-rc1.19456.10 24 08/24/2023
3.0.0-preview9.19423.4 16 08/26/2023
3.0.0-preview8.19405.4 17 08/22/2023
3.0.0-preview7.19362.4 19 08/21/2023
3.0.0-preview6.19304.6 17 08/27/2023
3.0.0-preview5.19227.9 17 08/21/2023
3.0.0-preview4.19216.2 15 08/24/2023
3.0.0-preview3.19153.1 14 08/23/2023
3.0.0-preview.19074.2 15 08/25/2023
3.0.0-preview.18572.1 18 08/25/2023
2.2.4 17 06/11/2023
2.2.0 29 11/19/2020
2.2.0-preview3-35497 17 08/25/2023
2.2.0-preview2-35157 14 08/24/2023
2.2.0-preview1-35029 18 08/24/2023
2.1.10 69 11/19/2020
2.1.1 23 09/09/2021
2.1.0 16 10/27/2021
2.1.0-rc1-final 17 06/10/2023
2.1.0-preview2-final 19 06/10/2023
2.1.0-preview1-final 14 06/10/2023
2.0.2 18 06/09/2023
2.0.1 19 12/27/2019
2.0.0 53 07/17/2020
2.0.0-preview2-final 16 06/10/2023
2.0.0-preview1-final 19 06/10/2023
1.1.2 15 06/09/2023
1.1.1 15 06/10/2023
1.1.0 36 11/25/2019
1.1.0-preview1-final 15 06/11/2023
1.0.2 17 06/10/2023
1.0.1 17 06/10/2023
1.0.0 17 06/10/2023
1.0.0-rc2-final 12 06/09/2023
1.0.0-rc1-final 16 06/10/2023