Microsoft.Extensions.Configuration.Abstractions.xml 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.Extensions.Configuration.Abstractions</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext">
  8. <summary>
  9. Provides the data about current item of the configuration.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.#ctor(System.String,System.String,System.String,Microsoft.Extensions.Configuration.IConfigurationProvider)">
  13. <summary>
  14. Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext"/>.
  15. </summary>
  16. <param name="path">The path of the current item of the configuration.</param>
  17. <param name="key">The key of the current item of the configuration.</param>
  18. <param name="value">The value of the current item of the configuration.</param>
  19. <param name="configurationProvider">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> to use to get the value of the current item.</param>
  20. </member>
  21. <member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Path">
  22. <summary>
  23. Gets the path of the current item.
  24. </summary>
  25. </member>
  26. <member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Key">
  27. <summary>
  28. Gets the key of the current item.
  29. </summary>
  30. </member>
  31. <member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.Value">
  32. <summary>
  33. Gets the value of the current item.
  34. </summary>
  35. </member>
  36. <member name="P:Microsoft.Extensions.Configuration.ConfigurationDebugViewContext.ConfigurationProvider">
  37. <summary>
  38. Gets the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider" /> that was used to get the value of the current item.
  39. </summary>
  40. </member>
  41. <member name="T:Microsoft.Extensions.Configuration.ConfigurationExtensions">
  42. <summary>
  43. Extension methods for configuration classes.
  44. </summary>
  45. </member>
  46. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
  47. <summary>
  48. Adds a new configuration source.
  49. </summary>
  50. <param name="builder">The builder to add to.</param>
  51. <param name="configureSource">Configures the source secrets.</param>
  52. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  53. </member>
  54. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  55. <summary>
  56. Shorthand for GetSection("ConnectionStrings")[name].
  57. </summary>
  58. <param name="configuration">The configuration to enumerate.</param>
  59. <param name="name">The connection string key.</param>
  60. <returns>The connection string.</returns>
  61. </member>
  62. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
  63. <summary>
  64. Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
  65. </summary>
  66. <param name="configuration">The configuration to enumerate.</param>
  67. <returns>An enumeration of key value pairs.</returns>
  68. </member>
  69. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
  70. <summary>
  71. Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
  72. </summary>
  73. <param name="configuration">The configuration to enumerate.</param>
  74. <param name="makePathsRelative">If true, the child keys returned will have the current configuration's Path trimmed from the front.</param>
  75. <returns>An enumeration of key value pairs.</returns>
  76. </member>
  77. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
  78. <summary>
  79. Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children
  80. </summary>
  81. <param name="section">The section to enumerate.</param>
  82. <returns><see langword="true" /> if the section has values or children; otherwise, <see langword="false" />.</returns>
  83. </member>
  84. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  85. <summary>
  86. Gets a configuration sub-section with the specified key.
  87. </summary>
  88. <param name="configuration">The configuration to enumerate.</param>
  89. <param name="key">The key of the configuration section.</param>
  90. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
  91. <remarks>
  92. If no matching sub-section is found with the specified key, an exception is raised.
  93. </remarks>
  94. <exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>
  95. </member>
  96. <member name="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute">
  97. <summary>
  98. Specifies the key name for a configuration property.
  99. </summary>
  100. </member>
  101. <member name="M:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.#ctor(System.String)">
  102. <summary>
  103. Initializes a new instance of <see cref="T:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute"/>.
  104. </summary>
  105. <param name="name">The key name.</param>
  106. </member>
  107. <member name="P:Microsoft.Extensions.Configuration.ConfigurationKeyNameAttribute.Name">
  108. <summary>
  109. The key name for a configuration property.
  110. </summary>
  111. </member>
  112. <member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
  113. <summary>
  114. Utility methods and constants for manipulating Configuration paths
  115. </summary>
  116. </member>
  117. <member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
  118. <summary>
  119. The delimiter ":" used to separate individual keys in a path.
  120. </summary>
  121. </member>
  122. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
  123. <summary>
  124. Combines path segments into one path.
  125. </summary>
  126. <param name="pathSegments">The path segments to combine.</param>
  127. <returns>The combined path.</returns>
  128. </member>
  129. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
  130. <summary>
  131. Combines path segments into one path.
  132. </summary>
  133. <param name="pathSegments">The path segments to combine.</param>
  134. <returns>The combined path.</returns>
  135. </member>
  136. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
  137. <summary>
  138. Extracts the last path segment from the path.
  139. </summary>
  140. <param name="path">The path.</param>
  141. <returns>The last path segment of the path.</returns>
  142. </member>
  143. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
  144. <summary>
  145. Extracts the path corresponding to the parent node for a given path.
  146. </summary>
  147. <param name="path">The path.</param>
  148. <returns>The original path minus the last individual segment found in it. Null if the original path corresponds to a top level node.</returns>
  149. </member>
  150. <member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
  151. <summary>
  152. Extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
  153. </summary>
  154. </member>
  155. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
  156. <summary>
  157. Generates a human-readable view of the configuration showing where each value came from.
  158. </summary>
  159. <returns> The debug view. </returns>
  160. </member>
  161. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot,System.Func{Microsoft.Extensions.Configuration.ConfigurationDebugViewContext,System.String})">
  162. <summary>
  163. Generates a human-readable view of the configuration showing where each value came from.
  164. </summary>
  165. <param name="root">Configuration root</param>
  166. <param name="processValue">
  167. Function for processing the value e.g. hiding secrets
  168. Parameters:
  169. ConfigurationDebugViewContext: Context of the current configuration item
  170. returns: A string value is used to assign as the Value of the configuration section
  171. </param>
  172. <returns> The debug view. </returns>
  173. </member>
  174. <member name="T:Microsoft.Extensions.Configuration.IConfiguration">
  175. <summary>
  176. Represents a set of key/value application configuration properties.
  177. </summary>
  178. </member>
  179. <member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
  180. <summary>
  181. Gets or sets a configuration value.
  182. </summary>
  183. <param name="key">The configuration key.</param>
  184. <returns>The configuration value.</returns>
  185. </member>
  186. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
  187. <summary>
  188. Gets a configuration sub-section with the specified key.
  189. </summary>
  190. <param name="key">The key of the configuration section.</param>
  191. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
  192. <remarks>
  193. This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
  194. an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
  195. </remarks>
  196. </member>
  197. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
  198. <summary>
  199. Gets the immediate descendant configuration sub-sections.
  200. </summary>
  201. <returns>The configuration sub-sections.</returns>
  202. </member>
  203. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
  204. <summary>
  205. Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
  206. </summary>
  207. <returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>.</returns>
  208. </member>
  209. <member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
  210. <summary>
  211. Represents a type used to build application configuration.
  212. </summary>
  213. </member>
  214. <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
  215. <summary>
  216. Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
  217. and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
  218. </summary>
  219. </member>
  220. <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
  221. <summary>
  222. Gets the sources used to obtain configuration values
  223. </summary>
  224. </member>
  225. <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
  226. <summary>
  227. Adds a new configuration source.
  228. </summary>
  229. <param name="source">The configuration source to add.</param>
  230. <returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  231. </member>
  232. <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
  233. <summary>
  234. Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
  235. <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
  236. </summary>
  237. <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
  238. </member>
  239. <member name="T:Microsoft.Extensions.Configuration.IConfigurationManager">
  240. <summary>
  241. Represents a mutable configuration object.
  242. </summary>
  243. <remarks>
  244. It is both an <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> and an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
  245. As sources are added, it updates its current view of configuration.
  246. </remarks>
  247. </member>
  248. <member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
  249. <summary>
  250. Provides configuration key/values for an application.
  251. </summary>
  252. </member>
  253. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
  254. <summary>
  255. Tries to get a configuration value for the specified key.
  256. </summary>
  257. <param name="key">The key.</param>
  258. <param name="value">The value.</param>
  259. <returns><c>True</c> if a value for the specified key was found, otherwise <c>false</c>.</returns>
  260. </member>
  261. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
  262. <summary>
  263. Sets a configuration value for the specified key.
  264. </summary>
  265. <param name="key">The key.</param>
  266. <param name="value">The value.</param>
  267. </member>
  268. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
  269. <summary>
  270. Returns a change token if this provider supports change tracking, null otherwise.
  271. </summary>
  272. <returns>The change token.</returns>
  273. </member>
  274. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
  275. <summary>
  276. Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
  277. </summary>
  278. </member>
  279. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
  280. <summary>
  281. Returns the immediate descendant configuration keys for a given parent path based on this
  282. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s data and the set of keys returned by all the preceding
  283. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
  284. </summary>
  285. <param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
  286. <param name="parentPath">The parent path.</param>
  287. <returns>The child keys.</returns>
  288. </member>
  289. <member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
  290. <summary>
  291. Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
  292. </summary>
  293. </member>
  294. <member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
  295. <summary>
  296. Force the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
  297. </summary>
  298. </member>
  299. <member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
  300. <summary>
  301. The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.
  302. </summary>
  303. </member>
  304. <member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
  305. <summary>
  306. Represents a section of application configuration values.
  307. </summary>
  308. </member>
  309. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
  310. <summary>
  311. Gets the key this section occupies in its parent.
  312. </summary>
  313. </member>
  314. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
  315. <summary>
  316. Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
  317. </summary>
  318. </member>
  319. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
  320. <summary>
  321. Gets or sets the section value.
  322. </summary>
  323. </member>
  324. <member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
  325. <summary>
  326. Represents a source of configuration key/values for an application.
  327. </summary>
  328. </member>
  329. <member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  330. <summary>
  331. Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
  332. </summary>
  333. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  334. <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
  335. </member>
  336. <member name="M:System.ThrowHelper.ThrowIfNull(System.Object,System.String)">
  337. <summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
  338. <param name="argument">The reference type argument to validate as non-null.</param>
  339. <param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
  340. </member>
  341. <member name="M:System.ThrowHelper.IfNullOrWhitespace(System.String,System.String)">
  342. <summary>
  343. Throws either an <see cref="T:System.ArgumentNullException"/> or an <see cref="T:System.ArgumentException"/>
  344. if the specified string is <see langword="null"/> or whitespace respectively.
  345. </summary>
  346. <param name="argument">String to be checked for <see langword="null"/> or whitespace.</param>
  347. <param name="paramName">The name of the parameter being checked.</param>
  348. <returns>The original value of <paramref name="argument"/>.</returns>
  349. </member>
  350. <member name="P:System.SR.InvalidSectionName">
  351. <summary>Section '{0}' not found in configuration.</summary>
  352. </member>
  353. </members>
  354. </doc>