Microsoft.Extensions.Configuration.Json 9.0.0

Prefix Reserved
dotnet add package Microsoft.Extensions.Configuration.Json --version 9.0.0                
NuGet\Install-Package Microsoft.Extensions.Configuration.Json -Version 9.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="9.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Configuration.Json --version 9.0.0                
#r "nuget: Microsoft.Extensions.Configuration.Json, 9.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.Extensions.Configuration.Json as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Configuration.Json&version=9.0.0

// Install Microsoft.Extensions.Configuration.Json as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Configuration.Json&version=9.0.0                

About

JSON configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read your application's settings from a JSON file. You can use JsonConfigurationExtensions.AddJsonFile extension method on IConfigurationBuilder to add the JSON configuration provider to the configuration builder.

How to Use

The following example shows how to read application settings from the JSON configuration file.

using System;
using Microsoft.Extensions.Configuration;

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

        // Get a configuration section
        IConfigurationSection section = config.GetSection("Settings");

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

        // Read a collection
        Console.WriteLine("Ports: ");
        IConfigurationSection ports = section.GetSection("Ports");

        foreach (IConfigurationSection child in ports.GetChildren())
        {
            Console.WriteLine(child.Value);
        }
    }
}

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

{
  "Settings": {
    "Server": "example.com",
    "Database": "Northwind",
    "Ports": [ 80, 81 ]
  }
}

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>

Additional Documentation

Feedback & Contributing

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

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3.9K)

Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Configuration.Json:

Package Downloads
Microsoft.Extensions.Configuration.UserSecrets

User secrets configuration provider implementation for Microsoft.Extensions.Configuration. User secrets mechanism enables you to override application configuration settings with values stored in the local secrets file. You can use UserSecretsConfigurationExtensions.AddUserSecrets extension method on IConfigurationBuilder to add user secrets provider to the configuration builder.

Microsoft.Extensions.Hosting

Hosting and startup infrastructures for applications.

Microsoft.Azure.WebJobs

This package contains the runtime host components of the WebJobs SDK. For more information, please visit https://go.microsoft.com/fwlink/?linkid=2279708.

Microsoft.ApplicationInsights.AspNetCore

Application Insights for ASP.NET Core web applications. See https://azure.microsoft.com/documentation/articles/app-insights-asp-net-five/ for more information. Privacy statement: https://go.microsoft.com/fwlink/?LinkId=512156

Microsoft.AspNetCore

Microsoft.AspNetCore

GitHub repositories (646)

Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.Configuration.Json:

