FormsAuthenticationConfiguration Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Настраивает приложение ASP.NET для использования модальности форм AuthenticationMode.
public ref class FormsAuthenticationConfiguration sealed : System::Configuration::ConfigurationElement
public sealed class FormsAuthenticationConfiguration : System.Configuration.ConfigurationElement
type FormsAuthenticationConfiguration = class
inherit ConfigurationElement
Public NotInheritable Class FormsAuthenticationConfiguration
Inherits ConfigurationElement
- Наследование
Примеры
В следующем примере кода показано, как получить FormsAuthenticationConfiguration объект из файла конфигурации существующего веб-приложения. Этот объект можно использовать для доступа к его членам.
// Get the Web application configuration.
System.Configuration.Configuration configuration =
WebConfigurationManager.OpenWebConfiguration("/aspnetTest");
// Get the external Authentication section.
AuthenticationSection authenticationSection =
(AuthenticationSection)configuration.GetSection(
"system.web/authentication");
// Get the external Forms section .
FormsAuthenticationConfiguration formsAuthentication =
authenticationSection.Forms;
' Get the Web application configuration.
Dim configuration As System.Configuration.Configuration =
WebConfigurationManager.OpenWebConfiguration(
"/aspnetTest")
' Get the external Authentication section.
Dim authenticationSection _
As AuthenticationSection =
CType(configuration.GetSection(
"system.web/authentication"), AuthenticationSection)
' Get the external Forms section .
Dim formsAuthentication _
As FormsAuthenticationConfiguration =
authenticationSection.Forms
Комментарии
Класс FormsAuthenticationConfiguration предоставляет способ программного доступа и изменения forms элемента раздела конфигурации authentication .
Этот тип является частью группы, включающей FormsAuthenticationCredentialsFormsAuthenticationUserCollectionтипы и FormsAuthenticationUser типы. Типы, отличные от типа коллекции, напрямую влияют на базовые теги конфигурации.
Предупреждение
Хранение учетных данных пользователя в разделе credentialsнебезопасным. Вместо этого используйте Azure Key Vault.
Note
Данные FormsAuthenticationConfiguration могут записываться в соответствующий раздел файла конфигурации в соответствии с ограничениями, определенными свойством AllowDefinition раздела, значение которого равно MachineToApplication. Любая попытка записи в файл конфигурации на уровне, запрещенном в иерархии, приведет к возникновению сообщения об ошибке, созданного средством синтаксического анализа. Однако этот класс можно использовать для чтения сведений о конфигурации на любом уровне иерархии. Для обеспечения безопасности и масштабируемости рекомендуется использовать Azure Key Vault для хранения учетных данных пользователя.
Конструкторы
| Имя | Описание |
|---|---|
| FormsAuthenticationConfiguration() |
Инициализирует новый экземпляр класса FormsAuthenticationConfiguration. |
Свойства
| Имя | Описание |
|---|---|
| Cookieless |
Возвращает или задает значение, указывающее, должна ли проверка подлинности на основе форм использовать файлы cookie. |
| CookieSameSite |
Возвращает или задает значение атрибута SameSite файла cookie. |
| Credentials |
Возвращает коллекцию FormsAuthenticationCredentials имен пользователей и паролей. |
| CurrentConfiguration |
Возвращает ссылку на экземпляр верхнего уровня Configuration , представляющий иерархию конфигурации, к которой принадлежит текущий ConfigurationElement экземпляр. (Унаследовано от ConfigurationElement) |
| DefaultUrl |
Возвращает или задает URL-адрес по умолчанию. |
| Domain |
Возвращает или задает доменное имя для отправки с помощью файлов cookie проверки подлинности форм. |
| ElementInformation |
ElementInformation Возвращает объект, содержащий не настраиваемую информацию и функциональные возможности ConfigurationElement объекта. (Унаследовано от ConfigurationElement) |
| ElementProperty |
ConfigurationElementProperty Возвращает объект, представляющий ConfigurationElement сам объект. (Унаследовано от ConfigurationElement) |
| EnableCrossAppRedirects |
Получает или задает значение, указывающее, можно ли перенаправить прошедших проверку подлинности пользователей на URLS в других приложениях. |
| EvaluationContext |
Возвращает объект ContextInformation для объекта ConfigurationElement. (Унаследовано от ConfigurationElement) |
| HasContext |
Возвращает значение, указывающее, является CurrentConfigurationли |
| Item[ConfigurationProperty] |
Возвращает или задает свойство или атрибут этого элемента конфигурации. (Унаследовано от ConfigurationElement) |
| Item[String] |
Возвращает или задает свойство, атрибут или дочерний элемент этого элемента конфигурации. (Унаследовано от ConfigurationElement) |
| LockAllAttributesExcept |
Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement) |
| LockAllElementsExcept |
Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement) |
| LockAttributes |
Возвращает коллекцию заблокированных атрибутов. (Унаследовано от ConfigurationElement) |
| LockElements |
Возвращает коллекцию заблокированных элементов. (Унаследовано от ConfigurationElement) |
| LockItem |
Возвращает или задает значение, указывающее, заблокирован ли элемент. (Унаследовано от ConfigurationElement) |
| LoginUrl |
Возвращает или задает URL-адрес перенаправления для запроса. |
| Name |
Возвращает или задает имя файла cookie. |
| Path |
Возвращает или задает путь к файлу cookie. |
| Properties |
Возвращает коллекцию свойств. (Унаследовано от ConfigurationElement) |
| Protection |
Возвращает или задает тип шифрования, используемый для шифрования файла cookie. |
| RequireSSL |
Возвращает или задает значение, указывающее, требуется ли подключение уровня SSL при передаче сведений о проверке подлинности. |
| SlidingExpiration |
Возвращает или задает срок действия скольжения проверки подлинности. |
| TicketCompatibilityMode |
Возвращает или задает значение, указывающее, следует ли использовать универсальное время (UTC) или местное время окончания срока действия билета. |
| Timeout |
Возвращает или задает время ожидания проверки подлинности. |
Методы
| Имя | Описание |
|---|---|
| DeserializeElement(XmlReader, Boolean) |
Считывает XML из файла конфигурации. (Унаследовано от ConfigurationElement) |
| Equals(Object) |
Сравнивает текущий ConfigurationElement экземпляр с указанным объектом. (Унаследовано от ConfigurationElement) |
| GetHashCode() |
Возвращает уникальное значение, представляющее текущий ConfigurationElement экземпляр. (Унаследовано от ConfigurationElement) |
| GetTransformedAssemblyString(String) |
Возвращает преобразованную версию указанного имени сборки. (Унаследовано от ConfigurationElement) |
| GetTransformedTypeString(String) |
Возвращает преобразованную версию указанного имени типа. (Унаследовано от ConfigurationElement) |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| Init() |
Задает объект исходному ConfigurationElement состоянию. (Унаследовано от ConfigurationElement) |
| InitializeDefault() |
Используется для инициализации набора значений по умолчанию для ConfigurationElement объекта. (Унаследовано от ConfigurationElement) |
| IsModified() |
Указывает, был ли изменен этот элемент конфигурации после последнего сохранения или загрузки при реализации в производном классе. (Унаследовано от ConfigurationElement) |
| IsReadOnly() |
Возвращает значение, указывающее, доступен ли ConfigurationElement объект только для чтения. (Унаследовано от ConfigurationElement) |
| ListErrors(IList) |
Добавляет ошибки недопустимого свойства в этом ConfigurationElement объекте и во все подэлементы в переданный список. (Унаследовано от ConfigurationElement) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
Возвращает значение, указывающее, обнаружен ли неизвестный атрибут во время десериализации. (Унаследовано от ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
Возвращает значение, указывающее, обнаружен ли неизвестный элемент во время десериализации. (Унаследовано от ConfigurationElement) |
| OnRequiredPropertyNotFound(String) |
Создает исключение, если обязательное свойство не найдено. (Унаследовано от ConfigurationElement) |
| PostDeserialize() |
Вызывается после десериализации. (Унаследовано от ConfigurationElement) |
| PreSerialize(XmlWriter) |
Вызывается перед сериализацией. (Унаследовано от ConfigurationElement) |
| Reset(ConfigurationElement) |
Сбрасывает внутреннее состояние ConfigurationElement объекта, включая блокировки и коллекции свойств. (Унаследовано от ConfigurationElement) |
| ResetModified() |
Сбрасывает значение IsModified() метода |
| SerializeElement(XmlWriter, Boolean) |
Записывает содержимое этого элемента конфигурации в файл конфигурации при реализации в производном классе. (Унаследовано от ConfigurationElement) |
| SerializeToXmlElement(XmlWriter, String) |
Записывает внешние теги этого элемента конфигурации в файл конфигурации при реализации в производном классе. (Унаследовано от ConfigurationElement) |
| SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Задает свойству указанное значение. (Унаследовано от ConfigurationElement) |
| SetReadOnly() |
IsReadOnly() Задает свойство для ConfigurationElement объекта и всех вложенных элементов. (Унаследовано от ConfigurationElement) |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Изменяет объект для удаления всех значений ConfigurationElement , которые не должны быть сохранены. (Унаследовано от ConfigurationElement) |