Share via

ServerAuditSpecification Class

  • Article

The ServerAuditSpecification object represents an auditable event on the instance of SQL Server.

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.AuditSpecification
            Microsoft.SqlServer.Management.Smo.ServerAuditSpecification

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class ServerAuditSpecification _
    Inherits AuditSpecification _
    Implements ISfcSupportsDesignMode
'Usage
Dim instance As ServerAuditSpecification

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class ServerAuditSpecification : AuditSpecification, 
    ISfcSupportsDesignMode

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class ServerAuditSpecification sealed : public AuditSpecification, 
    ISfcSupportsDesignMode

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type ServerAuditSpecification =  
    class 
        inherit AuditSpecification 
        interface ISfcSupportsDesignMode 
    end

public final class ServerAuditSpecification extends AuditSpecification implements ISfcSupportsDesignMode

The ServerAuditSpecification type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property AuditName Gets the name of the server audit specification.
Public property CreateDate Gets the date and time when the server audit specification was created.
Public property DateLastModified Gets the date and time when the server audit specification was last modified.
Public property Enabled Gets or sets the Boolean value that specifies whether the server audit specification is enabled or not.
Public property Guid Gets the Guid value that uniquely identifies the referenced server audit specification.
Public property ID Gets the ID value that uniquely identifies the referenced server audit specification.
Public property Name Gets or sets the name of the AuditSpecification object. (Inherited from AuditSpecification.)
Public property Parent Specifies the Server object that is the parent of the ServerAuditSpecification object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
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 AddAuditSpecificationDetail(AuditSpecificationDetail) Adds details to the existing audit specification provided by the specified AuditSpecificationDetail object. (Inherited from AuditSpecification.)
Public method AddAuditSpecificationDetail(ICollection<AuditSpecificationDetail>) An AuditSpecificationDetail object that specifies the details of the audit specification. (Inherited from AuditSpecification.)
Public method Alter Updates any AuditSpecification object property changes on the instance of SQL Server. (Inherited from AuditSpecification.)
Public method Create Creates an audit specification on the instance of SQL Server as defined by the AuditSpecification object. (Inherited from AuditSpecification.)
Public method Disable Disables the audit specification. (Inherited from AuditSpecification.)
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops the audit specification. (Inherited from AuditSpecification.)
Public method Enable Enables the audit specification. (Inherited from AuditSpecification.)
Public method EnumAuditSpecificationDetails Enumerates the details of the audit specification in a collection of AuditSpecificationDetail objects. (Inherited from AuditSpecification.)
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 AuditSpecification object properties. (Inherited from AuditSpecification.)
Public method RemoveAuditSpecificationDetail(AuditSpecificationDetail) Removes a set of details from the existing audit specification provided by the specified AuditSpecificationDetail object. (Inherited from AuditSpecification.)
Public method RemoveAuditSpecificationDetail(ICollection<AuditSpecificationDetail>) Removes a set of details from the existing audit specification provided by the specified AuditSpecificationDetailCollection object. (Inherited from AuditSpecification.)
Public method Script() Generates a Transact-SQL script that can be used to re-create the audit specification. (Inherited from AuditSpecification.)
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the audit specification as specified by the script options. (Inherited from AuditSpecification.)
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 a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

The ServerAuditSpecification object represents information that is stored in the sys.server_audit_specifications system table.

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