JsonConfigurationExtensions.AddJsonFile Method

Definition

Overloads

AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)

Adds a JSON configuration source to builder.

AddJsonFile(IConfigurationBuilder, String)

Adds the JSON configuration provider at path to builder.

AddJsonFile(IConfigurationBuilder, String, Boolean)

Adds the JSON configuration provider at path to builder.

AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)

Adds the JSON configuration provider at path to builder.

AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

Adds a JSON configuration source to builder.

AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)

Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs

Adds a JSON configuration source to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddJsonFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Action<Microsoft.Extensions.Configuration.Json.JsonConfigurationSource>? configureSource);

Parameters

configureSource
Action<JsonConfigurationSource>

Configures the source.

Returns

The IConfigurationBuilder.

Applies to

.NET 10 (package-provided) and other versions
Product Versions
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Standard 2.0 (package-provided), 2.1 (package-provided)

AddJsonFile(IConfigurationBuilder, String)

Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs

Adds the JSON configuration provider at path to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddJsonFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string path);

Parameters

path
String

Path relative to the base path stored in Properties of builder.

Returns

The IConfigurationBuilder.

Applies to

.NET 10 (package-provided) and other versions
Product Versions
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Standard 2.0 (package-provided), 2.1 (package-provided)

AddJsonFile(IConfigurationBuilder, String, Boolean)

Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs

Adds the JSON configuration provider at path to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddJsonFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string path, bool optional);

Parameters

path
String

Path relative to the base path stored in Properties of builder.

optional
Boolean

Whether the file is optional.

Returns

The IConfigurationBuilder.

Applies to

.NET 10 (package-provided) and other versions
Product Versions
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Standard 2.0 (package-provided), 2.1 (package-provided)

AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)

Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs

Adds the JSON configuration provider at path to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddJsonFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, string path, bool optional, bool reloadOnChange);

Parameters

path
String

Path relative to the base path stored in Properties of builder.

optional
Boolean

Whether the file is optional.

reloadOnChange
Boolean

Whether the configuration should be reloaded if the file changes.

Returns

The IConfigurationBuilder.

Applies to

.NET 10 (package-provided) and other versions
Product Versions
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Standard 2.0 (package-provided), 2.1 (package-provided)

AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)

Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs
Source:
JsonConfigurationExtensions.cs

Adds a JSON configuration source to builder.

C#
public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddJsonFile(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Microsoft.Extensions.FileProviders.IFileProvider? provider, string path, bool optional, bool reloadOnChange);

Parameters

provider
IFileProvider

The IFileProvider to use to access the file.

path
String

Path relative to the base path stored in Properties of builder.

optional
Boolean

Whether the file is optional.

reloadOnChange
Boolean

Whether the configuration should be reloaded if the file changes.

Returns

The IConfigurationBuilder.

Applies to

.NET 10 (package-provided) and other versions
Product Versions
.NET 8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Standard 2.0 (package-provided), 2.1 (package-provided)