Method AddYamlFile
AddYamlFile(IConfigurationBuilder, String)
Adds a YAML configuration source to builder.
Declaration
public static IConfigurationBuilder AddYamlFile(this IConfigurationBuilder builder, string path)
Parameters
| Type |
Name |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
builder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance to add a YAML configuration source to.
|
| String |
path |
The YAML configuration file path relative to the base path stored in
Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties of builder.
|
Returns
| Type |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance. |
AddYamlFile(IConfigurationBuilder, String, Int32)
Adds a YAML configuration source to builder.
Declaration
public static IConfigurationBuilder AddYamlFile(this IConfigurationBuilder builder, string path, int documentIndex)
Parameters
| Type |
Name |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
builder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance to add a YAML configuration source to.
|
| String |
path |
The YAML configuration file path relative to the base path stored in
Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties of builder.
|
| Int32 |
documentIndex |
The YAML document index to read configuration from. |
Returns
| Type |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance. |
AddYamlFile(IConfigurationBuilder, String, Boolean)
Adds a YAML configuration source to builder.
Declaration
public static IConfigurationBuilder AddYamlFile(this IConfigurationBuilder builder, string path, bool optional)
Parameters
| Type |
Name |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
builder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance to add a YAML configuration source to.
|
| String |
path |
The YAML configuration file path relative to the base path stored in
Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties of builder.
|
| Boolean |
optional |
Controls whether the configuration file is optional. If set to false (the default), a
FileNotFoundException is thrown if the configuration file is missing.
|
Returns
| Type |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance. |
AddYamlFile(IConfigurationBuilder, String, Int32, Boolean)
Adds a YAML configuration source to builder.
Declaration
public static IConfigurationBuilder AddYamlFile(this IConfigurationBuilder builder, string path, int documentIndex, bool optional)
Parameters
| Type |
Name |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
builder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance to add a YAML configuration source to.
|
| String |
path |
The YAML configuration file path relative to the base path stored in
Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties of builder.
|
| Int32 |
documentIndex |
The YAML document index to read configuration from. |
| Boolean |
optional |
Controls whether the configuration file is optional. If set to false (the default), a
FileNotFoundException is thrown if the configuration file is missing.
|
Returns
| Type |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance. |
AddYamlFile(IConfigurationBuilder, String, Boolean, Boolean)
Adds a YAML configuration source to builder.
Declaration
public static IConfigurationBuilder AddYamlFile(this IConfigurationBuilder builder, string path, bool optional, bool reloadOnChange)
Parameters
| Type |
Name |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
builder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance to add a YAML configuration source to.
|
| String |
path |
The YAML configuration file path relative to the base path stored in
Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties of builder.
|
| Boolean |
optional |
Controls whether the configuration file is optional. If set to false (the default), a
FileNotFoundException is thrown if the configuration file is missing.
|
| Boolean |
reloadOnChange |
Controls whether the source should be automatically reloaded if a change to the underlying configuration
file has been detected.
|
Returns
| Type |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance. |
AddYamlFile(IConfigurationBuilder, String, Int32, Boolean, Boolean)
Adds a YAML configuration source to builder.
Declaration
public static IConfigurationBuilder AddYamlFile(this IConfigurationBuilder builder, string path, int documentIndex, bool optional, bool reloadOnChange)
Parameters
| Type |
Name |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
builder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance to add a YAML configuration source to.
|
| String |
path |
The YAML configuration file path relative to the base path stored in
Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties of builder.
|
| Int32 |
documentIndex |
The YAML document index to read configuration from. |
| Boolean |
optional |
Controls whether the configuration file is optional. If set to false (the default), a
FileNotFoundException is thrown if the configuration file is missing.
|
| Boolean |
reloadOnChange |
Controls whether the source should be automatically reloaded if a change to the underlying configuration
file has been detected.
|
Returns
| Type |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance. |
AddYamlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)
Adds a YAML configuration source to builder.
Declaration
public static IConfigurationBuilder AddYamlFile(this IConfigurationBuilder builder, IFileProvider provider, string path, bool optional, bool reloadOnChange)
Parameters
| Type |
Name |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
builder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance to add a YAML configuration source to.
|
| Microsoft.Extensions.FileProviders.IFileProvider |
provider |
The Microsoft.Extensions.FileProviders.IFileProvider instance to use to access the contents of the YAML configuration file.
|
| String |
path |
The YAML configuration file path relative to the base path stored in
Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties of builder.
|
| Boolean |
optional |
Controls whether the configuration file is optional. If set to false (the default), a
FileNotFoundException is thrown if the configuration file is missing.
|
| Boolean |
reloadOnChange |
Controls whether the source should be automatically reloaded if a change to the underlying configuration
file has been detected.
|
Returns
| Type |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance. |
AddYamlFile(IConfigurationBuilder, IFileProvider, String, Int32, Boolean, Boolean)
Adds a YAML configuration source to builder.
Declaration
public static IConfigurationBuilder AddYamlFile(this IConfigurationBuilder builder, IFileProvider provider, string path, int documentIndex, bool optional, bool reloadOnChange)
Parameters
| Type |
Name |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
builder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance to add a YAML configuration source to.
|
| Microsoft.Extensions.FileProviders.IFileProvider |
provider |
The Microsoft.Extensions.FileProviders.IFileProvider instance to use to access the contents of the YAML configuration file.
|
| String |
path |
The YAML configuration file path relative to the base path stored in
Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties of builder.
|
| Int32 |
documentIndex |
The YAML document index to read configuration from. |
| Boolean |
optional |
Controls whether the configuration file is optional. If set to false (the default), a
FileNotFoundException is thrown if the configuration file is missing.
|
| Boolean |
reloadOnChange |
Controls whether the source should be automatically reloaded if a change to the underlying configuration
file has been detected.
|
Returns
| Type |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance. |
AddYamlFile(IConfigurationBuilder, Action<YamlConfigurationSource>)
Adds a YAML configuration source to builder.
Declaration
public static IConfigurationBuilder AddYamlFile(this IConfigurationBuilder builder, Action<YamlConfigurationSource> configurationSource)
Parameters
| Type |
Name |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
builder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance to add a YAML configuration source to.
|
| System.Action<YamlConfigurationSource> |
configurationSource |
Configures the source. |
Returns
| Type |
Description |
| Microsoft.Extensions.Configuration.IConfigurationBuilder |
The Microsoft.Extensions.Configuration.IConfigurationBuilder instance. |