This documentation is archived and is not being maintained.

AuditLevel Enumeration

Specifies when to audit security events.

Namespace:  System.ServiceModel
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

'Declaration
Public Enumeration AuditLevel
'Usage
Dim instance As AuditLevel

Member nameDescription
NoneNo events will be recorded. This is the default.
SuccessOnly successful security-related events will be recorded.
FailureOnly failed security-related events will be recorded.
SuccessOrFailureBoth failed and successful security-related events will be recorded.

When creating a Windows Communication Foundation (WCF) application that requires authentication and/or authorization of the callers, you can specify that events related to security be recorded for either success, failure, or both. The level of auditing is determined by this enumeration.

The location of the audit log is specified by setting the AuditLogLocation property of the ServiceSecurityAuditBehavior class to one of the AuditLogLocation values.

For more information about auditing, see Auditing Security Events.

You can also specify audit behavior using the serviceSecurityAudit element binding.

The following example sets the MessageAUthenticationAuditLevel and ServiceAuthorizationAuditLevel properties to one of the AuditLevel values.

Public Shared Sub Main() 
    ' Get base address from appsettings in configuration. 
    Dim baseAddress As New Uri(ConfigurationManager.AppSettings("baseAddress"))

    ' Create a ServiceHost for the CalculatorService type  
    ' and provide the base address. 
    Dim serviceHost As New ServiceHost(GetType(CalculatorService), baseAddress)
    Try 
        ' Create a new auditing behavior and set the log location. 
        Dim newAudit As New ServiceSecurityAuditBehavior()
        newAudit.AuditLogLocation = AuditLogLocation.Application
        newAudit.MessageAuthenticationAuditLevel = _
            AuditLevel.SuccessOrFailure
        newAudit.ServiceAuthorizationAuditLevel = _
            AuditLevel.SuccessOrFailure
        newAudit.SuppressAuditFailure = False 
        ' Remove the old behavior and add the new.
        serviceHost.Description.Behaviors.Remove(Of ServiceSecurityAuditBehavior)
        serviceHost.Description.Behaviors.Add(newAudit)
        ' Open the ServiceHostBase to create listeners  
        ' and start listening for messages.
        serviceHost.Open()

        ' The service can now be accessed.
        Console.WriteLine("The service is ready.")
        Console.WriteLine("Press <ENTER> to terminate service.")
        Console.WriteLine()
        Console.ReadLine()

        ' Close the ServiceHostBase to shutdown the service.
        serviceHost.Close()
    Finally 
    End Try 

End Sub

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Show: