ConfigurationManager Класс

Определение

Пространство имен:: Microsoft.Extensions.Configuration

Сборка:: Microsoft.Extensions.Configuration.dll

Пакет:: Microsoft.Extensions.Configuration v11.0.0-preview.5.26302.115

Исходный код:: ConfigurationManager.cs

Исходный код:: ConfigurationManager.cs

Исходный код:: ConfigurationManager.cs

Исходный код:: ConfigurationManager.cs

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Представляет изменяемый объект конфигурации.

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

Наследование: Object
ConfigurationManager

Реализации: IConfiguration IConfigurationBuilder IConfigurationManager IConfigurationRoot IDisposable

Конструкторы

Имя	Описание
ConfigurationManager()	Создает пустой объект конфигурации, который является как объектом IConfigurationBuilder , так и IConfigurationRootобъектом.

Свойства

Имя	Описание
Item[String]	Возвращает или задает значение конфигурации.
Sources	Возвращает источники, используемые для получения значений конфигурации.

Методы

Имя	Описание
Dispose()	Выполняет определяемые приложением задачи, связанные с освобождением, освобождением или сбросом неуправляемых ресурсов.
GetChildren()	Возвращает подразделы конфигурации немедленного потомка.
GetSection(String)	Возвращает подраздел конфигурации с указанным ключом.

Явные реализации интерфейса

Имя	Описание
IConfiguration.GetReloadToken()	Возвращает значение IChangeToken , которое можно использовать для отслеживания при перезагрузке этой конфигурации.
IConfigurationBuilder.Add(IConfigurationSource)	Добавляет новый источник конфигурации.
IConfigurationBuilder.Build()	IConfiguration Создает ключи и значения из набора источников, зарегистрированных в Sources.
IConfigurationBuilder.Properties	Возвращает коллекцию "ключ-значение", которая может использоваться для совместного использования данных между IConfigurationBuilder источниками зарегистрированной конфигурации.
IConfigurationRoot.Providers	Возвращает поставщики конфигурации для этой конфигурации.
IConfigurationRoot.Reload()	Принудительно перезагрузить значения конфигурации из базовых IConfigurationProvider экземпляров.

Методы расширения

