WebSuccessAuditEvent Class

.NET Framework (current version)

Provides information about successful security events.

Namespace: System.Web.Management
Assembly: System.Web (in System.Web.dll)

Inheritance Hierarchy

System.Object
System.Web.Management.WebBaseEvent
System.Web.Management.WebManagementEvent
System.Web.Management.WebAuditEvent
System.Web.Management.WebSuccessAuditEvent
System.Web.Management.WebAuthenticationSuccessAuditEvent

Syntax

C++

type WebSuccessAuditEvent = 
    class
        inherit WebAuditEvent
    end

Constructors

	Name	Description
	WebSuccessAuditEvent(String, Object, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the WebSuccessAuditEvent class using the supplied parameters.
	WebSuccessAuditEvent(String, Object, Int32, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the WebSuccessAuditEvent class using the supplied parameters.

Properties

	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.)
	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.)

Methods

	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(WebEventFormatter)	Provides standard formatting of the event information.(Inherited from WebBaseEvent.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	IncrementPerfCounters()	This API supports the product infrastructure and is not intended to be used directly from your code. Increments the Audit Success Events Raised performance counter.(Overrides WebBaseEvent.IncrementPerfCounters().)
	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 WebSuccessAuditEvent class is used when a successful security-related operation occurs. An example of this is a successful URL authorization for a Web request.

The following list describes the features for which events of type WebSuccessAuditEvent are raised by ASP.NET:

File Authorization. Successful conditions are audited. File authorization is only attempted by ASP.NET when a Windows Identity is associated with the request. The related event audit code is AuditFileAuthorizationSuccess.
URL Authorization. It signifies access of a URL resource for which authorization is granted. Successful conditions are audited. The related event audit code is AuditUrlAuthorizationSuccess.
Other security conditions. The following is a list of the related event codes:
- AuditFormsAuthenticationSuccess
- AuditMembershipAuthenticationSuccess

When a WebSuccessAuditEvent is raised, ASP.NET health monitoring increments the related Audit Success Events Raised performance counter and then checks the healthMonitoring configuration to determine whether any providers subscribe to the event. If providers subscribe to the event, ASP.NET dispatches the event to them for processing.

Note
To view the Audit Success Event Raised performance counter in System Monitor (PerfMon), in the Add Counters window select ASP.NET from the Performance object drop-down list, select the Audit Success Event Raised performance counter, and click the Add button. For more information, see Monitoring ASP.NET Application Performance.

Because success audits represent an expected condition, you may not want to subscribe to them. You can subscribe to them in order to provide access auditing for the site.

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 WebSuccessAuditEvent class, see the example provided in this topic.

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 WebSuccessAuditEvent class, see the example provided in this topic.

Examples

The following code example shows how to derive from the WebSuccessAuditEvent class to create a custom audit event.

No code example is currently available or this language may not be supported.

The following example is an excerpt of the configuration file that enables ASP.NET health monitoring to use the event.

<healthMonitoring 
..enabled="true"
..heartBeatInterval="0"> 
  <providers>
    <add name="EventLogProvider" 
    type="System.Web.Management.EventLogWebEventProvider,
    System.Web,Version=2.0.3600.0,Culture=neutral,
    PublicKeyToken=b03f5f7f11d50a3a"/>
  </providers>
  <eventMappings>
    <add  name="SampleWebSuccessAuditEvent" 
      type="SamplesAspNet.SampleWebSuccessAuditEvent,
      websuccessauditevent,Version=1.0.1663.31140, 
      Culture=neutral, 
      PublicKeyToken=0d1fa0f69d94de96, 
      processorArchitecture=MSIL"/>
  </eventMappings>
  <rules>
    <add name="Custom Failure Audit Default"
      eventName=" SampleWebFailureAuditEvent "
      provider="EventLogProvider"
      profile="Default"/>  
  </rules>
</healthMonitoring>

Version Information

.NET Framework
Available since 2.0

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.