Export (0) Print
Expand All

Operator Class

 

Applies To: SQL Server 2016 Preview

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

NameDescription
System_CAPS_pubmethodOperator()

Initializes a new instance of the Operator class.

System_CAPS_pubmethodOperator(JobServer, String)

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

NameDescription
System_CAPS_pubpropertyCategoryName

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

System_CAPS_pubpropertyEmailAddress

Gets or sets the e-mail address of the referenced operator.

System_CAPS_pubpropertyEnabled

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

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the operator.

System_CAPS_pubpropertyLastEmailDate

Gets the date and time when the operator last received an alert notification by e-mail.

System_CAPS_pubpropertyLastNetSendDate

Gets the date and time when the operator last received an alert notification by net-send.

System_CAPS_pubpropertyLastPagerDate

Gets the date and time when the operator last received an alert notification by pager.

System_CAPS_pubpropertyName

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

System_CAPS_pubpropertyNetSendAddress

Gets or sets an operator's net-send address.

System_CAPS_pubpropertyPagerAddress

Gets or sets an operator's pager address.

System_CAPS_pubpropertyPagerDays

Gets or sets the days of the week on which SQL Server Agent attempts to notify the referenced operator by pager.

System_CAPS_pubpropertyParent

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

System_CAPS_pubpropertyProperties

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

System_CAPS_pubpropertySaturdayPagerEndTime

Gets or sets the latest time of day at which the referenced operator is available to receive alert notification by pager on Saturdays.

System_CAPS_pubpropertySaturdayPagerStartTime

Gets or sets the earliest time of day at which the referenced operator is available to receive alert notification by pager on Saturdays.

System_CAPS_pubpropertyState

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

System_CAPS_pubpropertySundayPagerEndTime

Gets or sets the latest time of day at which the referenced operator is available to receive alert notification by pager on Sundays.

System_CAPS_pubpropertySundayPagerStartTime

Gets or sets the earliest time of day at which the referenced operator is available to receive alert notification by pager on Sundays.

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_pubpropertyWeekdayPagerEndTime

Gets or sets the latest time of day at which the referenced operator is available to receive alert notification by pager on weekdays.

System_CAPS_pubpropertyWeekdayPagerStartTime

Gets or sets the earliest time of day at which the referenced operator is available to receive alert notification by pager on weekdays.

NameDescription
System_CAPS_pubmethodAddNotification(String, NotifyMethods)

Assigns the referenced operator to an alert so that the operator is sent a notification when the specified alert is raised.

System_CAPS_pubmethodAlter()

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

System_CAPS_pubmethodCreate()

Creates an operator on the instance of Microsoft SQL Server as defined by the Operator object.

System_CAPS_pubmethodDiscover()

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

System_CAPS_pubmethodDrop()

Removes the referenced operator.

System_CAPS_pubmethodEnumJobNotifications()

Enumerates a list of notifications made by SQL Server Agent on completion of a job execution.

System_CAPS_pubmethodEnumNotifications()

Enumerates a list of notifications made by SQL Server Agent for job completion and for raised alerts.

System_CAPS_pubmethodEnumNotifications(NotifyMethods)

Enumerates a list of notifications made by SQL Server Agent for job completion and for raised alerts for a specified notification type.

System_CAPS_pubmethodEnumNotifications(NotifyMethods, String)

Enumerates a list of notifications made by SQL Server Agent for a specified alert and for a specified notification method.

System_CAPS_pubmethodEnumNotifications(String)

Enumerates a list of notifications made by SQL Server Agent for the specified alert.

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 association between the referenced operator and a specified alert.

System_CAPS_pubmethodRename(String)

Renames the referenced operator.

System_CAPS_pubmethodScript()

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

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the SQL Server Agent operator 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)

Alters the notification method without dropping the association between an alert and an operator.

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

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