ServerAuditSpecification Class
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 | |
---|---|---|
ServerAuditSpecification() | Initializes a new instance of the ServerAuditSpecification class. | |
ServerAuditSpecification(Server, String) | Initializes a new instance of the ServerAuditSpecification class on the specified server and with the specified name. |
Top
Properties
Name | Description | |
---|---|---|
AuditName | Gets the name of the server audit specification. | |
CreateDate | Gets the date and time when the server audit specification was created. | |
DateLastModified | Gets the date and time when the server audit specification was last modified. | |
Enabled | Gets or sets the Boolean value that specifies whether the server audit specification is enabled or not. | |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.) | |
Guid | Gets the Guid value that uniquely identifies the referenced server audit specification. | |
ID | Gets the ID value that uniquely identifies the referenced server audit specification. | |
IsTouched | Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.) | |
Name | Gets or sets the name of the object. (Inherited from NamedSmoObject.) | |
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.) | |
Parent | Specifies the Server object that is the parent of the ServerAuditSpecification object. | |
Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) | |
ScalarResult | Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.) | |
State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) | |
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.) | |
UserData | Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.) |
Top
Methods
Name | Description | |
---|---|---|
AddAuditSpecificationDetail(AuditSpecificationDetail) | Adds details to the existing audit specification provided by the specified AuditSpecificationDetail object. (Inherited from AuditSpecification.) | |
AddAuditSpecificationDetail(ICollection<AuditSpecificationDetail>) | An AuditSpecificationDetail object that specifies the details of the audit specification. (Inherited from AuditSpecification.) | |
AddDatabaseContext(StringCollection) | Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.) | |
AddDatabaseContext(StringCollection, ScriptingOptions) | Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options. (Inherited from SqlSmoObject.) | |
Alter | Updates any AuditSpecification object property changes on the instance of SQL Server. (Inherited from AuditSpecification.) | |
AlterImpl | Activates the object altered event. (Inherited from SqlSmoObject.) | |
AlterImplFinish | Method called when object altered event finishes. (Inherited from SqlSmoObject.) | |
AlterImplInit | Method called when object-altered event is intialized. (Inherited from SqlSmoObject.) | |
AlterImplWorker | Calls the Alter methods. (Inherited from SqlSmoObject.) | |
AppendCommaText | Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.) | |
AppendWithCommaText | Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.) | |
AppendWithOption | Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.) | |
AutoGenerateName | Generates a name based on the object Guid. (Inherited from ScriptNameObjectBase.) | |
BindDefaultImpl | Binds the default items identified by the parameters. (Inherited from SqlSmoObject.) | |
BindRuleImpl | Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.) | |
CheckCollation | Checks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.) | |
CheckObjectDirty | Checks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.) | |
CheckObjectState() | Validates the state of the referenced object. (Inherited from SqlSmoObject.) | |
CheckObjectState(Boolean) | Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.) | |
CheckObjectStateImpl | Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.) | |
CheckTextCorectness | Checks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.) | |
CheckTextModeSupport | Checks mode of support. (Inherited from ScriptNameObjectBase.) | |
CheckVersion100 | Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.) | |
CheckVersion80 | Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.) | |
CheckVersion80SP3 | Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.) | |
CheckVersion90 | Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.) | |
CheckVersionBelow90 | Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.) | |
CleanObject | Cleans the referenced object. (Inherited from ScriptNameObjectBase.) | |
Create | Creates an audit specification on the instance of SQL Server as defined by the AuditSpecification object. (Inherited from AuditSpecification.) | |
CreateImpl | Creates an object with scripting options. (Inherited from SqlSmoObject.) | |
CreateImplFinish | Method called when the create event finishes. (Inherited from SqlSmoObject.) | |
CreateImplInit | Method called when the create event initializes. (Inherited from SqlSmoObject.) | |
Disable | Disables the audit specification. (Inherited from AuditSpecification.) | |
Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) | |
Drop | Drops the audit specification. (Inherited from AuditSpecification.) | |
DropImpl | Drops a SqlSmoObject. (Inherited from SqlSmoObject.) | |
DropImplWorker | Calls the drop methods. (Inherited from SqlSmoObject.) | |
Enable | Enables the audit specification. (Inherited from AuditSpecification.) | |
EnumAuditSpecificationDetails | Enumerates the details of the audit specification in a collection of AuditSpecificationDetail objects. (Inherited from AuditSpecification.) | |
EnumScriptImpl | Enumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.) | |
EnumScriptImplWorker | Calls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.) | |
EnumScriptImplWorkerSOChanged | Returns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.) | |
Equals | (Inherited from Object.) | |
ExecuteNonQuery | Executes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.) | |
Finalize | (Inherited from Object.) | |
ForceTextModeOnTextBody | Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.) | |
FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) | |
GenerateDataSpaceFileStreamScript | Generates a script to create data file. (Inherited from SqlSmoObject.) | |
GenerateDataSpaceScript | Generates a script to allocate space in the data file. (Inherited from SqlSmoObject.) | |
GetBindDefaultScript | Gets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.) | |
GetBindRuleScript | Gets the script that specifies the binding rules. (Inherited from SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetBraketNameForText | Gets the bracket name. (Inherited from ScriptNameObjectBase.) | |
GetDateTimeParameter | Assigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetDateTimeParameterAsInt | Assigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.) | |
GetDBName | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) | |
GetEnumParameter | Assigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetFragOptionString | Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.) | |
GetGuidParameter | Assigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetHashCode | (Inherited from Object.) | |
GetIsSystemNamed | Gets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.) | |
GetIsTextDirty | Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
GetPropValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetPropValueOptional | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetRealValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetScriptIncludeExists | Gets the script including the test for existence of type being scripted. (Inherited from ScriptNameObjectBase.) | |
GetScriptingOptionsForCreate | Gets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetServerName | Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) | |
GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetSqlServerVersionName | Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetTextBody() | Returns the text body. (Inherited from ScriptNameObjectBase.) | |
GetTextBody(Boolean) | Returns the text body. (Inherited from ScriptNameObjectBase.) | |
GetTextForScript(ScriptingOptions, Boolean, array<String[]) | Gets the text for scripting. (Inherited from ScriptNameObjectBase.) | |
GetTextForScript(ScriptingOptions, Boolean, array<String[], Boolean) | Gets the text of script object. (Inherited from ScriptNameObjectBase.) | |
GetTextHeader | Returns the text header. (Inherited from ScriptNameObjectBase.) | |
GetTextMode | Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.) | |
GetTextProperty(String) | Gets the property as text. (Inherited from ScriptNameObjectBase.) | |
GetTextProperty(String, ScriptingOptions) | Gets the property as text. (Inherited from ScriptNameObjectBase.) | |
GetTimeSpanParameterAsInt | Assigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetType | (Inherited from Object.) | |
GetUrnRecursive(StringBuilder) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
ImplInitialize | Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.) | |
Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) | |
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) | |
IsObjectDirty | Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.) | |
IsObjectInitialized | Verifies whether the object has been initialized. (Inherited from SqlSmoObject.) | |
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.) | |
IsVersion80SP3 | Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.) | |
IsVersion90AndAbove | Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.) | |
MarkDropped | Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.) | |
MarkForDropImpl | Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.) | |
MemberwiseClone | (Inherited from Object.) | |
PostAlter | Method activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.) | |
PostCreate | Method activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.) | |
PostDrop | Method activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.) | |
Refresh | Refreshes the AuditSpecification object properties. (Inherited from AuditSpecification.) | |
RemoveAuditSpecificationDetail(AuditSpecificationDetail) | Removes a set of details from the existing audit specification provided by the specified AuditSpecificationDetail object. (Inherited from AuditSpecification.) | |
RemoveAuditSpecificationDetail(ICollection<AuditSpecificationDetail>) | Removes a set of details from the existing audit specification provided by the specified AuditSpecificationDetailCollection object. (Inherited from AuditSpecification.) | |
RenameImpl | Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.) | |
RenameImplWorker | Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.) | |
Script() | Generates a Transact-SQL script that can be used to re-create the audit specification. (Inherited from AuditSpecification.) | |
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.) | |
ScriptAlter | Alters an existing audit specification script. (Inherited from AuditSpecification.) | |
ScriptAnsiQI | Scripts the database object in ANSI text. (Inherited from ScriptNameObjectBase.) | |
ScriptChangeOwner | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) | |
ScriptCreate | Creates a new audit specification script. (Inherited from AuditSpecification.) | |
ScriptDdl | Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.) | |
ScriptDrop | Drops an existing audit specification script. (Inherited from AuditSpecification.) | |
ScriptImpl() | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
ScriptImpl(ScriptingOptions) | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
ScriptImplWorker | Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
ScriptInformativeHeaders | Scripts the information headers. (Inherited from ScriptNameObjectBase.) | |
ScriptOwner | Alters the script owner authorization. (Inherited from NamedSmoObject.) | |
ScriptRename | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.) | |
SetCollectionTextMode | Sets the collection text mode. (Inherited from ScriptNameObjectBase.) | |
SetIsSystemNamed | Sets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.) | |
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) | |
SetSchemaOwned | Sets the schema owned value. (Inherited from NamedSmoObject.) | |
SetTextBody | Specifies the text body. (Inherited from ScriptNameObjectBase.) | |
SetTextHeader | Specifies the text header. (Inherited from ScriptNameObjectBase.) | |
SetTextMode | Specifies the text mode. (Inherited from ScriptNameObjectBase.) | |
SwitchTextMode | Switches the text mode. (Inherited from ScriptNameObjectBase.) | |
ThrowIfTextIsDirtyForAlter | Throws an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.) | |
ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) | |
TouchImpl | Not implemented. (Inherited from SqlSmoObject.) | |
UnbindDefaultImpl | Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
UnbindRuleImpl | Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.) | |
Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
Top
Events
Name | Description | |
---|---|---|
PropertyChanged | Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.) | |
PropertyMetadataChanged | Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.) |
Top
Fields
Name | Description | |
---|---|---|
m_ExtendedProperties | Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.) | |
singletonParent | Represents the singleton parent. (Inherited from SqlSmoObject.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IAlienObject.Discover | Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) | |
IAlienObject.GetDomainRoot | Returns the root of the domain. (Inherited from SqlSmoObject.) | |
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.) | |
IAlienObject.GetPropertyType | Gets the type of the specified property. (Inherited from SqlSmoObject.) | |
IAlienObject.GetPropertyValue | Gets the value of the specified property. (Inherited from SqlSmoObject.) | |
IAlienObject.GetUrn | Gets the Unified Resource Name of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) | |
IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name of the object. (Inherited from SqlSmoObject.) | |
IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.) | |
IAlienObject.SetPropertyValue | Sets the property value. (Inherited from SqlSmoObject.) | |
ISfcPropertyProvider.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.) | |
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.