Microsoft.SqlServer.Management.Smo.Agent Namespace
The Microsoft.SqlServer.Management.Smo.Agent namespace contains classes that represent the Microsoft SQL Server Agent.
Updated text:17 July 2006
The Microsoft.SqlServer.Management.Smo.Agent namespace represents the SQL Server Agent. After a connection to an instance of SQL Server has been established by using the Server object variable, you can use the objects in the Microsoft.SqlServer.Management.Smo.Agent namespace to manage the SQL Server Agent.
The Microsoft.SqlServer.Management.Smo.Agent namespace resides in the Microsoft.SqlServer.Sm.dll assembly file. Also, some of the enumeration classes are in the Microsoft.SqlServer.SqlEnum.dll and Microsoft.SqlServer.SmoEnum.dll assembly files. You will have to import all three files to access the classes in the Microsoft.SqlServer.Management.Smo.Agent namespace.
By using the Microsoft.SqlServer.Management.Smo.Agent namespace, you can do the following:
View and modify SQL Server Agent settings.
Set up and manage operators.
Set up and manage alerts based on system messages or performance conditions.
Set up and manage jobs with multiple steps and schedules.
Manage proxy accounts for the subsystems on which jobs run.
Manage jobs that run on multiple servers.
Release |
History |
17 July 2006 |
Changed content:
|
Classes
| Class | Description |
|---|---|
| AgentObjectBase | The AgentObjectBase class is a base class that is inherited by all the SQL Server Agent classes and contains common members. |
| Alert | The Alert class represents a Microsoft SQL Server Agent alert. |
| AlertCategory | The AlertCategory class contains attributes that allow alerts to be categorized. |
| AlertCategoryCollection | The AlertCategoryCollection class represents a collection of AlertCategory objects that represent all the categories defined on the parent object. |
| AlertCollection | The AlertCollection class represents a collection of Alert objects that represent all the alerts defined on the parent object. |
| AlertSystem | The AlertSystem class contains system information pertaining to all alerts defined on the instance of Microsoft SQL Server. |
| CategoryBase | The CategoryBase class is a base class that is used in the construction of the JobCategory class, the OperatorCategory class, and the AlertCategory class. It contains functionality that is common to all three category classes. |
| Job | The Job class represents a Microsoft SQL Server Agent job. |
| JobBaseCollection | The JobBaseCollection class represents a collection of Agent objects. The JobBaseCollection object is a base class that is inherited by the Agent collection classes. |
| JobCategory | The JobCategory class contains attributes that allow alerts to be categorized. |
| JobCategoryCollection | The JobCategoryCollection class represents a collection of JobCategory objects that represent all the categories defined on the parent object. |
| JobCollection | The JobCollection class represents a collection of Job objects that represent all the jobs defined on the JobServer object. |
| JobFilter | The JobFilter object is used to store information about the constraints applied to the EnumJobs method of the JobServer object. |
| JobHistoryFilter | The JobHistoryFilter object is used to store information about the constraints applied to the EnumJobHistory method of the JobServer object. |
| JobSchedule | The JobSchedule class represents a SQL Server Agent job schedule. |
| JobScheduleCollection | The JobScheduleCollection class represents a collection of JobSchedule objects that represent all the job schedules defined on the parent object. |
| JobServer | The JobServer object represents the Microsoft SQL Server Agent subsystem and the MSDB database. |
| JobStep | The JobStep class represents a Microsoft SQL Server job step. |
| JobStepCollection | The JobStepCollection class represents a collection of JobStep objects that represent all the job steps defined on the parent Job object. |
| Operator | The Operator class represents a SQL Server Agent operator. |
| OperatorCategory | The OperatorCategory class contains attributes that allow operators to be categorized. |
| OperatorCategoryCollection | The OperatorCategoryCollection class represents a collection of OperatorCategory objects that represent all the categories defined on the parent object. |
| OperatorCollection | The OperatorCollection class represents a collection of Operator objects that represent all the operators defined on the JobServer object. |
| ProxyAccount | The ProxyAccount class represents a SQL Server Agent proxy account. |
| ProxyAccountCollection | The ProxyAccountCollection class represents a collection of ProxyAccount objects that represent all the proxy accounts defined on SQL Server Agent. |
| ScheduleBase | The ScheduleBase class is a base class that is inherited by the JobSchedule class. |
| TargetServer | The TargetServer object represents a target server defined for multiserver administration on SQL Server Agent. |
| TargetServerCollection | The TargetServerCollection class represents a collection of TargetServer objects that represent all the target servers defined on SQL Server Agent. |
| TargetServerGroup | The TargetServerGroup object that represent a target server group defined for multiserver administration on SQL Server Agent. |
| TargetServerGroupCollection | The TargetServerGroupCollection class represents a collection of TargetServerGroup objects that represent all the target server groups defined on SQL Server Agent. |
Enumerations
| Enumeration | Description |
|---|---|
| ActivationOrder | The ActivationOrder enumeration contains values that are used to specify when the trigger runs in relation to the insert, update, or delete operation. |
| AgentLogLevels | The AgentLogLevels enumeration contains values that are used to specify the type of errors or messages that are logged by SQL Server Agent. This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. |
| AgentMailType | The AgentMailType enumeration contains values that are used to specify the source of mail. |
| AgentSubSystem | The AgentSubSystem enumeration contains values that are used to specify the Microsoft SQL Server subsystems that can be used by job steps. |
| AlertType | The AlertType enumeration contains values that are used to specify the type of event or performance condition that causes alerts to be raised. |
| CategoryType | The CategoryType enumeration is a list of constant values that specify the type of category, such as whether the category refers to local jobs or multiserver administration. |
| CompletionAction | The CompletionAction enumeration is a list of constant values that specify the circumstances when a job completes after which another action is executed. |
| CompletionResult | The CompletionResult enumeration is a list of constant values that specify the status on completion of a job or job step. |
| FindOperand | The FindOperand enumeration represents a list of operands that are used to evaluate the DateJobCreated and DateJobLastModified properties to specify a range of dates in a job filter. |
| FrequencyRelativeIntervals | The FrequencyRelativeIntervals enumeration contains values that are used to specify the ordinal position of a recurring occurrence within a specified period. |
| FrequencySubDayTypes | The FrequencySubDayTypes enumeration contains values that are used to specify the way in which scheduling is managed within the period of a day. |
| FrequencyTypes | The FrequencyTypes enumeration contains values that are used to specify how often a schedule is executed. |
| JobExecutionStatus | The JobExecutionStatus enumeration is a list of constant values that specify the execution status of a job or job step. |
| JobOutcome | The JobOutcome enumeration is a list of constant values that specify the outcome after running a job. |
| JobServerType | The JobServerType enumeration is a list of constant values that specify the type of server with regard to multiserver or stand-alone administration. |
| JobStepFlags | The JobStepFlags enumeration is a list of constant values that specify the file to which to append job history information. |
| JobType | The JobType enumeration is a list of constant values that specify the location where the job is run (locally or on multiple servers). |
| NotifyMethods | The NotifyMethods enumeration contains values that specify the method used to notify operators in an alert or a job. This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. |
| NotifyType | The NotifyType enumeration contains values that are used to specify the notification type that restricts the output of the Alert object's EnumNotifications method. |
| OSRunPriority | The OSRunPriority enumeration contains constant values that specify the levels of priority given to running the operating system. |
| StepCompletionAction | The StepCompletionAction enumeration contains values that specify the action taken on completion of a job step. |
| TargetServerStatus | The TargetServerStatus enumeration contains values that specify the status of a target server. This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. |
| WeekDays | The WeekDays enumeration contains constant values that specify the days of the week. |