FormsAuthenticationConfiguration 类

定义

命名空间:

System.Web.Configuration

程序集:

System.Web.dll

将 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

继承

Object

ConfigurationElement

FormsAuthenticationConfiguration

示例

下面的代码示例演示如何从现有 Web 应用程序的配置文件中获取 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 类提供了一种以编程方式访问和修改配置 authentication 节 forms 元素的方法。

此类型是包含 FormsAuthenticationCredentials、FormsAuthenticationUserCollection和 FormsAuthenticationUser 类型的组的一部分。 集合类型以外的类型直接影响基础配置标记。

警告

将用户凭据存储在 credentials 部分中 不安全。 请改用 Azure Key Vault。

注意

FormsAuthenticationConfiguration 可以根据节属性定义的限制将信息写入配置文件的相关部分，AllowDefinition 其值 MachineToApplication。 在层次结构中不允许的某个级别的配置文件中写入的任何尝试都将导致分析程序生成的错误消息。 但是，可以使用此类在层次结构中的任何级别读取配置信息。 为了获得安全性和可伸缩性，建议使用 Azure Key Vault 来存储用户凭据。

构造函数

FormsAuthenticationConfiguration()

初始化 FormsAuthenticationConfiguration 类的新实例。

属性

Cookieless	获取或设置一个值，该值指示基于表单的身份验证是否应使用 Cookie。
CookieSameSite	获取或设置 Cookie 的 SameSite 属性的值。
Credentials	获取用户名和密码的 FormsAuthenticationCredentials 集合。
CurrentConfiguration	获取对顶级 Configuration 实例的引用，该实例表示当前 ConfigurationElement 实例所属的配置层次结构。 (继承自 ConfigurationElement)
DefaultUrl	获取或设置默认 URL。
Domain	获取或设置要与表单身份验证 Cookie 一起发送的域名。
ElementInformation	获取一个 ElementInformation 对象，该对象包含 ConfigurationElement 对象的不可自定义信息和功能。 (继承自 ConfigurationElement)
ElementProperty	获取表示 ConfigurationElement 对象本身的 ConfigurationElementProperty 对象。 (继承自 ConfigurationElement)
EnableCrossAppRedirects	获取或设置一个值，该值指示经过身份验证的用户是否可以重定向到其他应用程序中的 URLS。
EvaluationContext	获取 ConfigurationElement 对象的 ContextInformation 对象。 (继承自 ConfigurationElement)
HasContext	获取一个值，该值指示 CurrentConfiguration 属性是否 null。 (继承自 ConfigurationElement)
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() 方法的值重置为 false。 (继承自 ConfigurationElement)
SerializeElement(XmlWriter, Boolean)	在派生类中实现时，将此配置元素的内容写入配置文件。 (继承自 ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)	在派生类中实现时，将此配置元素的外部标记写入配置文件。 (继承自 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)	将属性设置为指定的值。 (继承自 ConfigurationElement)
SetReadOnly()	设置 ConfigurationElement 对象和所有子元素的 IsReadOnly() 属性。 (继承自 ConfigurationElement)
ToString()	返回一个表示当前对象的字符串。 (继承自 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)	修改 ConfigurationElement 对象以删除不应保存的所有值。 (继承自 ConfigurationElement)