EnvironmentVariablesExtensions.AddEnvironmentVariables Method

Definition

Namespace:: Microsoft.Extensions.Configuration

Assembly:: Microsoft.Extensions.Configuration.EnvironmentVariables.dll

Package:: Microsoft.Extensions.Configuration.EnvironmentVariables v11.0.0-preview.7.26381.103

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

Name	Description
AddEnvironmentVariables(IConfigurationBuilder)	Adds an IConfigurationProvider that reads configuration values from environment variables.
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Adds an IConfigurationProvider that reads configuration values from environment variables.
AddEnvironmentVariables(IConfigurationBuilder, String)	Adds an IConfigurationProvider that reads configuration values from environment variables with a specified prefix.
AddEnvironmentVariables(IConfigurationBuilder, String, Func<String,String>)	Adds an IConfigurationProvider that reads configuration values from environment variables with a specified prefix and variable name transformation.

AddEnvironmentVariables(IConfigurationBuilder)

Source:: EnvironmentVariablesExtensions.cs

Source:: EnvironmentVariablesExtensions.cs

Source:: EnvironmentVariablesExtensions.cs

Source:: EnvironmentVariablesExtensions.cs

Adds an IConfigurationProvider that reads configuration values from environment variables.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddEnvironmentVariables(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder);

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddEnvironmentVariables(this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder);

static member AddEnvironmentVariables : Microsoft.Extensions.Configuration.IConfigurationBuilder -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddEnvironmentVariables (configurationBuilder As IConfigurationBuilder) As IConfigurationBuilder

Parameters

configurationBuilder: IConfigurationBuilder

The IConfigurationBuilder to add to.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Applies to

AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)

Source:: EnvironmentVariablesExtensions.cs

Source:: EnvironmentVariablesExtensions.cs

Source:: EnvironmentVariablesExtensions.cs

Source:: EnvironmentVariablesExtensions.cs

Adds an IConfigurationProvider that reads configuration values from environment variables.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddEnvironmentVariables(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder, Action<Microsoft::Extensions::Configuration::EnvironmentVariables::EnvironmentVariablesConfigurationSource ^> ^ configureSource);

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddEnvironmentVariables(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Action<Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource>? configureSource);

static member AddEnvironmentVariables : Microsoft.Extensions.Configuration.IConfigurationBuilder * Action<Microsoft.Extensions.Configuration.EnvironmentVariables.EnvironmentVariablesConfigurationSource> -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddEnvironmentVariables (builder As IConfigurationBuilder, configureSource As Action(Of EnvironmentVariablesConfigurationSource)) As IConfigurationBuilder

Parameters

builder: IConfigurationBuilder

The IConfigurationBuilder to add to.

configureSource: Action<EnvironmentVariablesConfigurationSource>

The action that configures the source.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Applies to

AddEnvironmentVariables(IConfigurationBuilder, String)

Source:: EnvironmentVariablesExtensions.cs

Source:: EnvironmentVariablesExtensions.cs

Source:: EnvironmentVariablesExtensions.cs

Source:: EnvironmentVariablesExtensions.cs

Adds an IConfigurationProvider that reads configuration values from environment variables with a specified prefix.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddEnvironmentVariables(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, System::String ^ prefix);

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddEnvironmentVariables(this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string? prefix);

static member AddEnvironmentVariables : Microsoft.Extensions.Configuration.IConfigurationBuilder * string -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddEnvironmentVariables (configurationBuilder As IConfigurationBuilder, prefix As String) As IConfigurationBuilder

Parameters

configurationBuilder: IConfigurationBuilder

The IConfigurationBuilder to add to.

prefix: String

The prefix that environment variable names must start with. The prefix will be removed from the environment variable names. The prefix is transformed by DefaultTransformation and then matched against transformed environment variable name, so it should be specified in the pre-transformation form (for example Logging__ for Logging:).

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Applies to

AddEnvironmentVariables(IConfigurationBuilder, String, Func<String,String>)

Source:: EnvironmentVariablesExtensions.cs

Adds an IConfigurationProvider that reads configuration values from environment variables with a specified prefix and variable name transformation.

public:
[System::Runtime::CompilerServices::Extension]
 static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddEnvironmentVariables(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, System::String ^ prefix, Func<System::String ^, System::String ^> ^ variableNameTransformation);

public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddEnvironmentVariables(this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string? prefix, Func<string,string>? variableNameTransformation);

static member AddEnvironmentVariables : Microsoft.Extensions.Configuration.IConfigurationBuilder * string * Func<string, string> -> Microsoft.Extensions.Configuration.IConfigurationBuilder

<Extension()>
Public Function AddEnvironmentVariables (configurationBuilder As IConfigurationBuilder, prefix As String, variableNameTransformation As Func(Of String, String)) As IConfigurationBuilder

Parameters

configurationBuilder: IConfigurationBuilder

The IConfigurationBuilder to add to.

prefix: String

The prefix that environment variable names must start with. The prefix will be removed from the environment variable names. The prefix is transformed by variableNameTransformation and then matched against transformed environment variable name, so it should be specified in the pre-transformation form.

variableNameTransformation: Func<String,String>

A function that transforms environment variable names. When set, this completely replaces the default behavior. When null, DefaultTransformation is used.

Returns

IConfigurationBuilder

The IConfigurationBuilder.

Applies to

Feedback

Was this page helpful?