ConfigurationManager Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет изменяемый объект конфигурации. Это как IConfigurationBuilder, так и IConfigurationRoot. По мере добавления источников он обновляет текущее представление конфигурации. После вызова IConfigurationBuilder.Build() конфигурация зависла.
public ref class ConfigurationManager sealed : IDisposable, Microsoft::Extensions::Configuration::IConfigurationManager, Microsoft::Extensions::Configuration::IConfigurationRoot
public sealed class ConfigurationManager : IDisposable, Microsoft.Extensions.Configuration.IConfigurationManager, Microsoft.Extensions.Configuration.IConfigurationRoot
type ConfigurationManager = class
interface IConfigurationManager
interface IConfiguration
interface IConfigurationBuilder
interface IConfigurationRoot
interface IDisposable
Public NotInheritable Class ConfigurationManager
Implements IConfigurationManager, IConfigurationRoot, IDisposable
- Наследование
-
ConfigurationManager
- Реализации
Комментарии
Это как IConfigurationBuilder, так и IConfigurationRoot. При добавлении источников он обновляет текущее представление конфигурации. После вызова IConfigurationBuilder.Build() конфигурация зависла.
Конструкторы
ConfigurationManager() |
Создает пустой объект конфигурации, который является как IConfigurationBuilder, так и IConfigurationRoot. |
Свойства
Item[String] |
Возвращает или задает значение конфигурации. |
Sources |
Возвращает источники, используемые для получения значений конфигурации. |
Методы
Dispose() |
Выполняет определяемые приложением задачи, связанные с освобождением, освобождением или сбросом неуправляемых ресурсов. |
Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
GetChildren() |
Возвращает подразделы конфигурации немедленного потомка. |
GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
GetSection(String) |
Возвращает подраздел конфигурации с указанным ключом. |
GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
Явные реализации интерфейса
IConfiguration.GetReloadToken() |
Возвращает IChangeToken, которые можно использовать для отслеживания при перезагрузке этой конфигурации. |
IConfigurationBuilder.Add(IConfigurationSource) |
Добавляет новый источник конфигурации. |
IConfigurationBuilder.Build() |
Создает IConfiguration с ключами и значениями из набора источников, зарегистрированных в Sources. |
IConfigurationBuilder.Properties |
Получает коллекцию "ключ-значение", которая может использоваться для совместного использования данных между IConfigurationBuilder и зарегистрированными источниками конфигурации. |
IConfigurationRoot.Providers |
Возвращает поставщики конфигурации для этой конфигурации. |
IConfigurationRoot.Reload() |
Принудительно перезагрузить значения конфигурации из базовых IConfigurationProvider экземпляров. |
Методы расширения
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String) |
Регистрирует поставщик конфигурации для метаданных приложения. |
AddConfiguration(IConfigurationBuilder, IConfiguration) |
Добавляет существующую конфигурацию в |
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean) |
Добавляет существующую конфигурацию в |
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>) |
Добавляет IConfigurationProvider, который считывает значения конфигурации из командной строки. |
AddCommandLine(IConfigurationBuilder, String[]) |
Добавляет CommandLineConfigurationProvider, который считывает значения конфигурации из командной строки. |
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>) |
Добавляет CommandLineConfigurationProvider, который считывает значения конфигурации из командной строки с помощью указанных сопоставлений коммутаторов. |
Bind(IConfiguration, Object) |
Пытается привязать заданный экземпляр объекта к значениям конфигурации путем сопоставления имен свойств с ключами конфигурации рекурсивно. |
Bind(IConfiguration, Object, Action<BinderOptions>) |
Пытается привязать заданный экземпляр объекта к значениям конфигурации путем сопоставления имен свойств с ключами конфигурации рекурсивно. |
Bind(IConfiguration, String, Object) |
Пытается привязать заданный экземпляр объекта к разделу конфигурации, указанному ключом, путем сопоставления имен свойств с ключами конфигурации рекурсивно. |
Get(IConfiguration, Type) |
Пытается привязать экземпляр конфигурации к новому экземпляру типа T. Если в этом разделе конфигурации есть значение, которое будет использоваться. В противном случае привязка путем сопоставления имен свойств с ключами конфигурации рекурсивно. |
Get(IConfiguration, Type, Action<BinderOptions>) |
Пытается привязать экземпляр конфигурации к новому экземпляру типа T. Если в этом разделе конфигурации есть значение, которое будет использоваться. В противном случае привязка путем сопоставления имен свойств с ключами конфигурации рекурсивно. |
Get<T>(IConfiguration) |
Пытается привязать экземпляр конфигурации к новому экземпляру типа T. Если в этом разделе конфигурации есть значение, которое будет использоваться. В противном случае привязка путем сопоставления имен свойств с ключами конфигурации рекурсивно. |
Get<T>(IConfiguration, Action<BinderOptions>) |
Пытается привязать экземпляр конфигурации к новому экземпляру типа T. Если в этом разделе конфигурации есть значение, которое будет использоваться. В противном случае привязка путем сопоставления имен свойств с ключами конфигурации рекурсивно. |
GetValue(IConfiguration, Type, String) |
Извлекает значение с указанным ключом и преобразует его в указанный тип. |
GetValue(IConfiguration, Type, String, Object) |
Извлекает значение с указанным ключом и преобразует его в указанный тип. |
GetValue<T>(IConfiguration, String) |
Извлекает значение с указанным ключом и преобразует его в тип T. |
GetValue<T>(IConfiguration, String, T) |
Извлекает значение с указанным ключом и преобразует его в тип T. |
Add<TSource>(IConfigurationBuilder, Action<TSource>) |
Добавляет новый источник конфигурации. |
AsEnumerable(IConfiguration) |
Получение перечисления пар "ключ-значение" в IConfiguration. |
AsEnumerable(IConfiguration, Boolean) |
Возвращает перечисление пар "ключ-значение" в IConfiguration. |
GetConnectionString(IConfiguration, String) |
Извлекает значение с указанным ключом из раздела |
GetRequiredSection(IConfiguration, String) |
Возвращает подраздел конфигурации, имеющий указанный ключ. |
GetDebugView(IConfigurationRoot) |
Создает удобочитаемое представление конфигурации, показывающее, откуда поступило каждое значение. |
GetDebugView(IConfigurationRoot, Func<ConfigurationDebugViewContext,String>) |
Создает удобочитаемое представление конфигурации, показывающее, откуда поступило каждое значение. |
AddEnvironmentVariables(IConfigurationBuilder) |
Добавляет IConfigurationProvider, который считывает значения конфигурации из переменных среды. |
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>) |
Добавляет IConfigurationProvider, который считывает значения конфигурации из переменных среды. |
AddEnvironmentVariables(IConfigurationBuilder, String) |
Добавляет IConfigurationProvider, который считывает значения конфигурации из переменных среды с указанным префиксом. |
GetFileLoadExceptionHandler(IConfigurationBuilder) |
Возвращает IFileProvider по умолчанию для поставщиков на основе файлов. |
GetFileProvider(IConfigurationBuilder) |
Возвращает IFileProvider по умолчанию для поставщиков на основе файлов. |
SetBasePath(IConfigurationBuilder, String) |
Задает FileProvider для поставщиков на основе файлов значение PhysicalFileProvider с базовым путем. |
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>) |
Задает действие по умолчанию для поставщиков на основе файлов при возникновении ошибки. |
SetFileProvider(IConfigurationBuilder, IFileProvider) |
Задает IFileProvider по умолчанию для поставщиков на основе файлов. |
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean) |
Добавляет источник конфигурации INI в |
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>) |
Добавляет источник конфигурации INI в |
AddIniFile(IConfigurationBuilder, String) |
Добавляет поставщик конфигурации INI в |
AddIniFile(IConfigurationBuilder, String, Boolean) |
Добавляет поставщик конфигурации INI в |
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean) |
Добавляет поставщик конфигурации INI в |
AddIniStream(IConfigurationBuilder, Stream) |
Добавляет источник конфигурации INI в |
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean) |
Добавляет источник конфигурации JSON в |
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>) |
Добавляет источник конфигурации JSON в |
AddJsonFile(IConfigurationBuilder, String) |
Добавляет поставщик конфигурации JSON в |
AddJsonFile(IConfigurationBuilder, String, Boolean) |
Добавляет поставщик конфигурации JSON в |
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean) |
Добавляет поставщик конфигурации JSON в |
AddJsonStream(IConfigurationBuilder, Stream) |
Добавляет источник конфигурации JSON в |
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>) |
Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения. |
AddKeyPerFile(IConfigurationBuilder, String) |
Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения. |
AddKeyPerFile(IConfigurationBuilder, String, Boolean) |
Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения. |
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean) |
Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения. |
AddInMemoryCollection(IConfigurationBuilder) |
Добавляет поставщик конфигурации памяти в |
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>) |
Добавляет поставщик конфигурации памяти в |
AddUserSecrets(IConfigurationBuilder, Assembly) |
Добавляет источник конфигурации секретов пользователя. При этом выполняется поиск Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов. |
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean) |
Добавляет источник конфигурации секретов пользователя. При этом выполняется поиск Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов. |
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean) |
Добавляет источник конфигурации секретов пользователя. При этом выполняется поиск Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов. |
AddUserSecrets(IConfigurationBuilder, String) |
Добавляет источник конфигурации секретов пользователя с указанным идентификатором секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов. |
AddUserSecrets(IConfigurationBuilder, String, Boolean) |
Добавляет источник конфигурации секретов пользователя с указанным идентификатором секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов. |
AddUserSecrets<T>(IConfigurationBuilder) |
Добавляет источник конфигурации секретов пользователя. Выполняет поиск сборки, содержащей тип Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов. |
AddUserSecrets<T>(IConfigurationBuilder, Boolean) |
Добавляет источник конфигурации секретов пользователя. Выполняет поиск сборки, содержащей тип Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов. |
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean) |
Добавляет источник конфигурации секретов пользователя. Выполняет поиск сборки, содержащей тип Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов. |
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean) |
Добавляет источник конфигурации XML в |
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>) |
Добавляет источник конфигурации XML в |
AddXmlFile(IConfigurationBuilder, String) |
Добавляет поставщик конфигурации XML в |
AddXmlFile(IConfigurationBuilder, String, Boolean) |
Добавляет поставщик конфигурации XML в |
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean) |
Добавляет поставщик конфигурации XML в |
AddXmlStream(IConfigurationBuilder, Stream) |
Добавляет источник конфигурации XML в |
Применяется к
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по