Aracılığıyla paylaş

Alert Class

  • Makale

The Alert class represents a Microsoft SQL Server Agent alert.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.Agent.AgentObjectBase
          Microsoft.SqlServer.Management.Smo.Agent.Alert

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

Syntax

'Bildirim
Public NotInheritable Class Alert _
    Inherits AgentObjectBase _
    Implements ICreatable, IDroppable, IAlterable, IRenamable,  _
    IScriptable
'Kullanım
Dim instance As Alert

public sealed class Alert : AgentObjectBase, 
    ICreatable, IDroppable, IAlterable, IRenamable, IScriptable

public ref class Alert sealed : public AgentObjectBase, 
    ICreatable, IDroppable, IAlterable, IRenamable, IScriptable

[<SealedAttribute>]
type Alert =  
    class
        inherit AgentObjectBase
        interface ICreatable
        interface IDroppable
        interface IAlterable
        interface IRenamable
        interface IScriptable
    end

public final class Alert extends AgentObjectBase implements ICreatable, IDroppable, IAlterable, IRenamable, IScriptable

The Alert type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property AlertType Gets the AlertType object value that specifies the type of alert.
Public property CategoryName Gets or sets the name of the category to which the alert belongs.
Public property CountResetDate Gets or sets the date on which to reset the alert occurrence count back to zero.
Public property DatabaseName Gets or sets the name of the database that the alert is monitoring.
Public property DelayBetweenResponses Gets or sets the delay between responses in seconds.
Public property EventDescriptionKeyword Gets or sets a word or phrase that must appear in the text of an event message that causes the alert to be raised.
Public property EventSource Gets the event source text from the application event log.
Protected property ExecuteForScalar Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Public property HasNotification Gets the number of SQL Server Agent operators that are assigned to receive notification when the alert is fired.
Public property ID Gets the ID value that uniquely identifies SQL Server Agent.
Public property IncludeEventDescription Gets or sets the NotifyMethods object value that specifies the types of notification methods (e-mail, pager, or net send) that can contain alert error text.
Public property IsEnabled Gets or sets the Boolean property value that specifies whether the alert is enabled or not.
Protected property 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.)
Public property JobID Gets or sets the ID value of the SQL Server Agent job that is run in response to the alert being raised.
Public property JobName Gets or sets the name of the SQL Server Agent job that is run in response to the alert being raised.
Public property LastOccurrenceDate Gets or sets the date on which the alert was last raised.
Public property LastResponseDate Gets or sets the date on which the alert last generated a response.
Public property MessageID Gets or sets the ID value of the Microsoft SQL Server message that causes the alert to be raised.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property NotificationMessage Gets or sets the user-supplied text appended to any notification sent in response to an alert being raised.
Protected property 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.)
Public property OccurrenceCount Gets the number of times the alert has fired since the alert was enabled or since a specified date.
Public property Parent Gets or sets the JobServer object that is the parent of the Alert object.
Public property PerformanceCondition Gets or sets the performance condition text.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Protected property ScalarResult Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public property Severity Gets or sets the error message severity level that causes the alert to be raised.
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.)
Public property WmiEventNamespace Gets or sets the Windows Management Instrumentation (WMI) namespace for the event.
Public property WmiEventQuery Gets or sets the Windows Management Instrumentation (WMI) query for the event.

Top

Methods

  Name Description
Protected method AddDatabaseContext Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Public method AddNotification Designates an operator that receives a notification message when the alert is raised.
Public method Alter Updates any Alert object property changes on instance of Microsoft SQL Server .
Protected method AlterImpl Activates the object altered event. (Inherited from SqlSmoObject.)
Protected method AlterImplWorker Calls the Alter methods. (Inherited from SqlSmoObject.)
Protected method BindDefaultImpl Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
Protected method BindRuleImpl Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Protected method CheckObjectState() Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected method 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.)
Protected method CheckObjectStateImpl Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method CheckVersion100 Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected method CheckVersion110() Checks whether version of SQL Server is SQL Server 2012. (Inherited from SqlSmoObject.)
Protected method CheckVersion110(String) Checks whether the version of SQL Server is SQL Server 2012 with the specified name. (Inherited from SqlSmoObject.)
Protected method CheckVersion80 Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected method CheckVersion80SP3 Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected method CheckVersion90 Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow110 Checks whether version of SQL Server is before SQL Server 2012. (Inherited from SqlSmoObject.)
Protected method CheckVersionBelow90 Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected method CleanObject Sets the object to its unmodified state. (Inherited from SqlSmoObject.)
Public method Create Creates an alert on the instance of Microsoft SQL Server as defined by the Alert object.
Protected method CreateImpl Creates an object with scripting options. (Inherited from SqlSmoObject.)
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the alert.
Protected method DropImpl Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method DropImplWorker Calls the drop methods. (Inherited from SqlSmoObject.)
Public method EnumNotifications() Enumerates a list of all notifications defined on the alert.
Public method EnumNotifications(String) Enumerates a list of notification methods defined on the alert that are restricted to the specified operator.
Public method EnumNotifications(NotifyMethods) Enumerates a list of notification methods defined on the alert that are restricted to the specified notification methods.
Public method EnumNotifications(NotifyMethods, String) Enumerates a list of notification methods defined on the alert that are restricted to the specified notification methods and a specified operator.
Public method Equals (Inherited from Object.)
Protected method ExecuteNonQuery Executes a batch of statements that does not return a result set. (Inherited from SqlSmoObject.)
Protected method ExecuteRenameQuery Executes the rename query for the object. (Inherited from NamedSmoObject.)
Protected method Finalize (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GenerateAlterEvent() Generates the alter event with the specified value. (Inherited from SqlSmoObject.)
Protected method GenerateAlterEvent(Urn, Object) Generates alter event with the specified URN and inner object value. (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 AgentObjectBase.)
Protected method GetFragOptionString Gets a FragmentationOption object as a string value. (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 GetRealValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerName Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetSqlServerVersionName Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Protected method GetUrnRecursive(StringBuilder) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetUrnRecursive(StringBuilder, UrnIdOption) Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method ImplInitialize Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
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 IsObjectDirty Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (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.)
Protected method IsVersion80SP3 Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected method IsVersion90AndAbove Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Protected method MarkDropped Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected method MarkForDropImpl Sets the SqlSmoState for drop operation. (Inherited from SqlSmoObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method PostAlter The method that is activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected method PostCreate The method that is activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected method PostDrop The method that is activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method RemoveNotification Removes the notification of an operator from the alert definition.
Public method Rename Renames the alert.
Protected method RenameImpl This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
Protected method RenameImplWorker Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
Public method ResetOccurrenceCount Resets the alert occurrence count back to zero.
Public method Script() Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent alert.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent alert as specified by the scripting options.
Protected method ScriptImpl() Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method ScriptImpl(ScriptingOptions) Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Protected method SetSchemaOwned Sets the schema owned value. (Inherited from NamedSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected method TouchImpl Not implemented. (Inherited from SqlSmoObject.)
Protected method UnbindDefaultImpl Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected method UnbindRuleImpl Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public method UpdateNotification Changes the notification method associated with an operator for the alert.
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

Fields

  Name Description
Protected field m_ExtendedProperties Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected field singletonParent Represents the singleton parent. (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.)

Top

Remarks

To get or set Alert object properties, users must be a member of the sysadmin fixed server role.

To create or drop an Alert users must be a member of the sysadmin fixed server role.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Examples

Scheduling Automatic Administrative Tasks in SQL Server Agent

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.Agent Namespace

Other Resources

Scheduling Automatic Administrative Tasks in SQL Server Agent

Automated Administration Tasks (SQL Server Agent)

sp_add_alert (Transact-SQL)