Имя	Описание
Add<TSource>(IConfigurationBuilder, Action<TSource>)	Добавляет новый источник конфигурации.
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String)	Регистрирует поставщик конфигурации для метаданных приложения.
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)	Добавляет значение IConfigurationProvider конфигурации, которое считывает значения конфигурации из командной строки.
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)	Добавляет значение CommandLineConfigurationProvider IConfigurationProvider , которое считывает значения конфигурации из командной строки с помощью указанных сопоставлений коммутаторов.
AddCommandLine(IConfigurationBuilder, String[])	Добавляет значение CommandLineConfigurationProvider IConfigurationProvider конфигурации, которое считывает значения конфигурации из командной строки.
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean)	Добавляет существующую конфигурацию `configurationBuilder`в .
AddConfiguration(IConfigurationBuilder, IConfiguration)	Добавляет существующую конфигурацию `configurationBuilder`в .
AddEnvironmentVariables(IConfigurationBuilder, Action<EnvironmentVariablesConfigurationSource>)	Добавляет значение IConfigurationProvider конфигурации, которое считывает значения конфигурации из переменных среды.
AddEnvironmentVariables(IConfigurationBuilder, String)	Добавляет значение IConfigurationProvider , которое считывает значения конфигурации из переменных среды с указанным префиксом.
AddEnvironmentVariables(IConfigurationBuilder)	Добавляет значение IConfigurationProvider конфигурации, которое считывает значения конфигурации из переменных среды.
AddIniFile(IConfigurationBuilder, Action<IniConfigurationSource>)	Добавляет источник конфигурации INI в `builder`.
AddIniFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Добавляет источник конфигурации INI в `builder`.
AddIniFile(IConfigurationBuilder, String, Boolean, Boolean)	Добавляет поставщик конфигурации INI в `pathbuilder`.
AddIniFile(IConfigurationBuilder, String, Boolean)	Добавляет поставщик конфигурации INI в `pathbuilder`.
AddIniFile(IConfigurationBuilder, String)	Добавляет поставщик конфигурации INI в `pathbuilder`.
AddIniStream(IConfigurationBuilder, Stream)	Добавляет источник конфигурации INI в `builder`.
AddInMemoryCollection(IConfigurationBuilder, IEnumerable<KeyValuePair<String,String>>)	Добавляет поставщик `configurationBuilder`конфигурации памяти в .
AddInMemoryCollection(IConfigurationBuilder)	Добавляет поставщик `configurationBuilder`конфигурации памяти в .
AddJsonFile(IConfigurationBuilder, Action<JsonConfigurationSource>)	Добавляет источник конфигурации JSON в `builder`.
AddJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Добавляет источник конфигурации JSON в `builder`.
AddJsonFile(IConfigurationBuilder, String, Boolean, Boolean)	Добавляет поставщик конфигурации JSON в `pathbuilder`.
AddJsonFile(IConfigurationBuilder, String, Boolean)	Добавляет поставщик конфигурации JSON в `pathbuilder`.
AddJsonFile(IConfigurationBuilder, String)	Добавляет поставщик конфигурации JSON в `pathbuilder`.
AddJsonStream(IConfigurationBuilder, Stream)	Добавляет источник конфигурации JSON в `builder`.
AddKeyPerFile(IConfigurationBuilder, Action<KeyPerFileConfigurationSource>)	Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения.
AddKeyPerFile(IConfigurationBuilder, String, Boolean, Boolean)	Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения.
AddKeyPerFile(IConfigurationBuilder, String, Boolean)	Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения.
AddKeyPerFile(IConfigurationBuilder, String)	Добавляет конфигурацию с помощью файлов из каталога. Имена файлов используются в качестве ключа, содержимое файла используется в качестве значения.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean)	Добавляет источник конфигурации секретов пользователя. При этом выполняется поиск `assembly` экземпляра, указывающего идентификатор секретов UserSecretsIdAttributeпользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean)	Добавляет источник конфигурации секретов пользователя. При этом выполняется поиск `assembly` экземпляра, указывающего идентификатор секретов UserSecretsIdAttributeпользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddUserSecrets(IConfigurationBuilder, Assembly)	Добавляет источник конфигурации секретов пользователя. При этом выполняется поиск `assembly` экземпляра, указывающего идентификатор секретов UserSecretsIdAttributeпользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddUserSecrets(IConfigurationBuilder, String, Boolean)	Добавляет источник конфигурации секретов пользователя с указанным идентификатором секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddUserSecrets(IConfigurationBuilder, String)	Добавляет источник конфигурации секретов пользователя с указанным идентификатором секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean)	Добавляет источник конфигурации секретов пользователя. Выполняет поиск сборки, содержащей тип `T` экземпляра, который задает идентификатор секретов UserSecretsIdAttributeпользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddUserSecrets<T>(IConfigurationBuilder, Boolean)	Добавляет источник конфигурации секретов пользователя. Выполняет поиск сборки, содержащей тип `T` экземпляра, который задает идентификатор секретов UserSecretsIdAttributeпользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddUserSecrets<T>(IConfigurationBuilder)	Добавляет источник конфигурации секретов пользователя. Выполняет поиск сборки, содержащей тип `T` экземпляра, который задает идентификатор секретов UserSecretsIdAttributeпользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции значений конфигурации секретов.
AddXmlFile(IConfigurationBuilder, Action<XmlConfigurationSource>)	Добавляет источник конфигурации XML в `builder`.
AddXmlFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean)	Добавляет источник конфигурации XML в `builder`.
AddXmlFile(IConfigurationBuilder, String, Boolean, Boolean)	Добавляет поставщик конфигурации XML в `pathbuilder`.
AddXmlFile(IConfigurationBuilder, String, Boolean)	Добавляет поставщик конфигурации XML в `pathbuilder`.
AddXmlFile(IConfigurationBuilder, String)	Добавляет поставщик конфигурации XML в `pathbuilder`.
AddXmlStream(IConfigurationBuilder, Stream)	Добавляет источник конфигурации XML в `builder`.
AsEnumerable(IConfiguration, Boolean)	Получение перечисления пар значений ключа в пределах IConfiguration
AsEnumerable(IConfiguration)	Получение перечисления пар значений ключа в пределах IConfiguration
Bind(IConfiguration, Object, Action<BinderOptions>)	Пытается привязать заданный экземпляр объекта к значениям конфигурации путем сопоставления имен свойств с ключами конфигурации рекурсивно.
Bind(IConfiguration, Object)	Пытается привязать заданный экземпляр объекта к значениям конфигурации путем сопоставления имен свойств с ключами конфигурации рекурсивно.
Bind(IConfiguration, String, Object)	Пытается привязать заданный экземпляр объекта к разделу конфигурации, указанному ключом, путем сопоставления имен свойств с ключами конфигурации рекурсивно.
Get(IConfiguration, Type, Action<BinderOptions>)	Пытается привязать экземпляр конфигурации к новому экземпляру типа T. Если в этом разделе конфигурации есть значение, которое будет использоваться. В противном случае привязка путем сопоставления имен свойств с ключами конфигурации рекурсивно.
Get(IConfiguration, Type)	Пытается привязать экземпляр конфигурации к новому экземпляру типа T. Если в этом разделе конфигурации есть значение, которое будет использоваться. В противном случае привязка путем сопоставления имен свойств с ключами конфигурации рекурсивно.
Get<T>(IConfiguration, Action<BinderOptions>)	Пытается привязать экземпляр конфигурации к новому экземпляру типа T. Если в этом разделе конфигурации есть значение, которое будет использоваться. В противном случае привязка путем сопоставления имен свойств с ключами конфигурации рекурсивно.
Get<T>(IConfiguration)	Пытается привязать экземпляр конфигурации к новому экземпляру типа T. Если в этом разделе конфигурации есть значение, которое будет использоваться. В противном случае привязка путем сопоставления имен свойств с ключами конфигурации рекурсивно.
GetConnectionString(IConfiguration, String)	Возвращает указанный строка подключения из указанной конфигурации. Сокращение для `GetSection("ConnectionStrings")[name]`.
GetDebugView(IConfigurationRoot, Func<ConfigurationDebugViewContext,String>)	Создает удобочитаемое представление конфигурации, показывающее, откуда поступило каждое значение.
GetDebugView(IConfigurationRoot)	Создает удобочитаемое представление конфигурации, показывающее, откуда поступило каждое значение.
GetFileLoadExceptionHandler(IConfigurationBuilder)	Возвращает действие по умолчанию для поставщиков на основе файлов при возникновении ошибки.
GetFileProvider(IConfigurationBuilder)	Возвращает значение по умолчанию IFileProvider , используемое для поставщиков на основе файлов.
GetRequiredSection(IConfiguration, String)	Возвращает подраздел конфигурации с указанным ключом.
GetValue(IConfiguration, Type, String, Object)	Извлекает значение с указанным ключом и преобразует его в указанный тип.
GetValue(IConfiguration, Type, String)	Извлекает значение с указанным ключом и преобразует его в указанный тип.
GetValue<T>(IConfiguration, String, T)	Извлекает значение с указанным ключом и преобразует его в тип T.
GetValue<T>(IConfiguration, String)	Извлекает значение с указанным ключом и преобразует его в тип T.
SetBasePath(IConfigurationBuilder, String)	Задает FileProvider для поставщиков на основе файлов значение PhysicalFileProvider с базовым путем.
SetFileLoadExceptionHandler(IConfigurationBuilder, Action<FileLoadExceptionContext>)	Задает действие по умолчанию для поставщиков на основе файлов при возникновении ошибки.
SetFileProvider(IConfigurationBuilder, IFileProvider)	Задает значение по умолчанию IFileProvider , используемое для поставщиков на основе файлов.

Применяется к

Обратная связь

Были ли сведения на этой странице полезными?