Export (0) Print
Expand All

Alert Class

 

The Alert class represents a Microsoft SQL Server Agent alert.

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


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

NameDescription
System_CAPS_pubmethodAlert()

Initializes a new instance of the Alert class.

System_CAPS_pubmethodAlert(JobServer, String)

Initializes a new instance of the Alert class on the specified instance of SQL Server Agent and with the specified name

NameDescription
System_CAPS_pubpropertyAlertType

Gets the AlertType object value that specifies the type of alert.

System_CAPS_pubpropertyCategoryName

Gets or sets the name of the category to which the alert belongs.

System_CAPS_pubpropertyCountResetDate

Gets or sets the date on which to reset the alert occurrence count back to zero.

System_CAPS_pubpropertyDatabaseName

Gets or sets the name of the database that the alert is monitoring.

System_CAPS_pubpropertyDelayBetweenResponses

Gets or sets the delay between responses in seconds.

System_CAPS_pubpropertyEventDescriptionKeyword

Gets or sets a word or phrase that must appear in the text of an event message that causes the alert to be raised.

System_CAPS_pubpropertyEventSource

Gets the event source text from the application event log.

System_CAPS_pubpropertyHasNotification

Gets the number of SQL Server Agent operators that are assigned to receive notification when the alert is fired.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies SQL Server Agent.

System_CAPS_pubpropertyIncludeEventDescription

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.

System_CAPS_pubpropertyIsEnabled

Gets or sets the Boolean property value that specifies whether the alert is enabled or not.

System_CAPS_pubpropertyJobID

Gets or sets the ID value of the SQL Server Agent job that is run in response to the alert being raised.

System_CAPS_pubpropertyJobName

Gets or sets the name of the SQL Server Agent job that is run in response to the alert being raised.

System_CAPS_pubpropertyLastOccurrenceDate

Gets or sets the date on which the alert was last raised.

System_CAPS_pubpropertyLastResponseDate

Gets or sets the date on which the alert last generated a response.

System_CAPS_pubpropertyMessageID

Gets or sets the ID value of the Microsoft SQL Server message that causes the alert to be raised.

System_CAPS_pubpropertyName

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubpropertyNotificationMessage

Gets or sets the user-supplied text appended to any notification sent in response to an alert being raised.

System_CAPS_pubpropertyOccurrenceCount

Gets the number of times the alert has fired since the alert was enabled or since a specified date.

System_CAPS_pubpropertyParent

Gets or sets the JobServer object that is the parent of the Alert object.

System_CAPS_pubpropertyPerformanceCondition

Gets or sets the performance condition text.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertySeverity

Gets or sets the error message severity level that causes the alert to be raised.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyWmiEventNamespace

Gets or sets the Windows Management Instrumentation (WMI) namespace for the event.

System_CAPS_pubpropertyWmiEventQuery

Gets or sets the Windows Management Instrumentation (WMI) query for the event.

NameDescription
System_CAPS_pubmethodAddNotification(String, NotifyMethods)

Designates an operator that receives a notification message when the alert is raised.

System_CAPS_pubmethodAlter()

Updates any Alert object property changes on instance of Microsoft SQL Server .

System_CAPS_pubmethodCreate()

Creates an alert on the instance of Microsoft SQL Server as defined by the Alert object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the alert.

System_CAPS_pubmethodEnumNotifications()

Enumerates a list of all notifications defined on the alert.

System_CAPS_pubmethodEnumNotifications(NotifyMethods)

Enumerates a list of notification methods defined on the alert that are restricted to the specified notification methods.

System_CAPS_pubmethodEnumNotifications(NotifyMethods, String)

Enumerates a list of notification methods defined on the alert that are restricted to the specified notification methods and a specified operator.

System_CAPS_pubmethodEnumNotifications(String)

Enumerates a list of notification methods defined on the alert that are restricted to the specified operator.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from AgentObjectBase.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRemoveNotification(String)

Removes the notification of an operator from the alert definition.

System_CAPS_pubmethodRename(String)

Renames the alert.

System_CAPS_pubmethodResetOccurrenceCount()

Resets the alert occurrence count back to zero.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent alert.

System_CAPS_pubmethodScript(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.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodUpdateNotification(String, NotifyMethods)

Changes the notification method associated with an operator for the alert.

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.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.)

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.

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.

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

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft