AlertSystem Class

The AlertSystem class contains system information pertaining to all alerts defined on the instance of Microsoft 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.Agent.AgentObjectBase
          Microsoft.SqlServer.Management.Smo.Agent.AlertSystem

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

Syntax

'Declaration
Public NotInheritable Class AlertSystem _
    Inherits AgentObjectBase _
    Implements IAlterable, IScriptable
'Usage
Dim instance As AlertSystem
public sealed class AlertSystem : AgentObjectBase, 
    IAlterable, IScriptable
public ref class AlertSystem sealed : public AgentObjectBase, 
    IAlterable, IScriptable
[<SealedAttribute>]
type AlertSystem =  
    class 
        inherit AgentObjectBase 
        interface IAlterable 
        interface IScriptable 
    end
public final class AlertSystem extends AgentObjectBase implements IAlterable, IScriptable

The AlertSystem type exposes the following members.

Properties

  Name Description
Public property FailSafeEmailAddress Gets or sets an e-mail address to notify when no operator is defined or available on alert notification.
Public property FailSafeNetSendAddress Gets or sets a net send address to notify when no operator is defined or available on alert notification.
Public property FailSafeOperator Gets or sets the operator to notify when no other operator is defined or available on the alert notification.
Public property FailSafePagerAddress Gets or sets a pager address to notify when no operator is defined or available on alert notification.
Public property ForwardingServer Gets or sets the instance of Microsoft SQL Server that will receive forwarded events.
Public property ForwardingSeverity Gets or sets the minimum severity level of error event that is to be forwarded to another instance of SQL Server.
Public property IsForwardedAlways Gets or sets the Boolean property value that specifies whether all events are forwarded to the forwarding server or only those that have no event notification defined on the current instance of SQL Server.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property NotificationMethod Gets or sets the notification method used to notify the fail-safe operator.
Public property PagerCCTemplate Gets or sets the template text sent in the e-mail Cc: line in the e-mail sent by SQL Server Agent for pager notifications.
Public property PagerSendSubjectOnly Gets or sets the Boolean property value that specifies whether to include the e-mail Message: text in the e-mail sent by SQL Server Agent for pager notifications.
Public property PagerSubjectTemplate Gets or sets the template text sent in the e-mail Subject: line in the e-mail sent by SQL Server Agent for pager notifications.
Public property PagerToTemplate Gets or sets the template text sent in the e-mail To: line in the e-mail sent by SQL Server Agent for pager notifications.
Public property Parent Gets the JobServer object value that is the parent of the AlertSystem object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
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.)

Top

Methods

  Name Description
Public method Alter Updates any AlertSystem object property changes on an instance of SQL Server. 
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (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.)
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 GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
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 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.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method Script() Generates a Transact-SQL script that can be used to re-create the set of information represented by the AlertSystem object.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the set of information represented by the AlertSystem object and as specified by the scripting options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
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

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

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

Automated Administration Tasks (SQL Server Agent)

sp_add_alert (Transact-SQL)