Audit Class

The Audit object represents a SQL Server audit log.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.Audit

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Audit _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IAlterable, IDroppable, IRenamable,  _
    IScriptable, ISfcSupportsDesignMode
'Usage
Dim instance As Audit
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class Audit : ScriptNameObjectBase, 
    ICreatable, IAlterable, IDroppable, IRenamable, IScriptable, 
    ISfcSupportsDesignMode
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class Audit sealed : public ScriptNameObjectBase, 
    ICreatable, IAlterable, IDroppable, IRenamable, IScriptable, 
    ISfcSupportsDesignMode
[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type Audit =  
    class 
        inherit ScriptNameObjectBase 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IRenamable 
        interface IScriptable 
        interface ISfcSupportsDesignMode 
    end
public final class Audit extends ScriptNameObjectBase implements ICreatable, IAlterable, IDroppable, IRenamable, IScriptable, ISfcSupportsDesignMode

The Audit type exposes the following members.

Constructors

  Name Description
Public method Audit() Initializes a new instance of the Audit class.
Public method Audit(Server, String) Initializes a new instance of the Server class on the specified instance of SQL Server and with the specified name.

Top

Properties

  Name Description
Public property CreateDate Gets the date and time when the audit log was created.
Public property DateLastModified Gets the date and time when the audit log was last modified.
Public property DestinationType Gets or sets the type of destination to which the audit log information is recorded, such as a file, or an application log.
Public property Enabled Gets the Boolean value that specifies whether the referenced audit is enabled on the instance of SQL Server. 
Public property FileName Gets the name of the file in which the audit log information is recorded, when the audit destination is a file.
Public property FilePath Gets or sets the location of the folder where the audit file is stored when the audit type is a file.
Public property Filter Gets or sets the filter of the audit.
Public property Guid Gets or sets the unique system identifier for the referenced audit.
Public property ID Gets the integer value that uniquely identifies the audit.
Public property MaximumFiles Gets or sets the maximum files of the audit.
Public property MaximumFileSize Gets or sets the maximum size of the audit in megabytes.
Public property MaximumFileSizeUnit Gets or sets the maximum file size unit that an audit is allowed to reach.
Public property MaximumRolloverFiles Gets or sets the maximum number of rollover files allowed.
Public property Name Gets or sets the name of the Audit object. (Overrides NamedSmoObject.Name.)
Public property OnFailure Gets or sets the action taken when the audit fails.
Public property Parent Gets the Server object that is the parent of the Audit object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property QueueDelay Gets or sets the amount of time in milliseconds that can elapse before audit actions are processed.
Public property ReserveDiskSpace Gets or sets the Boolean property value that specifies whether disk space is reserved for the audit file.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any Audit object property changes on the instance of SQL Server. 
Public method Create Creates an audit on the instance of SQL Server as defined by the Audit object.
Public method Disable Disables the audit.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the audit from the instance of SQL Server.
Public method Enable Enables the audit.
Public method EnumDatabaseAuditSpecification Enumerates a list of databases and audit specifications defined by the audit.
Public method EnumServerAuditSpecification Returns the name of the referenced server audit specification.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Rename Changes the name of the audit to the specified string.
Public method Script() Generates a Transact-SQL script that can be used to re-create the audit.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the audit as specified by the script options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets or sets a property that specifies whether the object is open in design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

To get Audit object properties, users can be a member of the public fixed server role.

To set Audit object properties, users must have ALTER ANY SERVER AUDIT or CONTROL SERVER permission on the parent server.

To create or drop an audit log, users must have ALTER ANY SERVER AUDIT or CONTROL SERVER permission on the parent server.

Note

Any authenticated user can read and write to the Windows Application event log. The Application event log requires lower permissions than the Windows Security event log and is less secure than the Windows Security event log.

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.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace