Alert Class

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

'Declaration
Public NotInheritable Class Alert _
    Inherits AgentObjectBase _
    Implements ICreatable, IDroppable, IAlterable, IRenamable,  _
    IScriptable
'Usage
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
	Alert()	Initializes a new instance of the Alert class.
	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
	AlertType	Gets the AlertType object value that specifies the type of alert.
	CategoryName	Gets or sets the name of the category to which the alert belongs.
	CountResetDate	Gets or sets the date on which to reset the alert occurrence count back to zero.
	DatabaseName	Gets or sets the name of the database that the alert is monitoring.
	DelayBetweenResponses	Gets or sets the delay between responses in seconds.
	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.
	EventSource	Gets the event source text from the application event log.
	HasNotification	Gets the number of SQL Server Agent operators that are assigned to receive notification when the alert is fired.
	ID	Gets the ID value that uniquely identifies SQL Server Agent.
	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.
	IsEnabled	Gets or sets the Boolean property value that specifies whether the alert is enabled or not.
	JobID	Gets or sets the ID value of the SQL Server Agent job that is run in response to the alert being raised.
	JobName	Gets or sets the name of the SQL Server Agent job that is run in response to the alert being raised.
	LastOccurrenceDate	Gets or sets the date on which the alert was last raised.
	LastResponseDate	Gets or sets the date on which the alert last generated a response.
	MessageID	Gets or sets the ID value of the Microsoft SQL Server message that causes the alert to be raised.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	NotificationMessage	Gets or sets the user-supplied text appended to any notification sent in response to an alert being raised.
	OccurrenceCount	Gets the number of times the alert has fired since the alert was enabled or since a specified date.
	Parent	Gets or sets the JobServer object that is the parent of the Alert object.
	PerformanceCondition	Gets or sets the performance condition text.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	Severity	Gets or sets the error message severity level that causes the alert to be raised.
	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.)
	WmiEventNamespace	Gets or sets the Windows Management Instrumentation (WMI) namespace for the event.
	WmiEventQuery	Gets or sets the Windows Management Instrumentation (WMI) query for the event.

Top

Methods

	Name	Description
	AddNotification	Designates an operator that receives a notification message when the alert is raised.
	Alter	Updates any Alert object property changes on instance of Microsoft SQL Server .
	Create	Creates an alert on the instance of Microsoft SQL Server as defined by the Alert object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the alert.
	EnumNotifications()	Enumerates a list of all notifications defined on the alert.
	EnumNotifications(String)	Enumerates a list of notification methods defined on the alert that are restricted to the specified operator.
	EnumNotifications(NotifyMethods)	Enumerates a list of notification methods defined on the alert that are restricted to the specified notification methods.
	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.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from AgentObjectBase.)
	GetHashCode	(Inherited from Object.)
	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.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	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.)
	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.)
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	RemoveNotification	Removes the notification of an operator from the alert definition.
	Rename	Renames the alert.
	ResetOccurrenceCount	Resets the alert occurrence count back to zero.
	Script()	Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent alert.
	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.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	UpdateNotification	Changes the notification method associated with an operator for the alert.
	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

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 (URN) 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 (URN) 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. (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)