Microsoft.Extensions.Configuration.Binder 9.0.0-rc.2.24473.5

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.
192
Microsoft.Extensions.Logging
Logging infrastructure default implementation for Microsoft.Extensions.Logging. This package was built from the source code at https://github.com/aspnet/Extensions/tree/0de62ae930da31048ba7e54c8cd0c6c0bcbd9095
190
Microsoft.Extensions.Logging.Configuration
Configuration support for Microsoft.Extensions.Logging.
241
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
190
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
196
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
198
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
200
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
247
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
295
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options. When using NuGet 3.x this package requires at least version 3.4.
197
Sentry.AspNetCore
Official ASP.NET Core integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.
240
Sentry.AspNetCore
Official ASP.NET Core integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.
247
Sentry.AspNetCore
Official ASP.NET Core integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.
251
Sentry.AspNetCore
Official ASP.NET Core integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.
263
Sentry.AspNetCore
Official ASP.NET Core integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.
265
Sentry.Extensions.Logging
Official Microsoft.Extensions.Logging integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.
206
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
196
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
205
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
208
Serilog.Settings.Configuration
Microsoft.Extensions.Configuration (appsettings.json) support for Serilog.
264

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

.NET Framework 4.6.2

.NET 8.0

.NET 9.0

.NET Standard 2.0

