Export (0) Print
Expand All

Audit Class

The Audit object represents a SQL Server audit log.

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

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class Audit : ScriptNameObjectBase, 
	ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable, IRenamable, 
	IScriptable

The Audit type exposes the following members.

  NameDescription
Public methodAudit()Initializes a new instance of the Audit class.
Public methodAudit(Server, String)Initializes a new instance of the Server class on the specified instance of SQL Server and with the specified name.
Top

  NameDescription
Public propertyCreateDateGets the date and time when the audit log was created.
Public propertyDateLastModifiedGets the date and time when the audit log was last modified.
Public propertyDestinationTypeGets or sets the type of destination to which the audit log information is recorded, such as a file, or an application log.
Public propertyEnabledGets the Boolean value that specifies whether the referenced audit is enabled on the instance of SQL Server. 
Public propertyFileNameGets the name of the file in which the audit log information is recorded, when the audit destination is a file.
Public propertyFilePathGets or sets the location of the folder where the audit file is stored when the audit type is a file.
Public propertyFilterGets or sets the filter of the audit.
Public propertyGuidGets or sets the unique system identifier for the referenced audit.
Public propertyIDGets the integer value that uniquely identifies the audit.
Public propertyMaximumFilesGets or sets the maximum files of the audit.
Public propertyMaximumFileSizeGets or sets the maximum size of the audit in megabytes.
Public propertyMaximumFileSizeUnitGets or sets the maximum file size unit that an audit is allowed to reach.
Public propertyMaximumRolloverFilesGets or sets the maximum number of rollover files allowed.
Public propertyNameGets or sets the name of the Audit object. (Overrides NamedSmoObject.Name.)
Public propertyOnFailureGets or sets the action taken when the audit fails.
Public propertyParentGets the Server object that is the parent of the Audit object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyQueueDelayGets or sets the amount of time in milliseconds that can elapse before audit actions are processed.
Public propertyReserveDiskSpaceGets or sets the Boolean property value that specifies whether disk space is reserved for the audit file.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any Audit object property changes on the instance of SQL Server. 
Public methodCreateCreates an audit on the instance of SQL Server as defined by the Audit object.
Public methodDisableDisables the audit.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the audit from the instance of SQL Server.
Public methodEnableEnables the audit.
Public methodEnumDatabaseAuditSpecificationEnumerates a list of databases and audit specifications defined by the audit.
Public methodEnumServerAuditSpecificationReturns the name of the referenced server audit specification.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Public methodRenameChanges the name of the audit to the specified string.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the audit.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the audit as specified by the script options.
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode.IsDesignModeGets 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

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.

NoteNote

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft