Microsoft.Extensions.Configuration.Json 8.0.0

Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.Configuration.Json --version 8.0.0                
NuGet\Install-Package Microsoft.Extensions.Configuration.Json -Version 8.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="8.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 8.0.0                
#r "nuget: Microsoft.Extensions.Configuration.Json, 8.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=8.0.0

// Install Microsoft.Extensions.Configuration.Json as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Configuration.Json&version=8.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 is compatible.  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 is compatible.  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. 
.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.7K)

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 (617)

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
jasontaylordev/CleanArchitecture
Clean Architecture Solution Template for ASP.NET Core
Version Downloads Last updated
9.0.0-preview.6.24327.7 9,336 7/9/2024
9.0.0-preview.5.24306.7 24,426 6/11/2024
9.0.0-preview.4.24266.19 24,143 5/21/2024
9.0.0-preview.3.24172.9 84,282 4/11/2024
9.0.0-preview.2.24128.5 32,916 3/12/2024
9.0.0-preview.1.24080.9 66,653 2/13/2024
8.0.0 52,576,687 11/14/2023
8.0.0-rc.2.23479.6 252,232 10/10/2023
8.0.0-rc.1.23419.4 150,629 9/12/2023
8.0.0-preview.7.23375.6 133,190 8/8/2023
8.0.0-preview.6.23329.7 107,582 7/11/2023
8.0.0-preview.5.23280.8 79,578 6/13/2023
8.0.0-preview.4.23259.5 219,550 5/16/2023
8.0.0-preview.3.23174.8 160,050 4/11/2023
8.0.0-preview.2.23128.3 64,977 3/14/2023
8.0.0-preview.1.23110.8 124,213 2/21/2023
7.0.0 100,407,031 11/7/2022
7.0.0-rc.2.22472.3 195,612 10/11/2022
7.0.0-rc.1.22426.10 145,084 9/14/2022
7.0.0-preview.7.22375.6 202,996 8/9/2022
7.0.0-preview.6.22324.4 94,503 7/12/2022
7.0.0-preview.5.22301.12 65,733 6/14/2022
7.0.0-preview.4.22229.4 102,386 5/10/2022
7.0.0-preview.3.22175.4 63,066 4/13/2022
7.0.0-preview.2.22152.2 54,662 3/14/2022
7.0.0-preview.1.22076.8 47,598 2/17/2022
6.0.0 234,740,568 11/8/2021
6.0.0-rc.2.21480.5 535,282 10/12/2021
6.0.0-rc.1.21451.13 327,678 9/14/2021
6.0.0-preview.7.21377.19 206,573 8/10/2021
6.0.0-preview.6.21352.12 124,757 7/14/2021
6.0.0-preview.5.21301.5 76,953 6/15/2021
6.0.0-preview.4.21253.7 58,510 5/24/2021
6.0.0-preview.3.21201.4 188,926 4/8/2021
6.0.0-preview.2.21154.6 106,142 3/11/2021
6.0.0-preview.1.21102.12 120,957 2/12/2021
5.0.0 152,564,985 11/9/2020
5.0.0-rc.2.20475.5 249,398 10/13/2020
5.0.0-rc.1.20451.14 332,814 9/14/2020
5.0.0-preview.8.20407.11 64,795 8/25/2020
5.0.0-preview.7.20364.11 129,171 7/21/2020
5.0.0-preview.6.20305.6 56,497 6/25/2020
5.0.0-preview.5.20278.1 46,358 6/10/2020
5.0.0-preview.4.20251.6 119,150 5/18/2020
5.0.0-preview.3.20215.2 43,827 4/23/2020
5.0.0-preview.2.20160.3 119,428 4/2/2020
5.0.0-preview.1.20120.4 43,265 3/16/2020
3.1.32 2,077,892 12/13/2022
3.1.31 648,139 11/8/2022
3.1.30 1,401,404 10/11/2022
3.1.29 357,943 9/13/2022
3.1.28 494,999 8/9/2022
3.1.27 501,103 7/12/2022
3.1.26 443,528 6/14/2022
3.1.25 792,797 5/10/2022
3.1.24 701,529 4/11/2022
3.1.23 1,294,252 3/8/2022
3.1.22 7,927,647 12/14/2021
3.1.21 2,206,775 11/7/2021
3.1.20 1,261,718 10/11/2021
3.1.19 1,321,341 9/14/2021
3.1.18 2,588,356 8/10/2021
3.1.17 2,063,635 7/13/2021
3.1.16 2,484,063 6/8/2021
3.1.15 3,040,646 5/11/2021
3.1.14 3,952,860 4/6/2021
3.1.13 5,480,051 3/9/2021
3.1.12 3,161,020 2/9/2021
3.1.11 4,694,350 1/12/2021
3.1.10 10,963,327 11/9/2020
3.1.9 13,448,850 10/13/2020
3.1.8 16,672,696 9/8/2020
3.1.7 11,826,335 8/11/2020
3.1.6 19,691,940 7/14/2020
3.1.5 19,300,817 6/9/2020
3.1.4 11,953,806 5/12/2020
3.1.3 20,741,695 3/24/2020
3.1.2 17,687,799 2/18/2020
3.1.1 13,512,460 1/14/2020
3.1.0 114,976,325 12/3/2019
3.1.0-preview3.19553.2 70,448 11/13/2019
3.1.0-preview2.19525.4 10,192 11/1/2019
3.1.0-preview1.19506.1 20,339 10/15/2019
3.0.3 594,814 2/18/2020
3.0.2 759,312 1/14/2020
3.0.1 2,543,200 11/18/2019
3.0.0 22,120,719 9/23/2019
3.0.0-rc1.19456.10 29,800 9/16/2019
3.0.0-preview9.19423.4 210,541 9/4/2019
3.0.0-preview8.19405.4 199,230 8/13/2019
3.0.0-preview7.19362.4 179,844 7/23/2019
3.0.0-preview6.19304.6 526,525 6/12/2019
3.0.0-preview5.19227.9 197,793 5/6/2019
3.0.0-preview4.19216.2 32,040 4/18/2019
3.0.0-preview3.19153.1 144,456 3/6/2019
3.0.0-preview.19074.2 130,395 1/29/2019
3.0.0-preview.18572.1 31,102 12/4/2018
2.2.0 95,585,112 12/3/2018
2.2.0-preview3-35497 218,551 10/17/2018
2.2.0-preview2-35157 113,230 9/12/2018
2.2.0-preview1-35029 53,852 8/22/2018
2.1.1 49,417,379 6/18/2018
2.1.0 216,524,363 5/29/2018
2.1.0-rc1-final 104,849 5/6/2018
2.1.0-preview2-final 82,967 4/10/2018
2.1.0-preview1-final 186,909 2/26/2018
2.0.2 7,796,158 5/7/2018
2.0.1 9,356,272 3/13/2018
2.0.0 42,464,613 8/11/2017
2.0.0-preview2-final 128,428 6/28/2017
2.0.0-preview1-final 69,831 5/10/2017
1.1.2 14,013,699 5/9/2017
1.1.1 3,999,849 3/6/2017
1.1.0 4,288,251 11/16/2016
1.1.0-preview1-final 34,607 10/24/2016
1.0.2 19,624,999 3/6/2017
1.0.1 859,463 12/12/2016
1.0.0 9,313,607 6/27/2016
1.0.0-rc2-final 181,700 5/16/2016
1.0.0-rc1-final 489,476 11/18/2015