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


<PhysicalFacetAttribute>
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>
Public NotInheritable Class Audit
	Inherits ScriptNameObjectBase
	Implements ISfcSupportsDesignMode, ICreatable, IAlterable, IDroppable,
	IDropIfExists, IRenamable, IScriptable

NameDescription
System_CAPS_pubmethodAudit()

Initializes a new instance of the Audit class.

System_CAPS_pubmethodAudit(Server, String)

Initializes a new instance of the Server class on the specified instance of SQL Server and with the specified name.

NameDescription
System_CAPS_pubpropertyCreateDate

Gets the date and time when the audit log was created.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the audit log was last modified.

System_CAPS_pubpropertyDestinationType

Gets or sets the type of destination to which the audit log information is recorded, such as a file, or an application log.

System_CAPS_pubpropertyEnabled

Gets the Boolean value that specifies whether the referenced audit is enabled on the instance of SQL Server. 

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyFileName

Gets the name of the file in which the audit log information is recorded, when the audit destination is a file.

System_CAPS_pubpropertyFilePath

Gets or sets the location of the folder where the audit file is stored when the audit type is a file.

System_CAPS_pubpropertyFilter

Gets or sets the filter of the audit.

System_CAPS_pubpropertyGuid

Gets or sets the unique system identifier for the referenced audit.

System_CAPS_pubpropertyID

Gets the integer value that uniquely identifies the audit.

System_CAPS_pubpropertyMaximumFiles

Gets or sets the maximum files of the audit.

System_CAPS_pubpropertyMaximumFileSize

Gets or sets the maximum size of the audit in megabytes.

System_CAPS_pubpropertyMaximumFileSizeUnit

Gets or sets the maximum file size unit that an audit is allowed to reach.

System_CAPS_pubpropertyMaximumRolloverFiles

Gets or sets the maximum number of rollover files allowed.

System_CAPS_pubpropertyName

Gets or sets the name of the Audit object.(Overrides NamedSmoObject.Name.)

System_CAPS_pubpropertyOnFailure

Gets or sets the action taken when the audit fails.

System_CAPS_pubpropertyParent

Gets the Server object that is the parent of the Audit object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyQueueDelay

Gets or sets the amount of time in milliseconds that can elapse before audit actions are processed.

System_CAPS_pubpropertyReserveDiskSpace

Gets or sets the Boolean property value that specifies whether disk space is reserved for the audit file.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any Audit object property changes on the instance of SQL Server. 

System_CAPS_pubmethodCreate()

Creates an audit on the instance of SQL Server as defined by the Audit object.

System_CAPS_pubmethodDisable()

Disables the audit.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the audit from the instance of SQL Server.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnable()

Enables the audit.

System_CAPS_pubmethodEnumDatabaseAuditSpecification()

Enumerates a list of databases and audit specifications defined by the audit.

System_CAPS_pubmethodEnumServerAuditSpecification()

Returns the name of the referenced server audit specification.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodRename(String)

Changes the name of the audit to the specified string.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the audit.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the audit as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object())

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

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

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode.IsDesignMode

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.

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

Return to top
Show:
© 2016 Microsoft