Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Operator Class

The Operator class represents a SQL Server Agent operator.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
public sealed class Operator : AgentObjectBase, 
	ICreatable, IDroppable, IAlterable, IRenamable, IScriptable

The Operator type exposes the following members.

  NameDescription
Public methodOperator()Initializes a new instance of the Operator class.
Public methodOperator(JobServer, String)Initializes a new instance of the Operator class on the specified SQL Server Agent and with the specified name.
Top
  NameDescription
Public propertyCategoryNameGets or sets the name of the category to which the operator belongs.
Public propertyEmailAddressGets or sets the e-mail address of the referenced operator.
Public propertyEnabledGets or sets the Boolean property value that specifies whether the operator is enabled or not.
Public propertyIDGets the ID value that uniquely identifies the operator.
Public propertyLastEmailDateGets the date and time when the operator last received an alert notification by e-mail.
Public propertyLastNetSendDateGets the date and time when the operator last received an alert notification by net-send.
Public propertyLastPagerDateGets the date and time when the operator last received an alert notification by pager.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyNetSendAddressGets or sets an operator's net-send address.
Public propertyPagerAddressGets or sets an operator's pager address.
Public propertyPagerDaysGets or sets the days of the week on which SQL Server Agent attempts to notify the referenced operator by pager.
Public propertyParentGets or sets the JobServer object that is the parent of the Operator object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertySaturdayPagerEndTimeGets or sets the latest time of day at which the referenced operator is available to receive alert notification by pager on Saturdays.
Public propertySaturdayPagerStartTimeGets or sets the earliest time of day at which the referenced operator is available to receive alert notification by pager on Saturdays.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertySundayPagerEndTimeGets or sets the latest time of day at which the referenced operator is available to receive alert notification by pager on Sundays.
Public propertySundayPagerStartTimeGets or sets the earliest time of day at which the referenced operator is available to receive alert notification by pager on Sundays.
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public propertyWeekdayPagerEndTimeGets or sets the latest time of day at which the referenced operator is available to receive alert notification by pager on weekdays.
Public propertyWeekdayPagerStartTimeGets or sets the earliest time of day at which the referenced operator is available to receive alert notification by pager on weekdays.
Top
  NameDescription
Public methodAddNotificationAssigns the referenced operator to an alert so that the operator is sent a notification when the specified alert is raised.
Public methodAlterUpdates any Operator object property changes on the instance of Microsoft SQL Server. 
Public methodCreateCreates an operator on the instance of Microsoft SQL Server as defined by the Operator object.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the referenced operator.
Public methodEnumJobNotificationsEnumerates a list of notifications made by SQL Server Agent on completion of a job execution.
Public methodEnumNotifications()Enumerates a list of notifications made by SQL Server Agent for job completion and for raised alerts.
Public methodEnumNotifications(String)Enumerates a list of notifications made by SQL Server Agent for the specified alert.
Public methodEnumNotifications(NotifyMethods)Enumerates a list of notifications made by SQL Server Agent for job completion and for raised alerts for a specified notification type.
Public methodEnumNotifications(NotifyMethods, String)Enumerates a list of notifications made by SQL Server Agent for a specified alert and for a specified notification method.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from AgentObjectBase.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public methodRemoveNotificationRemoves the association between the referenced operator and a specified alert.
Public methodRenameRenames the referenced operator.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the SQL Server Agent operator.
Public methodScript(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 methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodUpdateNotificationAlters the notification method without dropping the association between an alert and an operator.
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top
  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top
  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets 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 methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.