Alert Members
The Alert class represents a Microsoft SQL Server Agent alert.
The following tables list the members exposed by the Alert type.
Public Constructors
| Name | Description | |
|---|---|---|
| Alert | Overloaded. Initializes a new instance of the Alert class. |
Top
Protected Fields
| Name | Description | |
|---|---|---|
.gif "ms219102.protfield(en-US,SQL.90).gif") |
m_ExtendedProperties | (inherited from SqlSmoObject ) |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "ms219102.pubproperty(en-US,SQL.90).gif") |
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
Protected Properties
| Name | Description | |
|---|---|---|
.gif "ms219102.protproperty(en-US,SQL.90).gif") |
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject) |
|
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject) |
|
PresetProperties | Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject) |
|
ScalarResult | Gets the scalar result for the referenced object. (inherited from SqlSmoObject) |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms219102.pubmethod(en-US,SQL.90).gif") |
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. |
|
Drop | Removes the alert. |
|
EnumNotifications | Overloaded. Enumerates a list of all notifications defined on the alert. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
Initialize | Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject) |
.gif "ms219102.static(en-US,SQL.90).gif") |
ReferenceEquals | (inherited from Object ) |
|
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 | Overloaded. Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent alert. |
|
ToString | Returns a String that represents the referenced object. (inherited from SqlSmoObject) |
|
UpdateNotification | Changes the notification method associated with an operator for the alert. |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms219102.protmethod(en-US,SQL.90).gif") |
AlterImpl | (inherited from SqlSmoObject ) |
|
AlterImplFinish | (inherited from SqlSmoObject ) |
|
AlterImplInit | (inherited from SqlSmoObject ) |
|
AlterImplWorker | (inherited from SqlSmoObject ) |
|
BindDefaultImpl | (inherited from SqlSmoObject ) |
|
BindRuleImpl | (inherited from SqlSmoObject ) |
|
CheckCollation | (inherited from SqlSmoObject ) |
|
CheckObjectState | Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject) |
|
CheckObjectStateImpl | (inherited from SqlSmoObject ) |
|
CheckVersion80 | Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject) |
|
CheckVersion80SP3 | Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject) |
|
CheckVersion90 | Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject) |
|
CheckVersionBelow90 | (inherited from SqlSmoObject ) |
|
CleanObject | (inherited from SqlSmoObject ) |
|
CreateImpl | (inherited from SqlSmoObject ) |
|
CreateImplFinish | (inherited from SqlSmoObject ) |
|
CreateImplInit | (inherited from SqlSmoObject ) |
|
DropImpl | (inherited from SqlSmoObject ) |
|
DropImplWorker | (inherited from SqlSmoObject ) |
|
Finalize | (inherited from Object ) |
|
FormatSqlVariant | (inherited from SqlSmoObject ) |
|
GenerateDataSpaceScript | (inherited from SqlSmoObject ) |
|
GetBindDefaultScript | (inherited from SqlSmoObject ) |
|
GetBindRuleScript | (inherited from SqlSmoObject ) |
|
GetBoolParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetDateTimeParameter | (inherited from SqlSmoObject ) |
|
GetDateTimeParameterAsInt | (inherited from SqlSmoObject ) |
|
GetDBName | Gets the database name that is associated with the object. (inherited from AgentObjectBase) |
|
GetEnumParameter | (inherited from SqlSmoObject ) |
|
GetFragOptionString | (inherited from SqlSmoObject ) |
|
GetGuidParameter | (inherited from SqlSmoObject ) |
|
GetParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetPropValue | (inherited from SqlSmoObject ) |
|
GetPropValueOptional | (inherited from SqlSmoObject ) |
|
GetPropValueOptionalAllowNull | (inherited from SqlSmoObject ) |
|
GetRealValue | (inherited from SqlSmoObject ) |
|
GetScriptingOptionsForCreate | (inherited from SqlSmoObject ) |
|
GetServerName | Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetSqlServerVersionName | Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) |
|
GetStringParameter | Overloaded. (inherited from SqlSmoObject ) |
|
GetTimeSpanParameterAsInt | (inherited from SqlSmoObject ) |
|
GetUrnRecursive | Overloaded. (inherited from SqlSmoObject ) |
|
ImplInitialize | (inherited from SqlSmoObject ) |
|
IsCollectionDirty | (inherited from SqlSmoObject ) |
|
IsObjectDirty | Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of Microsoft SQL Server. (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 Microsoft SQL Server. (inherited from SqlSmoObject) |
|
IsVersion80SP3 | (inherited from SqlSmoObject ) |
|
MarkDropped | (inherited from SqlSmoObject ) |
|
MarkForDropImpl | (inherited from SqlSmoObject ) |
|
MemberwiseClone | (inherited from Object ) |
|
PostAlter | (inherited from SqlSmoObject ) |
|
PostCreate | (inherited from SqlSmoObject ) |
|
PostDrop | (inherited from SqlSmoObject ) |
|
RenameImpl | (inherited from NamedSmoObject ) |
|
RenameImplWorker | (inherited from NamedSmoObject ) |
|
ScriptAlter | (inherited from SqlSmoObject ) |
|
ScriptChangeOwner | (inherited from NamedSmoObject ) |
|
ScriptCreate | (inherited from SqlSmoObject ) |
|
ScriptDdl | (inherited from SqlSmoObject ) |
|
ScriptDrop | (inherited from SqlSmoObject ) |
|
ScriptImpl | Overloaded. (inherited from SqlSmoObject ) |
|
ScriptImplWorker | (inherited from SqlSmoObject ) |
|
ScriptRename | (inherited from NamedSmoObject ) |
|
SetParentImpl | (inherited from SqlSmoObject ) |
|
Trace | (inherited from SqlSmoObject ) |
|
UnbindDefaultImpl | (inherited from SqlSmoObject ) |
|
UnbindRuleImpl | (inherited from SqlSmoObject ) |
|
UpdateCollectionState2 | (inherited from SqlSmoObject ) |
Top
See Also
Reference
Alert Class
Microsoft.SqlServer.Management.Smo.Agent Namespace
Other Resources
Scheduling Automatic Administrative Tasks in SQL Server Agent
Automating Administrative Tasks (SQL Server Agent)
sp_add_alert (Transact-SQL)