Operator Class

The Operator class represents a SQL Server Agent operator.

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.Operator

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

Syntax

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

The Operator type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property CategoryName Gets or sets the name of the category to which the operator belongs.
Public property EmailAddress Gets or sets the e-mail address of the referenced operator.
Public property Enabled Gets or sets the Boolean property value that specifies whether the operator is enabled or not.
Public property ID Gets the ID value that uniquely identifies the operator.
Public property LastEmailDate Gets the date and time when the operator last received an alert notification by e-mail.
Public property LastNetSendDate Gets the date and time when the operator last received an alert notification by net-send.
Public property LastPagerDate Gets the date and time when the operator last received an alert notification by pager.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property NetSendAddress Gets or sets an operator's net-send address.
Public property PagerAddress Gets or sets an operator's pager address.
Public property PagerDays Gets or sets the days of the week on which SQL Server Agent attempts to notify the referenced operator by pager.
Public property Parent Gets or sets the JobServer object that is the parent of the Operator object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property SaturdayPagerEndTime Gets or sets the latest time of day at which the referenced operator is available to receive alert notification by pager on Saturdays.
Public property SaturdayPagerStartTime Gets or sets the earliest time of day at which the referenced operator is available to receive alert notification by pager on Saturdays.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property SundayPagerEndTime Gets or sets the latest time of day at which the referenced operator is available to receive alert notification by pager on Sundays.
Public property SundayPagerStartTime Gets or sets the earliest time of day at which the referenced operator is available to receive alert notification by pager on Sundays.
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 WeekdayPagerEndTime Gets or sets the latest time of day at which the referenced operator is available to receive alert notification by pager on weekdays.
Public property WeekdayPagerStartTime Gets or sets the earliest time of day at which the referenced operator is available to receive alert notification by pager on weekdays.

Top

Methods

  Name Description
Public method AddNotification Assigns the referenced operator to an alert so that the operator is sent a notification when the specified alert is raised.
Public method Alter Updates any Operator object property changes on the instance of Microsoft SQL Server. 
Public method Create Creates an operator on the instance of Microsoft SQL Server as defined by the Operator object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the referenced operator.
Public method EnumJobNotifications Enumerates a list of notifications made by SQL Server Agent on completion of a job execution.
Public method EnumNotifications() Enumerates a list of notifications made by SQL Server Agent for job completion and for raised alerts.
Public method EnumNotifications(String) Enumerates a list of notifications made by SQL Server Agent for the specified alert.
Public method EnumNotifications(NotifyMethods) Enumerates a list of notifications made by SQL Server Agent for job completion and for raised alerts for a specified notification type.
Public method EnumNotifications(NotifyMethods, String) Enumerates a list of notifications made by SQL Server Agent for a specified alert and for a specified notification method.
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 RemoveNotification Removes the association between the referenced operator and a specified alert.
Public method Rename Renames the referenced operator.
Public method Script() Generates a Transact-SQL script that can be used to re-create the SQL Server Agent operator.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the SQL Server Agent operator 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 UpdateNotification Alters the notification method without dropping the association between an alert and an operator.
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

To get Operator object properties, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be a member of the sysadmin fixed server role.

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

To create or delete an operator, users must be a member of the sysadmin fixed server role.

To update notification for an operator, 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_operator (Transact-SQL)