WebFailureAuditEvent Class

.NET Framework (current version)

Provides information about security failures.

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.WebFailureAuditEvent
System.Web.Management.WebAuthenticationFailureAuditEvent
System.Web.Management.WebViewStateFailureAuditEvent

Syntax

C++

type WebFailureAuditEvent = 
    class
        inherit WebAuditEvent
    end

Constructors

	Name	Description
	WebFailureAuditEvent(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 WebFailureAuditEvent class using the supplied parameters.
	WebFailureAuditEvent(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 WebFailureAuditEvent 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 Failure 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 WebFailureAuditEvent class is used when a security operation fails. An example of this is a failed URL authorization for a Web request.

By default, ASP.NET is configured to raise the WebFailureAuditEvent event for the following features:

File authorization. ASP.NET attempts file authorization only when a Windows Identity is associated with the request. The related event audit code is AuditFileAuthorizationFailure.
URL authorization. This governs unauthorized attempts to access a URL resource. Failed attempts by an anonymous user are not audited, because anonymous authentication failure is acceptable in most circumstances. The related event audit code is AuditUrlAuthorizationFailure.
Generic unhandled or security unhandled conditions. The following is a list of the event codes related to these conditions:

When a WebFailureAuditEvent event is raised, ASP.NET health monitoring increments the related Audit Failure Events Raised performance counter and then checks the healthMonitoring configuration section 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 Failure Events 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 Failure Events Raised performance counter, and click the Add button. For more information, see Using the System Monitor (PerfMon) with ASP.NET Applications in the IIS documentation on MSDN.

Note

To view the Audit Failure Events 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 Failure Events Raised performance counter, and click the Add button. For more information, see Using the System Monitor (PerfMon) with ASP.NET Applications in the IIS documentation 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 WebFailureAuditEvent class, see the Example section.

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 WebFailureAuditEvent class, see the Example section.

Notes to Inheritors:

When formatting your custom event information for display, override the FormatCustomEventDetails method rather than the ToString method. This will avoid overwriting or tampering with sensitive system information.

Examples

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

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

The following configuration excerpt shows how to enable ASP.NET to use the WebFailureAuditEvent 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="SampleWebFailureAuditEvent" 
type="SamplesAspNet.SampleWebFailureAuditEvent,
webfailureauditevent,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.