Microsoft.Extensions.Configuration.Abstractions.xml 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  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.ConfigurationExtensions">
  8. <summary>
  9. Extension methods for configuration classes./>.
  10. </summary>
  11. </member>
  12. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Add``1(Microsoft.Extensions.Configuration.IConfigurationBuilder,System.Action{``0})">
  13. <summary>
  14. Adds a new configuration source.
  15. </summary>
  16. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/> to add to.</param>
  17. <param name="configureSource">Configures the source secrets.</param>
  18. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  19. </member>
  20. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetConnectionString(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  21. <summary>
  22. Shorthand for GetSection("ConnectionStrings")[name].
  23. </summary>
  24. <param name="configuration">The configuration.</param>
  25. <param name="name">The connection string key.</param>
  26. <returns>The connection string.</returns>
  27. </member>
  28. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration)">
  29. <summary>
  30. Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
  31. </summary>
  32. <param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to enumerate.</param>
  33. <returns>An enumeration of key value pairs.</returns>
  34. </member>
  35. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.AsEnumerable(Microsoft.Extensions.Configuration.IConfiguration,System.Boolean)">
  36. <summary>
  37. Get the enumeration of key value pairs within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration" />
  38. </summary>
  39. <param name="configuration">The <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> to enumerate.</param>
  40. <param name="makePathsRelative">If true, the child keys returned will have the current configuration's Path trimmed from the front.</param>
  41. <returns>An enumeration of key value pairs.</returns>
  42. </member>
  43. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.Exists(Microsoft.Extensions.Configuration.IConfigurationSection)">
  44. <summary>
  45. Determines whether the section has a <see cref="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value"/> or has children
  46. </summary>
  47. </member>
  48. <member name="M:Microsoft.Extensions.Configuration.ConfigurationExtensions.GetRequiredSection(Microsoft.Extensions.Configuration.IConfiguration,System.String)">
  49. <summary>
  50. Gets a configuration sub-section with the specified key.
  51. </summary>
  52. <param name="configuration"></param>
  53. <param name="key">The key of the configuration section.</param>
  54. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
  55. <remarks>
  56. If no matching sub-section is found with the specified key, an exception is raised.
  57. </remarks>
  58. <exception cref="T:System.InvalidOperationException">There is no section with key <paramref name="key"/>.</exception>
  59. </member>
  60. <member name="T:Microsoft.Extensions.Configuration.ConfigurationPath">
  61. <summary>
  62. Utility methods and constants for manipulating Configuration paths
  63. </summary>
  64. </member>
  65. <member name="F:Microsoft.Extensions.Configuration.ConfigurationPath.KeyDelimiter">
  66. <summary>
  67. The delimiter ":" used to separate individual keys in a path.
  68. </summary>
  69. </member>
  70. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.String[])">
  71. <summary>
  72. Combines path segments into one path.
  73. </summary>
  74. <param name="pathSegments">The path segments to combine.</param>
  75. <returns>The combined path.</returns>
  76. </member>
  77. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.Combine(System.Collections.Generic.IEnumerable{System.String})">
  78. <summary>
  79. Combines path segments into one path.
  80. </summary>
  81. <param name="pathSegments">The path segments to combine.</param>
  82. <returns>The combined path.</returns>
  83. </member>
  84. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetSectionKey(System.String)">
  85. <summary>
  86. Extracts the last path segment from the path.
  87. </summary>
  88. <param name="path">The path.</param>
  89. <returns>The last path segment of the path.</returns>
  90. </member>
  91. <member name="M:Microsoft.Extensions.Configuration.ConfigurationPath.GetParentPath(System.String)">
  92. <summary>
  93. Extracts the path corresponding to the parent node for a given path.
  94. </summary>
  95. <param name="path">The path.</param>
  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>
  97. </member>
  98. <member name="T:Microsoft.Extensions.Configuration.ConfigurationRootExtensions">
  99. <summary>
  100. Extension methods for <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/>.
  101. </summary>
  102. </member>
  103. <member name="M:Microsoft.Extensions.Configuration.ConfigurationRootExtensions.GetDebugView(Microsoft.Extensions.Configuration.IConfigurationRoot)">
  104. <summary>
  105. Generates a human-readable view of the configuration showing where each value came from.
  106. </summary>
  107. <returns> The debug view. </returns>
  108. </member>
  109. <member name="T:Microsoft.Extensions.Configuration.IConfiguration">
  110. <summary>
  111. Represents a set of key/value application configuration properties.
  112. </summary>
  113. </member>
  114. <member name="P:Microsoft.Extensions.Configuration.IConfiguration.Item(System.String)">
  115. <summary>
  116. Gets or sets a configuration value.
  117. </summary>
  118. <param name="key">The configuration key.</param>
  119. <returns>The configuration value.</returns>
  120. </member>
  121. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetSection(System.String)">
  122. <summary>
  123. Gets a configuration sub-section with the specified key.
  124. </summary>
  125. <param name="key">The key of the configuration section.</param>
  126. <returns>The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/>.</returns>
  127. <remarks>
  128. This method will never return <c>null</c>. If no matching sub-section is found with the specified key,
  129. an empty <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSection"/> will be returned.
  130. </remarks>
  131. </member>
  132. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetChildren">
  133. <summary>
  134. Gets the immediate descendant configuration sub-sections.
  135. </summary>
  136. <returns>The configuration sub-sections.</returns>
  137. </member>
  138. <member name="M:Microsoft.Extensions.Configuration.IConfiguration.GetReloadToken">
  139. <summary>
  140. Returns a <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/> that can be used to observe when this configuration is reloaded.
  141. </summary>
  142. <returns>A <see cref="T:Microsoft.Extensions.Primitives.IChangeToken"/>.</returns>
  143. </member>
  144. <member name="T:Microsoft.Extensions.Configuration.IConfigurationBuilder">
  145. <summary>
  146. Represents a type used to build application configuration.
  147. </summary>
  148. </member>
  149. <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Properties">
  150. <summary>
  151. Gets a key/value collection that can be used to share data between the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>
  152. and the registered <see cref="T:Microsoft.Extensions.Configuration.IConfigurationSource"/>s.
  153. </summary>
  154. </member>
  155. <member name="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources">
  156. <summary>
  157. Gets the sources used to obtain configuration values
  158. </summary>
  159. </member>
  160. <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(Microsoft.Extensions.Configuration.IConfigurationSource)">
  161. <summary>
  162. Adds a new configuration source.
  163. </summary>
  164. <param name="source">The configuration source to add.</param>
  165. <returns>The same <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</returns>
  166. </member>
  167. <member name="M:Microsoft.Extensions.Configuration.IConfigurationBuilder.Build">
  168. <summary>
  169. Builds an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> with keys and values from the set of sources registered in
  170. <see cref="P:Microsoft.Extensions.Configuration.IConfigurationBuilder.Sources"/>.
  171. </summary>
  172. <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationRoot"/> with keys and values from the registered sources.</returns>
  173. </member>
  174. <member name="T:Microsoft.Extensions.Configuration.IConfigurationProvider">
  175. <summary>
  176. Provides configuration key/values for an application.
  177. </summary>
  178. </member>
  179. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.TryGet(System.String,System.String@)">
  180. <summary>
  181. Tries to get a configuration value for the specified key.
  182. </summary>
  183. <param name="key">The key.</param>
  184. <param name="value">The value.</param>
  185. <returns><c>True</c> if a value for the specified key was found, otherwise <c>false</c>.</returns>
  186. </member>
  187. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Set(System.String,System.String)">
  188. <summary>
  189. Sets a configuration value for the specified key.
  190. </summary>
  191. <param name="key">The key.</param>
  192. <param name="value">The value.</param>
  193. </member>
  194. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetReloadToken">
  195. <summary>
  196. Returns a change token if this provider supports change tracking, null otherwise.
  197. </summary>
  198. <returns>The change token.</returns>
  199. </member>
  200. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.Load">
  201. <summary>
  202. Loads configuration values from the source represented by this <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>.
  203. </summary>
  204. </member>
  205. <member name="M:Microsoft.Extensions.Configuration.IConfigurationProvider.GetChildKeys(System.Collections.Generic.IEnumerable{System.String},System.String)">
  206. <summary>
  207. Returns the immediate descendant configuration keys for a given parent path based on this
  208. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s data and the set of keys returned by all the preceding
  209. <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
  210. </summary>
  211. <param name="earlierKeys">The child keys returned by the preceding providers for the same parent path.</param>
  212. <param name="parentPath">The parent path.</param>
  213. <returns>The child keys.</returns>
  214. </member>
  215. <member name="T:Microsoft.Extensions.Configuration.IConfigurationRoot">
  216. <summary>
  217. Represents the root of an <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/> hierarchy.
  218. </summary>
  219. </member>
  220. <member name="M:Microsoft.Extensions.Configuration.IConfigurationRoot.Reload">
  221. <summary>
  222. Force the configuration values to be reloaded from the underlying <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s.
  223. </summary>
  224. </member>
  225. <member name="P:Microsoft.Extensions.Configuration.IConfigurationRoot.Providers">
  226. <summary>
  227. The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/>s for this configuration.
  228. </summary>
  229. </member>
  230. <member name="T:Microsoft.Extensions.Configuration.IConfigurationSection">
  231. <summary>
  232. Represents a section of application configuration values.
  233. </summary>
  234. </member>
  235. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Key">
  236. <summary>
  237. Gets the key this section occupies in its parent.
  238. </summary>
  239. </member>
  240. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Path">
  241. <summary>
  242. Gets the full path to this section within the <see cref="T:Microsoft.Extensions.Configuration.IConfiguration"/>.
  243. </summary>
  244. </member>
  245. <member name="P:Microsoft.Extensions.Configuration.IConfigurationSection.Value">
  246. <summary>
  247. Gets or sets the section value.
  248. </summary>
  249. </member>
  250. <member name="T:Microsoft.Extensions.Configuration.IConfigurationSource">
  251. <summary>
  252. Represents a source of configuration key/values for an application.
  253. </summary>
  254. </member>
  255. <member name="M:Microsoft.Extensions.Configuration.IConfigurationSource.Build(Microsoft.Extensions.Configuration.IConfigurationBuilder)">
  256. <summary>
  257. Builds the <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/> for this source.
  258. </summary>
  259. <param name="builder">The <see cref="T:Microsoft.Extensions.Configuration.IConfigurationBuilder"/>.</param>
  260. <returns>An <see cref="T:Microsoft.Extensions.Configuration.IConfigurationProvider"/></returns>
  261. </member>
  262. <member name="P:System.SR.InvalidSectionName">
  263. <summary>Section '{0}' not found in configuration.</summary>
  264. </member>
  265. </members>
  266. </doc>