ConfigurationBuilder Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Используется для создания параметров конфигурации на основе ключей и значений для использования в приложении.
public ref class ConfigurationBuilder : Microsoft::Extensions::Configuration::IConfigurationBuilder
public class ConfigurationBuilder : Microsoft.Extensions.Configuration.IConfigurationBuilder
type ConfigurationBuilder = class
interface IConfigurationBuilder
Public Class ConfigurationBuilder
Implements IConfigurationBuilder
- Наследование
-
ConfigurationBuilder
- Реализации
Комментарии
С помощью этого класса можно, например, хранить значения конфигурации в JSON-файле, а затем извлекать их во время выполнения. Дополнительные сведения см. в разделе Конфигурация — базовый пример.
Если вы переносите приложение на .NET Core 3.1 или более позднюю версию, этот класс можно использовать для замены функций файлаapp.config , которые вы могли использовать ранее для настройки приложения.
Пример
В следующем фрагменте кода показано упрощенное приложение, которое создает ConfigurationBuilder
объект для получения строкового значения из JSON-файла во время выполнения.
using Microsoft.Extensions.Configuration;
IConfigurationBuilder builder = new ConfigurationBuilder().AddJsonFile("appsettings.json", false, true);
IConfigurationRoot root = builder.Build();
Console.WriteLine($"Hello, { root["weather"] } world!");
/* This program outputs the following text:
*
* Hello, stormy world!
*/
Здесь показано содержимое JSON-файла.
{
"weather": "stormy"
}
Конструкторы
ConfigurationBuilder() |
Инициализирует новый экземпляр класса ConfigurationBuilder. |
Свойства
Properties |
Возвращает коллекцию ключей и значений, которую можно использовать для совместного IConfigurationBuilder использования данных между и зарегистрированным поставщиками конфигурации. |
Sources |
Возвращает источники, используемые для получения значений конфигурации. |
Методы
Add(IConfigurationSource) |
Добавляет новый источник конфигурации. |
Build() |
Создает IConfiguration с ключами и значениями на основе набора поставщиков, зарегистрированных в Sources. |
Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
GetType() |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
MemberwiseClone() |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
Методы расширения
AddApplicationMetadata(IConfigurationBuilder, IHostEnvironment, String) |
Регистрирует поставщик конфигурации для метаданных приложения. |
AddAzureKeyVault(IConfigurationBuilder, AzureKeyVaultConfigurationOptions) |
Добавляет поставщик IConfigurationProvider, считывающий значения конфигурации из Azure KeyVault. |
AddAzureKeyVault(IConfigurationBuilder, String) |
Добавляет поставщик IConfigurationProvider, считывающий значения конфигурации из Azure KeyVault. |
AddAzureKeyVault(IConfigurationBuilder, String, KeyVaultClient, IKeyVaultSecretManager) |
Добавляет поставщик IConfigurationProvider, считывающий значения конфигурации из Azure KeyVault. |
AddAzureKeyVault(IConfigurationBuilder, String, IKeyVaultSecretManager) |
Добавляет поставщик IConfigurationProvider, считывающий значения конфигурации из Azure KeyVault. |
AddAzureKeyVault(IConfigurationBuilder, String, String, X509Certificate2) |
Добавляет поставщик IConfigurationProvider, считывающий значения конфигурации из Azure KeyVault. |
AddAzureKeyVault(IConfigurationBuilder, String, String, X509Certificate2, IKeyVaultSecretManager) |
Добавляет поставщик IConfigurationProvider, считывающий значения конфигурации из Azure KeyVault. |
AddAzureKeyVault(IConfigurationBuilder, String, String, String) |
Добавляет поставщик IConfigurationProvider, считывающий значения конфигурации из Azure KeyVault. |
AddAzureKeyVault(IConfigurationBuilder, String, String, String, IKeyVaultSecretManager) |
Добавляет поставщик IConfigurationProvider, считывающий значения конфигурации из Azure KeyVault. |
AddConfiguration(IConfigurationBuilder, IConfiguration) |
Добавляет существующую конфигурацию в |
AddConfiguration(IConfigurationBuilder, IConfiguration, Boolean) |
Добавляет существующую конфигурацию в |
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>) |
Добавляет IConfigurationProvider, считывающий значения конфигурации из командной строки. |
AddCommandLine(IConfigurationBuilder, String[]) |
Добавляет CommandLineConfigurationProvider, считывающий значения конфигурации из командной строки. |
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>) |
Добавляет CommandLineConfigurationProvider, считывающий значения конфигурации из командной строки с использованием указанных сопоставлений переключений. |
Add<TSource>(IConfigurationBuilder, Action<TSource>) |
Добавляет новый источник конфигурации. |
AddUserSecrets(IConfigurationBuilder) |
Добавляет источник конфигурации для секретов пользователя. Ищет экземпляр UserSecretsIdAttribute в сборке из GetEntryAssembly(). |
AddUserSecrets(IConfigurationBuilder, Assembly) |
Добавляет источник конфигурации для секретов пользователя. |
AddUserSecrets(IConfigurationBuilder, String) |
Добавляет источник конфигурации секретов пользователя с указанным идентификатором секретов. |
AddUserSecrets<T>(IConfigurationBuilder) |
Добавляет источник конфигурации для секретов пользователя. Выполняет поиск экземпляра UserSecretsIdAttribute в сборке, содержащей |
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>>) |
Добавляет поставщик конфигурации памяти в |
AddNewtonsoftJsonFile(IConfigurationBuilder, IFileProvider, String, Boolean, Boolean) |
Добавляет источник конфигурации JSON в |
AddNewtonsoftJsonFile(IConfigurationBuilder, Action<NewtonsoftJsonConfigurationSource>) |
Добавляет источник конфигурации JSON в |
AddNewtonsoftJsonFile(IConfigurationBuilder, String) |
Добавляет поставщик конфигурации JSON по пути |
AddNewtonsoftJsonFile(IConfigurationBuilder, String, Boolean) |
Добавляет поставщик конфигурации JSON по пути |
AddNewtonsoftJsonFile(IConfigurationBuilder, String, Boolean, Boolean) |
Добавляет поставщик конфигурации JSON по пути |
AddNewtonsoftJsonStream(IConfigurationBuilder, Stream) |
Добавляет источник конфигурации Newtonsoft JSON в |
AddUserSecrets(IConfigurationBuilder, Assembly) |
Добавляет источник конфигурации для секретов пользователя. Выполняет поиск Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов. |
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean) |
Добавляет источник конфигурации для секретов пользователя. Выполняет поиск Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов. |
AddUserSecrets(IConfigurationBuilder, Assembly, Boolean, Boolean) |
Добавляет источник конфигурации для секретов пользователя. Выполняет поиск Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов. |
AddUserSecrets(IConfigurationBuilder, String) |
Добавляет источник конфигурации для секретов пользователя с указанным идентификатором секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов. |
AddUserSecrets(IConfigurationBuilder, String, Boolean) |
Добавляет источник конфигурации для секретов пользователя с указанным идентификатором секретов пользователя. Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов. |
AddUserSecrets<T>(IConfigurationBuilder) |
Добавляет источник конфигурации для секретов пользователя. Выполняет поиск экземпляра UserSecretsIdAttribute, который указывает идентификатор секретов пользователя, в сборке, содержащей Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов. |
AddUserSecrets<T>(IConfigurationBuilder, Boolean) |
Добавляет источник конфигурации для секретов пользователя. Выполняет поиск экземпляра UserSecretsIdAttribute, который указывает идентификатор секретов пользователя, в сборке, содержащей Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов. |
AddUserSecrets<T>(IConfigurationBuilder, Boolean, Boolean) |
Добавляет источник конфигурации для секретов пользователя. Выполняет поиск экземпляра UserSecretsIdAttribute, который указывает идентификатор секретов пользователя, в сборке, содержащей Идентификатор секретов пользователя — это уникальное значение, используемое для хранения и идентификации коллекции из значений конфигурации секретов. |
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 как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по