Version Downloads Last updated
11.0.0 0 11/10/2026
11.0.0-rc.3.26522.148 0 10/25/2026
11.0.0-rc.2.26504.105 0 10/13/2026
11.0.0-rc.1.26425.128 28 09/08/2026
11.0.0-preview.7.26381.103 24 08/11/2026
11.0.0-preview.6.26359.118 36 07/15/2026
11.0.0-preview.5.26302.115 37 06/09/2026
11.0.0-preview.4.26230.115 45 05/12/2026
11.0.0-preview.3.26207.106 50 04/14/2026
11.0.0-preview.2.26159.112 58 03/11/2026
11.0.0-preview.1.26104.118 55 02/11/2026
10.0.15 0 11/10/2026
10.0.14 0 10/25/2026
10.0.13 0 10/13/2026
10.0.12 24 09/09/2026
10.0.11 23 08/11/2026
10.0.10 35 07/15/2026
10.0.9 35 06/09/2026
10.0.8 42 05/13/2026
10.0.7 59 04/21/2026
10.0.6 42 04/14/2026
10.0.5 64 03/16/2026
10.0.4 54 03/11/2026
10.0.3 64 02/11/2026
10.0.2 60 01/13/2026
10.0.1 104 12/09/2025
10.0.0 99 11/12/2025
10.0.0-rc.2.25502.107 109 10/15/2025
10.0.0-rc.1.25451.107 111 09/09/2025
10.0.0-preview.7.25380.108 123 08/14/2025
10.0.0-preview.6.25358.103 129 07/15/2025
10.0.0-preview.5.25277.114 159 06/07/2025
10.0.0-preview.4.25258.110 116 05/13/2025
10.0.0-preview.3.25171.5 147 04/11/2025
10.0.0-preview.2.25163.2 104 04/01/2025
10.0.0-preview.1.25080.5 132 04/01/2025
9.0.23 0 11/10/2026
9.0.22 0 10/25/2026
9.0.21 0 10/13/2026
9.0.20 20 09/09/2026
9.0.19 28 08/11/2026
9.0.18 33 07/15/2026
9.0.17 37 06/09/2026
9.0.16 27 05/13/2026
9.0.15 56 04/14/2026
9.0.14 51 03/11/2026
9.0.13 63 02/11/2026
9.0.12 62 01/13/2026
9.0.11 106 11/12/2025
9.0.10 97 10/15/2025
9.0.9 128 09/09/2025
9.0.8 115 08/05/2025
9.0.7 143 07/09/2025
9.0.6 112 06/11/2025
9.0.5 141 05/14/2025
9.0.4 146 04/09/2025
9.0.3 138 03/29/2025
9.0.2 138 03/19/2025
9.0.1 125 03/29/2025
9.0.0 217 11/14/2024
9.0.0-rc.2.24473.5 143 10/22/2024
9.0.0-rc.1.24431.7 127 10/25/2024
9.0.0-preview.7.24405.7 137 08/20/2024
9.0.0-preview.6.24327.7 174 07/23/2024
9.0.0-preview.5.24306.7 152 07/23/2024
9.0.0-preview.4.24266.19 156 07/23/2024
9.0.0-preview.3.24172.9 148 07/23/2024
9.0.0-preview.2.24128.5 161 07/23/2024
9.0.0-preview.1.24080.9 155 07/22/2024
8.0.2 159 07/23/2024
8.0.1 167 07/23/2024
8.0.0 247 02/04/2024
8.0.0-rc.2.23479.6 174 07/23/2024
8.0.0-rc.1.23419.4 155 07/23/2024
8.0.0-preview.7.23375.6 165 07/23/2024
8.0.0-preview.6.23329.7 146 07/23/2024
8.0.0-preview.5.23280.8 161 07/23/2024
8.0.0-preview.4.23259.5 163 07/23/2024
8.0.0-preview.3.23174.8 159 07/23/2024
8.0.0-preview.2.23128.3 140 07/23/2024
8.0.0-preview.1.23110.8 173 07/23/2024
7.0.4 151 07/21/2024
7.0.3 153 07/23/2024
7.0.2 160 07/23/2024
7.0.1 153 07/23/2024
7.0.0 156 02/05/2024
7.0.0-rc.2.22472.3 144 07/19/2024
7.0.0-rc.1.22426.10 151 07/23/2024
7.0.0-preview.7.22375.6 135 08/12/2024
7.0.0-preview.6.22324.4 156 07/23/2024
7.0.0-preview.5.22301.12 142 07/23/2024
7.0.0-preview.4.22229.4 164 07/23/2024
7.0.0-preview.3.22175.4 134 07/23/2024
7.0.0-preview.2.22152.2 152 07/23/2024
7.0.0-preview.1.22076.8 157 07/23/2024
6.0.2-mauipre.1.22054.8 133 11/25/2024
6.0.1 127 11/14/2024
6.0.0 264 02/04/2024
6.0.0-rc.2.21480.5 170 07/23/2024
6.0.0-rc.1.21451.13 151 07/23/2024
6.0.0-preview.7.21377.19 161 07/23/2024
6.0.0-preview.6.21352.12 152 07/23/2024
6.0.0-preview.5.21301.5 141 07/23/2024
6.0.0-preview.4.21253.7 140 07/23/2024
6.0.0-preview.3.21201.4 158 07/23/2024
6.0.0-preview.2.21154.6 147 07/23/2024
6.0.0-preview.1.21102.12 144 07/23/2024
5.0.0 166 07/23/2024
5.0.0-rc.2.20475.5 153 07/23/2024
5.0.0-rc.1.20451.14 151 07/23/2024
5.0.0-preview.8.20407.11 147 07/23/2024
5.0.0-preview.7.20364.11 143 07/23/2024
5.0.0-preview.6.20305.6 151 07/23/2024
5.0.0-preview.5.20278.1 157 07/23/2024
5.0.0-preview.4.20251.6 141 07/23/2024
5.0.0-preview.3.20215.2 159 07/23/2024
5.0.0-preview.2.20160.3 148 07/23/2024
5.0.0-preview.1.20120.4 167 07/23/2024
3.1.32 156 07/23/2024
3.1.31 157 07/23/2024
3.1.30 155 07/20/2024
3.1.29 150 07/23/2024
3.1.28 159 07/23/2024
3.1.27 180 07/23/2024
3.1.26 151 07/23/2024
3.1.25 166 07/19/2024
3.1.24 159 07/23/2024
3.1.23 174 07/23/2024
3.1.22 141 07/23/2024
3.1.21 158 07/23/2024
3.1.20 159 07/23/2024
3.1.19 169 07/23/2024
3.1.18 124 07/23/2024
3.1.17 157 07/22/2024
3.1.16 163 07/23/2024
3.1.15 162 07/23/2024
3.1.14 161 07/23/2024
3.1.13 134 07/23/2024
3.1.12 177 07/17/2024
3.1.11 167 07/23/2024
3.1.10 165 07/23/2024
3.1.9 160 07/23/2024
3.1.8 147 07/22/2024
3.1.7 142 07/23/2024
3.1.6 188 07/23/2024
3.1.5 155 07/23/2024
3.1.4 166 07/23/2024
3.1.3 151 07/23/2024
3.1.2 150 07/23/2024
3.1.1 149 07/18/2024
3.1.0 167 07/23/2024
3.1.0-preview3.19553.2 142 07/23/2024
3.1.0-preview2.19525.4 160 07/23/2024
3.1.0-preview1.19506.1 158 07/23/2024
3.0.3 159 07/23/2024
3.0.2 145 07/23/2024
3.0.1 159 07/23/2024
3.0.0 171 07/23/2024
3.0.0-rc1.19456.10 154 07/23/2024
3.0.0-preview9.19423.4 168 07/20/2024
3.0.0-preview8.19405.4 138 07/23/2024
3.0.0-preview7.19362.4 155 07/23/2024
3.0.0-preview6.19304.6 173 07/23/2024
3.0.0-preview5.19227.9 165 07/23/2024
3.0.0-preview4.19216.2 149 07/23/2024
3.0.0-preview3.19153.1 156 07/19/2024
3.0.0-preview.19074.2 158 07/23/2024
3.0.0-preview.18572.1 147 07/23/2024
2.2.4 150 07/23/2024
2.2.0 148 07/23/2024
2.2.0-preview3-35497 138 07/23/2024
2.2.0-preview2-35157 148 07/23/2024
2.2.0-preview1-35029 150 07/23/2024
2.1.10 143 07/23/2024
2.1.1 162 07/23/2024
2.1.0 141 07/23/2024
2.1.0-rc1-final 155 07/23/2024
2.1.0-preview2-final 151 07/20/2024
2.1.0-preview1-final 148 07/23/2024
2.0.2 159 07/23/2024
2.0.1 153 07/23/2024
2.0.0 225 02/04/2024
2.0.0-preview2-final 161 07/23/2024
2.0.0-preview1-final 145 07/23/2024
1.1.2 162 07/23/2024
1.1.1 170 07/22/2024
1.1.0 152 07/23/2024
1.1.0-preview1-final 159 07/14/2024
1.0.2 151 07/23/2024
1.0.1 142 07/23/2024
1.0.0 164 07/22/2024
1.0.0-rc2-final 157 07/22/2024
1.0.0-rc1-final 168 07/23/2024