WebAuthenticationSuccessAuditEvent Class
Provides information about successful authentication events
System.Web.Management::WebBaseEvent
System.Web.Management::WebManagementEvent
System.Web.Management::WebAuditEvent
System.Web.Management::WebSuccessAuditEvent
System.Web.Management::WebAuthenticationSuccessAuditEvent
Assembly: System.Web (in System.Web.dll)
The WebAuthenticationSuccessAuditEvent type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | WebAuthenticationSuccessAuditEvent(String, Object, Int32, String) | Infrastructure. Initializes the WebAuthenticationSuccessAuditEvent class using the supplied parameters. |
![]() | WebAuthenticationSuccessAuditEvent(String, Object, Int32, Int32, String) | Initializes the WebSuccessAuditEvent class using the supplied parameters. |
| Name | Description | |
|---|---|---|
![]() | EventCode | Gets the code value associated with the event. (Inherited from WebBaseEvent.) |
![]() | EventDetailCode | Gets the event detail code. (Inherited from WebBaseEvent.) |
![]() | EventID | Gets the identifier associated with the event. (Inherited from WebBaseEvent.) |
![]() | EventOccurrence | Gets a counter that represents the number of times the event has occurred. (Inherited from WebBaseEvent.) |
![]() | EventSequence | Gets the number of times the event has been raised by the application. (Inherited from WebBaseEvent.) |
![]() | EventSource | Gets the object that raises the event. (Inherited from WebBaseEvent.) |
![]() | EventTime | Gets the time when the event was raised. (Inherited from WebBaseEvent.) |
![]() | EventTimeUtc | Gets the time when the event was raised. (Inherited from WebBaseEvent.) |
![]() | Message | Gets the message that describes the event. (Inherited from WebBaseEvent.) |
![]() | NameToAuthenticate | Gets the name of the authenticated user. |
![]() | ProcessInformation | Gets information about the ASP.NET application-hosting process. (Inherited from WebManagementEvent.) |
![]() | RequestInformation | Get the information associated with the Web request. (Inherited from WebAuditEvent.) |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | FormatCustomEventDetails | Provides standard formatting of the event information. (Inherited from WebBaseEvent.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | IncrementPerfCounters | Infrastructure. Increments the Audit Success Events Raised performance counter. (Inherited from WebSuccessAuditEvent.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | Raise() | Raises an event by notifying any configured provider that the event has occurred. (Inherited from WebBaseEvent.) |
![]() | ToString() | Formats event information for display purposes. (Inherited from WebBaseEvent.) |
![]() | ToString(Boolean, Boolean) | Formats event information for display purposes. (Inherited from WebBaseEvent.) |
ASP.NET health monitoring allows production and operations staff to manage deployed Web applications. The System.Web.Management namespace contains the health-event types responsible for packaging application health-status data and the provider types responsible for processing this data. It also contains supporting types that help during the management of health events.
The following list describes the features for which ASP.NET raises events of type WebAuthenticationSuccessAuditEvent.
Note |
|---|
By default ASP.NET is configured to log audit failure conditions only, as logging success conditions can severely strain system resources. You can always configure the system to log the success conditions. |
Forms Authentication. Successful conditions are audited. Success audits include the user name that was authenticated. Instead, failure audits do not include the user name, since they typically result from a ticket that failed decryption or validation. Both contain the client IP address. The related event audit code is AuditFormsAuthenticationSuccess.
Membership. Successful conditions are audited. Both success and failure audits contain the username that was attempted. Neither form of audit will contain the password that was attempted, because that would risk persisting a valid password in the log. The related event audit code is AuditMembershipAuthenticationSuccess.
When a WebAuthenticationSuccessAuditEvent is raised, by default it updates the Authentication Success Events Raised performance counter. To view this performance counter in System Monitor (PerfMon), in the Add Counters window select ASP.NET in the Performance object drop-down list, select the Authentication Success Events Raised performance counter, and click the Add button. For more information, see Using the System Monitor (PerfMon) with ASP.NET Applications on MSDN.
Note |
|---|
In most cases you will be able to use the ASP.NET health-monitoring types as implemented, and you will control the health-monitoring system by specifying values in the healthMonitoring configuration section. You can also derive from the health-monitoring types to create your own custom events and providers. For an example of deriving from the WebBaseEvent class, see the example provided in this topic. |
This code example has two parts: a configuration-file excerpt, followed by code that shows how to customize the WebAuthenticationSuccessAuditEvent event.
This following is an excerpt of the configuration file's provider and eventMappings sections. They are already set by default. The only thing you need to do is to provide the setup for the rules element in the healthMonitoring section.
<healthMonitoring
enabled="true"
heartBeatInterval="0">
<providers>
// Configure the provider to process
// the health events.
<add name="EventLogProvider"
type="System.Web.Management.EventLogWebEventProvider,
System.Web,Version=2.0.3600.0,Culture=neutral,
PublicKeyToken=b03f5f7f11d50a3a"/>
</providers>
<eventMappings>
<clear />
// Configure the custom event
// to handle the audit events.
<add name="SampleWebAuthenticationSuccessAuditEvent"
type="SamplesAspNet.SampleWebAuthenticationSuccessAuditEvent,
webauthsuccessaudit, Version=1.0.1735.23144, Culture=neutral,
PublicKeyToken=dd969eda3f3f6ae1, processorArchitecture=MSIL" />
</eventMappings>
<rules>
<clear/>
// Establish the connection between custom event
// and the provider that must process it.
<add name="Log Authentication Success Audits"
eventName="SampleWebAuthenticationFailureAuditEvent"
provider="EventLogProvider"
profile="Custom" />\
</rules>
</healthMonitoring>
The following code shows how to customize the WebAuthenticationSuccessAuditEvent event.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.



Note