1 <?xml version="1.0"?>
\r
4 <name>Microsoft.Extensions.Configuration.Abstractions</name>
\r
7 <member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
\r
9 Extension methods for configuration classes./>.
\r
12 <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
\r
14 Adds a new configuration source.
\r
16 <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
\r
17 <param name="configureSource">Configures the source secrets.</param>
\r
18 <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
\r
20 <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
\r
22 Shorthand for GetSection("ConnectionStrings")[name].
\r
24 <param name="configuration">The configuration.</param>
\r
25 <param name="name">The connection string key.</param>
\r
26 <returns>The connection string.</returns>
\r
28 <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
\r
30 Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
\r
32 <param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to enumerate.</param>
\r
33 <returns>An enumeration of key value pairs.</returns>
\r
35 <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
\r
37 Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
\r
39 <param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to enumerate.</param>
\r
40 <param name="makePathsRelative">If true, the child keys returned will have the current configuration's Path trimmed from the front.</param>
\r
41 <returns>An enumeration of key value pairs.</returns>
\r
43 <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
\r
45 Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children
\r
48 <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
\r
50 Gets a configuration sub-section with the specified key.
\r
52 <param name="configuration"></param>
\r
53 <param name="key">The key of the configuration section.</param>
\r
54 <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
\r
56 If no matching sub-section is found with the specified key, an exception is raised.
\r
58 <exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>
\r
60 <member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
\r
62 Utility methods and constants for manipulating Configuration paths
\r
65 <member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
\r
67 The delimiter ":" used to separate individual keys in a path.
\r
70 <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
\r
72 Combines path segments into one path.
\r
74 <param name="pathSegments">The path segments to combine.</param>
\r
75 <returns>The combined path.</returns>
\r
77 <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
\r
79 Combines path segments into one path.
\r
81 <param name="pathSegments">The path segments to combine.</param>
\r
82 <returns>The combined path.</returns>
\r
84 <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
\r
86 Extracts the last path segment from the path.
\r
88 <param name="path">The path.</param>
\r
89 <returns>The last path segment of the path.</returns>
\r
91 <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
\r
93 Extracts the path corresponding to the parent node for a given path.
\r
95 <param name="path">The path.</param>
\r
96 <returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
\r
98 <member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
\r
100 Extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
\r
103 <member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
\r
105 Generates a human-readable view of the configuration showing where each value came from.
\r
107 <returns> The debug view. </returns>
\r
109 <member name="T:Microsoft.Extensions.Configuration.IConfiguration">
\r
111 Represents a set of key/value application configuration properties.
\r
114 <member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
\r
116 Gets or sets a configuration value.
\r
118 <param name="key">The configuration key.</param>
\r
119 <returns>The configuration value.</returns>
\r
121 <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
\r
123 Gets a configuration sub-section with the specified key.
\r
125 <param name="key">The key of the configuration section.</param>
\r
126 <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
\r
128 This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
\r
129 an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
\r
132 <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
\r
134 Gets the immediate descendant configuration sub-sections.
\r
136 <returns>The configuration sub-sections.</returns>
\r
138 <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
\r
140 Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
\r
142 <returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>.</returns>
\r
144 <member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
\r
146 Represents a type used to build application configuration.
\r
149 <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
\r
151 Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
\r
152 and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
\r
155 <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
\r
157 Gets the sources used to obtain configuration values
\r
160 <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
\r
162 Adds a new configuration source.
\r
164 <param name="source">The configuration source to add.</param>
\r
165 <returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
\r
167 <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
\r
169 Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
\r
170 <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
\r
172 <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
\r
174 <member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
\r
176 Provides configuration key/values for an application.
\r
179 <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
\r
181 Tries to get a configuration value for the specified key.
\r
183 <param name="key">The key.</param>
\r
184 <param name="value">The value.</param>
\r
185 <returns><c>True</c> if a value for the specified key was found, otherwise <c>false</c>.</returns>
\r
187 <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
\r
189 Sets a configuration value for the specified key.
\r
191 <param name="key">The key.</param>
\r
192 <param name="value">The value.</param>
\r
194 <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
\r
196 Returns a change token if this provider supports change tracking, null otherwise.
\r
198 <returns>The change token.</returns>
\r
200 <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
\r
202 Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
\r
205 <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
\r
207 Returns the immediate descendant configuration keys for a given parent path based on this
\r
208 <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s data and the set of keys returned by all the preceding
\r
209 <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
\r
211 <param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
\r
212 <param name="parentPath">The parent path.</param>
\r
213 <returns>The child keys.</returns>
\r
215 <member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
\r
217 Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
\r
220 <member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
\r
222 Force the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
\r
225 <member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
\r
227 The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.
\r
230 <member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
\r
232 Represents a section of application configuration values.
\r
235 <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
\r
237 Gets the key this section occupies in its parent.
\r
240 <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
\r
242 Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
\r
245 <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
\r
247 Gets or sets the section value.
\r
250 <member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
\r
252 Represents a source of configuration key/values for an application.
\r
255 <member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
\r
257 Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
\r
259 <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
\r
260 <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
\r
262 <member name="P:System.SR.InvalidSectionName">
\r
263 <summary>Section '{0}' not found in configuration.</summary>
\r