Repository Stars
dotnet/aspnetcore
ASP.NET Core is a cross-platform .NET framework for building modern cloud-based web applications on Windows, Mac, or Linux.
jellyfin/jellyfin
The Free Software Media System
dotnet/maui
.NET MAUI is the .NET Multi-platform App UI, a framework for building native device applications spanning mobile, tablet, and desktop.
microsoft/semantic-kernel
Integrate cutting-edge LLM technology quickly and easily into your apps
icsharpcode/ILSpy
.NET Decompiler with support for PDB generation, ReadyToRun, Metadata (&more) - cross-platform!
Version Downloads Last updated
9.0.0 1,406,046 11/12/2024
9.0.0-rc.2.24473.5 98,130 10/8/2024
9.0.0-rc.1.24431.7 77,702 9/10/2024
9.0.0-preview.7.24405.7 51,519 8/13/2024
9.0.0-preview.6.24327.7 56,109 7/9/2024
9.0.0-preview.5.24306.7 46,947 6/11/2024
9.0.0-preview.4.24266.19 42,602 5/21/2024
9.0.0-preview.3.24172.9 134,654 4/11/2024
9.0.0-preview.2.24128.5 49,816 3/12/2024
9.0.0-preview.1.24080.9 81,977 2/13/2024
8.0.1 10,144,406 10/8/2024
8.0.0 107,223,748 11/14/2023
8.0.0-rc.2.23479.6 289,898 10/10/2023
8.0.0-rc.1.23419.4 171,272 9/12/2023
8.0.0-preview.7.23375.6 145,282 8/8/2023
8.0.0-preview.6.23329.7 116,824 7/11/2023
8.0.0-preview.5.23280.8 89,609 6/13/2023
8.0.0-preview.4.23259.5 276,271 5/16/2023
8.0.0-preview.3.23174.8 206,961 4/11/2023
8.0.0-preview.2.23128.3 74,811 3/14/2023
8.0.0-preview.1.23110.8 131,624 2/21/2023
7.0.0 115,825,392 11/7/2022
7.0.0-rc.2.22472.3 205,908 10/11/2022
7.0.0-rc.1.22426.10 154,694 9/14/2022
7.0.0-preview.7.22375.6 207,466 8/9/2022
7.0.0-preview.6.22324.4 104,278 7/12/2022
7.0.0-preview.5.22301.12 68,796 6/14/2022
7.0.0-preview.4.22229.4 107,852 5/10/2022
7.0.0-preview.3.22175.4 68,424 4/13/2022
7.0.0-preview.2.22152.2 57,917 3/14/2022
7.0.0-preview.1.22076.8 49,073 2/17/2022
6.0.1 45,954 11/12/2024
6.0.0 265,234,819 11/8/2021
6.0.0-rc.2.21480.5 551,466 10/12/2021
6.0.0-rc.1.21451.13 335,314 9/14/2021
6.0.0-preview.7.21377.19 212,441 8/10/2021
6.0.0-preview.6.21352.12 127,561 7/14/2021
6.0.0-preview.5.21301.5 79,290 6/15/2021
6.0.0-preview.4.21253.7 59,313 5/24/2021
6.0.0-preview.3.21201.4 194,330 4/8/2021
6.0.0-preview.2.21154.6 107,671 3/11/2021 6.0.0-preview.2.21154.6 is deprecated because it is no longer maintained.
6.0.0-preview.1.21102.12 130,142 2/12/2021 6.0.0-preview.1.21102.12 is deprecated because it is no longer maintained.
5.0.0 168,843,823 11/9/2020 5.0.0 is deprecated because it is no longer maintained.
5.0.0-rc.2.20475.5 261,184 10/13/2020 5.0.0-rc.2.20475.5 is deprecated because it is no longer maintained.
5.0.0-rc.1.20451.14 335,329 9/14/2020 5.0.0-rc.1.20451.14 is deprecated because it is no longer maintained.
5.0.0-preview.8.20407.11 67,205 8/25/2020 5.0.0-preview.8.20407.11 is deprecated because it is no longer maintained.
5.0.0-preview.7.20364.11 130,627 7/21/2020 5.0.0-preview.7.20364.11 is deprecated because it is no longer maintained.
5.0.0-preview.6.20305.6 57,755 6/25/2020 5.0.0-preview.6.20305.6 is deprecated because it is no longer maintained.
5.0.0-preview.5.20278.1 47,986 6/10/2020 5.0.0-preview.5.20278.1 is deprecated because it is no longer maintained.
5.0.0-preview.4.20251.6 122,129 5/18/2020 5.0.0-preview.4.20251.6 is deprecated because it is no longer maintained.
5.0.0-preview.3.20215.2 45,454 4/23/2020 5.0.0-preview.3.20215.2 is deprecated because it is no longer maintained.
5.0.0-preview.2.20160.3 120,995 4/2/2020 5.0.0-preview.2.20160.3 is deprecated because it is no longer maintained.
5.0.0-preview.1.20120.4 43,751 3/16/2020 5.0.0-preview.1.20120.4 is deprecated because it is no longer maintained.
3.1.32 2,641,653 12/13/2022
3.1.31 783,409 11/8/2022
3.1.30 1,664,554 10/11/2022
3.1.29 410,775 9/13/2022
3.1.28 545,563 8/9/2022
3.1.27 523,540 7/12/2022
3.1.26 471,460 6/14/2022
3.1.25 874,976 5/10/2022
3.1.24 769,865 4/11/2022
3.1.23 1,378,104 3/8/2022
3.1.22 9,424,021 12/14/2021
3.1.21 2,308,270 11/7/2021
3.1.20 1,330,570 10/11/2021
3.1.19 1,361,416 9/14/2021
3.1.18 2,700,108 8/10/2021
3.1.17 2,126,008 7/13/2021
3.1.16 2,563,325 6/8/2021
3.1.15 3,191,248 5/11/2021
3.1.14 4,139,279 4/6/2021
3.1.13 5,710,437 3/9/2021
3.1.12 3,255,801 2/9/2021
3.1.11 5,008,756 1/12/2021
3.1.10 11,334,322 11/9/2020
3.1.9 14,052,402 10/13/2020
3.1.8 17,193,071 9/8/2020
3.1.7 12,297,428 8/11/2020
3.1.6 20,644,029 7/14/2020
3.1.5 20,013,155 6/9/2020
3.1.4 12,523,008 5/12/2020
3.1.3 21,756,100 3/24/2020
3.1.2 18,264,957 2/18/2020
3.1.1 14,198,996 1/14/2020
3.1.0 141,744,838 12/3/2019
3.1.0-preview3.19553.2 73,734 11/13/2019 3.1.0-preview3.19553.2 is deprecated because it is no longer maintained.
3.1.0-preview2.19525.4 10,402 11/1/2019 3.1.0-preview2.19525.4 is deprecated because it is no longer maintained.
3.1.0-preview1.19506.1 20,777 10/15/2019 3.1.0-preview1.19506.1 is deprecated because it is no longer maintained.
3.0.3 643,685 2/18/2020 3.0.3 is deprecated because it is no longer maintained.
3.0.2 762,335 1/14/2020 3.0.2 is deprecated because it is no longer maintained.
3.0.1 2,618,946 11/18/2019 3.0.1 is deprecated because it is no longer maintained.
3.0.0 23,464,381 9/23/2019 3.0.0 is deprecated because it is no longer maintained.
3.0.0-rc1.19456.10 30,121 9/16/2019 3.0.0-rc1.19456.10 is deprecated because it is no longer maintained.
3.0.0-preview9.19423.4 217,203 9/4/2019 3.0.0-preview9.19423.4 is deprecated because it is no longer maintained.
3.0.0-preview8.19405.4 208,100 8/13/2019 3.0.0-preview8.19405.4 is deprecated because it is no longer maintained.
3.0.0-preview7.19362.4 185,070 7/23/2019 3.0.0-preview7.19362.4 is deprecated because it is no longer maintained.
3.0.0-preview6.19304.6 545,313 6/12/2019 3.0.0-preview6.19304.6 is deprecated because it is no longer maintained.
3.0.0-preview5.19227.9 203,533 5/6/2019 3.0.0-preview5.19227.9 is deprecated because it is no longer maintained.
3.0.0-preview4.19216.2 32,902 4/18/2019 3.0.0-preview4.19216.2 is deprecated because it is no longer maintained.
3.0.0-preview3.19153.1 149,502 3/6/2019 3.0.0-preview3.19153.1 is deprecated because it is no longer maintained.
3.0.0-preview.19074.2 133,857 1/29/2019 3.0.0-preview.19074.2 is deprecated because it is no longer maintained.
3.0.0-preview.18572.1 31,609 12/4/2018 3.0.0-preview.18572.1 is deprecated because it is no longer maintained.
2.2.0 103,287,586 12/3/2018 2.2.0 is deprecated because it is no longer maintained.
2.2.0-preview3-35497 220,079 10/17/2018 2.2.0-preview3-35497 is deprecated because it is no longer maintained.
2.2.0-preview2-35157 114,543 9/12/2018 2.2.0-preview2-35157 is deprecated because it is no longer maintained.
2.2.0-preview1-35029 55,239 8/22/2018 2.2.0-preview1-35029 is deprecated because it is no longer maintained.
2.1.1 52,828,163 6/18/2018
2.1.0 236,444,692 5/29/2018
2.1.0-rc1-final 106,448 5/6/2018 2.1.0-rc1-final is deprecated because it is no longer maintained.
2.1.0-preview2-final 84,227 4/10/2018 2.1.0-preview2-final is deprecated because it is no longer maintained.
2.1.0-preview1-final 188,606 2/26/2018 2.1.0-preview1-final is deprecated because it is no longer maintained.
2.0.2 8,142,055 5/7/2018 2.0.2 is deprecated because it is no longer maintained.
2.0.1 9,603,195 3/13/2018 2.0.1 is deprecated because it is no longer maintained.
2.0.0 44,453,448 8/11/2017 2.0.0 is deprecated because it is no longer maintained.
2.0.0-preview2-final 137,302 6/28/2017 2.0.0-preview2-final is deprecated because it is no longer maintained.
2.0.0-preview1-final 70,878 5/10/2017 2.0.0-preview1-final is deprecated because it is no longer maintained.
1.1.2 14,597,798 5/9/2017 1.1.2 is deprecated because it is no longer maintained.
1.1.1 4,093,864 3/6/2017 1.1.1 is deprecated because it is no longer maintained.
1.1.0 4,356,540 11/16/2016 1.1.0 is deprecated because it is no longer maintained.
1.1.0-preview1-final 34,773 10/24/2016 1.1.0-preview1-final is deprecated because it is no longer maintained.
1.0.2 20,061,446 3/6/2017 1.0.2 is deprecated because it is no longer maintained.
1.0.1 876,615 12/12/2016 1.0.1 is deprecated because it is no longer maintained.
1.0.0 9,635,572 6/27/2016 1.0.0 is deprecated because it is no longer maintained.
1.0.0-rc2-final 184,701 5/16/2016 1.0.0-rc2-final is deprecated because it is no longer maintained.
1.0.0-rc1-final 490,790 11/18/2015 1.0.0-rc1-final is deprecated because it is no longer maintained.