ConfigurationBuilder.xml

<Type Name="ConfigurationBuilder" FullName="Microsoft.Extensions.Configuration.ConfigurationBuilder">
  <TypeSignature Language="C#" Value="public class ConfigurationBuilder : Microsoft.Extensions.Configuration.IConfigurationBuilder" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConfigurationBuilder extends System.Object implements class Microsoft.Extensions.Configuration.IConfigurationBuilder" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Configuration.ConfigurationBuilder" />
  <TypeSignature Language="VB.NET" Value="Public Class ConfigurationBuilder&#xA;Implements IConfigurationBuilder" />
  <TypeSignature Language="F#" Value="type ConfigurationBuilder = class&#xA;    interface IConfigurationBuilder" />
  <TypeSignature Language="C++ CLI" Value="public ref class ConfigurationBuilder : Microsoft::Extensions::Configuration::IConfigurationBuilder" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Extensions.Configuration</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>2.1.0.0</AssemblyVersion>
    <AssemblyVersion>2.2.0.0</AssemblyVersion>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>3.1.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>Microsoft.Extensions.Configuration.IConfigurationBuilder</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute FrameworkAlternate="net-8.0-pp;net-9.0-pp">
      <AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.CompilerServices.Nullable(0)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Builds key/value-based configuration settings for use in an application.
            </summary>
    <remarks>
      <format type="text/markdown"><![CDATA[

## Remarks

By using this class, you can store configuration values in a JSON file, for example, and then retrieve them at run time. For more information, see [Configuration - basic example](/dotnet/core/extensions/configuration#basic-example).

If you're migrating an app to .NET Core 3.1 or a later version, you can use this class to replace the *app.config* file functionality that you may have previously used to configure your app.

## Example

The following code snippet shows a simplified app that creates a `ConfigurationBuilder` object to retrieve a string value from a JSON file at run time.
    
:::code language="csharp" source="~/snippets/csharp/Microsoft.Extensions.Configuration/ConfigurationBuilder/Overview/Program.cs":::

The contents of the JSON file are shown here.
    
:::code language="json" source="~/snippets/csharp/Microsoft.Extensions.Configuration/ConfigurationBuilder/Overview/appsettings.json":::
  
   ]]></format>
    </remarks>
    <related type="Article" href="/dotnet/core/extensions/configuration">Configuration in .NET</related>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public ConfigurationBuilder ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Configuration.ConfigurationBuilder.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; ConfigurationBuilder();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Configuration</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:Microsoft.Extensions.Configuration.ConfigurationBuilder" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Add">
      <MemberSignature Language="C#" Value="public Microsoft.Extensions.Configuration.IConfigurationBuilder Add (Microsoft.Extensions.Configuration.IConfigurationSource source);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Extensions.Configuration.IConfigurationBuilder Add(class Microsoft.Extensions.Configuration.IConfigurationSource source) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Configuration.ConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)" />
      <MemberSignature Language="VB.NET" Value="Public Function Add (source As IConfigurationSource) As IConfigurationBuilder" />
      <MemberSignature Language="F#" Value="abstract member Add : Microsoft.Extensions.Configuration.IConfigurationSource -&gt; Microsoft.Extensions.Configuration.IConfigurationBuilder&#xA;override this.Add : Microsoft.Extensions.Configuration.IConfigurationSource -&gt; Microsoft.Extensions.Configuration.IConfigurationBuilder" Usage="configurationBuilder.Add source" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual Microsoft::Extensions::Configuration::IConfigurationBuilder ^ Add(Microsoft::Extensions::Configuration::IConfigurationSource ^ source);" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Configuration</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Extensions.Configuration.IConfigurationBuilder</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="source" Type="Microsoft.Extensions.Configuration.IConfigurationSource" />
      </Parameters>
      <Docs>
        <param name="source">The configuration source to add.</param>
        <summary>
            Adds a new configuration source.
            </summary>
        <returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Build">
      <MemberSignature Language="C#" Value="public Microsoft.Extensions.Configuration.IConfigurationRoot Build ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Extensions.Configuration.IConfigurationRoot Build() cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Configuration.ConfigurationBuilder.Build" />
      <MemberSignature Language="VB.NET" Value="Public Function Build () As IConfigurationRoot" />
      <MemberSignature Language="F#" Value="abstract member Build : unit -&gt; Microsoft.Extensions.Configuration.IConfigurationRoot&#xA;override this.Build : unit -&gt; Microsoft.Extensions.Configuration.IConfigurationRoot" Usage="configurationBuilder.Build " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; virtual Microsoft::Extensions::Configuration::IConfigurationRoot ^ Build();" />
      <MemberType>Method</MemberType>
      <Implements>
        <InterfaceMember>M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Configuration</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Extensions.Configuration.IConfigurationRoot</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" /> with keys and values from the set of providers registered in
            <see cref="P:Microsoft.Extensions.Configuration.ConfigurationBuilder.Sources" />.
            </summary>
        <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot" /> with keys and values from the registered providers.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Properties">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary&lt;string,object&gt; Properties { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2&lt;string, object&gt; Properties" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Configuration.ConfigurationBuilder.Properties" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Properties As IDictionary(Of String, Object)" />
      <MemberSignature Language="F#" Value="member this.Properties : System.Collections.Generic.IDictionary&lt;string, obj&gt;" Usage="Microsoft.Extensions.Configuration.ConfigurationBuilder.Properties" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Collections::Generic::IDictionary&lt;System::String ^, System::Object ^&gt; ^ Properties { System::Collections::Generic::IDictionary&lt;System::String ^, System::Object ^&gt; ^ get(); };" />
      <MemberType>Property</MemberType>
      <Implements>
        <InterfaceMember>P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Configuration</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IDictionary&lt;System.String,System.Object&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />
            and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> providers.
            </summary>
        <value>A key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder" />
            and the registered configuration providers.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Sources">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Microsoft.Extensions.Configuration.IConfigurationSource&gt; Sources { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;class Microsoft.Extensions.Configuration.IConfigurationSource&gt; Sources" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Configuration.ConfigurationBuilder.Sources" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Sources As IList(Of IConfigurationSource)" />
      <MemberSignature Language="F#" Value="member this.Sources : System.Collections.Generic.IList&lt;Microsoft.Extensions.Configuration.IConfigurationSource&gt;" Usage="Microsoft.Extensions.Configuration.ConfigurationBuilder.Sources" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Collections::Generic::IList&lt;Microsoft::Extensions::Configuration::IConfigurationSource ^&gt; ^ Sources { System::Collections::Generic::IList&lt;Microsoft::Extensions::Configuration::IConfigurationSource ^&gt; ^ get(); };" />
      <MemberType>Property</MemberType>
      <Implements>
        <InterfaceMember>P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources</InterfaceMember>
      </Implements>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Extensions.Configuration</AssemblyName>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Microsoft.Extensions.Configuration.IConfigurationSource&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            Gets the sources used to obtain configuration values.
            </summary>
        <value>The sources used to obtain configuration values.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>