Partilhar via


Job Members

The Job class represents a Microsoft SQL Server Agent job.

The following tables list the members exposed by the Job type.

Public Constructors

  Name Description
Job Overloaded. Initializes a new instance of the Job class.

Top

Protected Fields

  Name Description
ms219078.protfield(en-US,SQL.90).gif m_ExtendedProperties  (inherited from SqlSmoObject )

Top

Public Properties

(see also Protected Properties )

  Name Description
ms219078.pubproperty(en-US,SQL.90).gif Category Gets or sets the category to which the job belongs.
ms219078.pubproperty(en-US,SQL.90).gif CurrentRunRetryAttempt Gets the number of times Microsoft SQL Server Agent has attempted to run the job unsuccessfully.
ms219078.pubproperty(en-US,SQL.90).gif CurrentRunStatus Gets the current execution status of the job.
ms219078.pubproperty(en-US,SQL.90).gif CurrentRunStep Gets information about the job step that is currently running.
ms219078.pubproperty(en-US,SQL.90).gif DateCreated Gets the date and time when the job was created.
ms219078.pubproperty(en-US,SQL.90).gif DateLastModified Gets the date and time when the job was last modified.
ms219078.pubproperty(en-US,SQL.90).gif DeleteLevel Gets or sets the completion action that determines whether to delete the job definition when the job finishes execution.
ms219078.pubproperty(en-US,SQL.90).gif Description Gets or sets the textual description of the job.
ms219078.pubproperty(en-US,SQL.90).gif EmailLevel Gets or sets the completion action that determines whether to send an e-mail notification to an operator when the job finishes execution.
ms219078.pubproperty(en-US,SQL.90).gif EventLogLevel Gets or sets the completion action that determines whether to generate an operating system event log entry when the job finishes execution.
ms219078.pubproperty(en-US,SQL.90).gif HasSchedule Gets the Boolean property value that specifies whether the job has at least one schedule.
ms219078.pubproperty(en-US,SQL.90).gif HasServer Gets the Boolean property value that specifies whether the job has a target server assigned for multiple-server operations.
ms219078.pubproperty(en-US,SQL.90).gif HasStep Gets the Boolean property value that specifies whether the job has at least one job step.
ms219078.pubproperty(en-US,SQL.90).gif IsEnabled Gets or sets the Boolean property value that specifies whether the job is enabled.
ms219078.pubproperty(en-US,SQL.90).gif JobID Gets or sets the job ID value.
ms219078.pubproperty(en-US,SQL.90).gif JobSchedules Gets a collection of JobSchedule objects that represent the schedules assigned to the job.
ms219078.pubproperty(en-US,SQL.90).gif JobSteps Gets a collection of JobStep objects that represent the job steps defined for the job.
ms219078.pubproperty(en-US,SQL.90).gif JobType Gets the job type, which specifies whether the job is local or multiserver.
ms219078.pubproperty(en-US,SQL.90).gif LastRunDate Gets the date and time when the job was last run.
ms219078.pubproperty(en-US,SQL.90).gif LastRunOutcome Gets the result of the job from the last time it completed execution.
ms219078.pubproperty(en-US,SQL.90).gif Name  Gets the name of the referenced job. (inherited from NamedSmoObject)
ms219078.pubproperty(en-US,SQL.90).gif NetSendLevel Gets or sets the completion action that determines whether to net-send a notification to an operator when the job finishes execution.
ms219078.pubproperty(en-US,SQL.90).gif NextRunDate Gets the date and time when the job is next scheduled to run.
ms219078.pubproperty(en-US,SQL.90).gif NextRunScheduleID Gets the ID value of the schedule that is responsible for the next execution of the job.
ms219078.pubproperty(en-US,SQL.90).gif OperatorToEmail Gets or sets the operator that receives notification by e-mail when the job finishes execution.
ms219078.pubproperty(en-US,SQL.90).gif OperatorToNetSend Gets or sets the operator that receives a net-send notification when the job finishes execution.
ms219078.pubproperty(en-US,SQL.90).gif OperatorToPage Gets or sets the operator that receives a pager notification when the job finishes execution.
ms219078.pubproperty(en-US,SQL.90).gif OriginatingServer Gets the name of the server that is acting as the master server in a multiserver job.
ms219078.pubproperty(en-US,SQL.90).gif OwnerLoginName Gets or sets the owner of the job.
ms219078.pubproperty(en-US,SQL.90).gif PageLevel Gets or sets the completion action that determines whether to send a pager notification to an operator when the job finishes execution.
ms219078.pubproperty(en-US,SQL.90).gif Parent Gets or sets the JobServer object that is the parent of the Job object.
ms219078.pubproperty(en-US,SQL.90).gif Properties  Gets a collection of Property objects that represent the object properties. (inherited from SqlSmoObject)
ms219078.pubproperty(en-US,SQL.90).gif StartStepID Gets or sets the ID value of the first job step in the sequence to be executed.
ms219078.pubproperty(en-US,SQL.90).gif State  Gets the state of the referenced object. (inherited from SmoObjectBase)
ms219078.pubproperty(en-US,SQL.90).gif Urn  Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (inherited from SqlSmoObject)
ms219078.pubproperty(en-US,SQL.90).gif UserData  Gets or sets user-defined data associated with the referenced object. (inherited from SmoObjectBase)
ms219078.pubproperty(en-US,SQL.90).gif VersionNumber Gets a system-maintained value that is incremented every time the job is modified.

Top

Protected Properties

  Name Description
ms219078.protproperty(en-US,SQL.90).gif ExecuteForScalar  Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject)
ms219078.protproperty(en-US,SQL.90).gif ObjectInSpace  Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject)
ms219078.protproperty(en-US,SQL.90).gif PresetProperties  Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject)
ms219078.protproperty(en-US,SQL.90).gif ScalarResult  Gets the scalar result for the referenced object. (inherited from SqlSmoObject)

Top

Public Methods

(see also Protected Methods )

  Name Description
ms219078.pubmethod(en-US,SQL.90).gif AddSharedSchedule Adds a shared schedule to the Microsoft SQL Server Agent job.
ms219078.pubmethod(en-US,SQL.90).gif Alter Updates any Job object property changes on an instance of Microsoft SQL Server.
ms219078.pubmethod(en-US,SQL.90).gif ApplyToTargetServer Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
ms219078.pubmethod(en-US,SQL.90).gif ApplyToTargetServerGroup Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
ms219078.pubmethod(en-US,SQL.90).gif Create Creates a job on the instance of Microsoft SQL Server as defined by the Job object.
ms219078.pubmethod(en-US,SQL.90).gif DeleteJobStepLogs Overloaded.  
ms219078.pubmethod(en-US,SQL.90).gif Drop Overloaded. Removes an existing job.
ms219078.pubmethod(en-US,SQL.90).gif EnumAlerts Enumerates a list of Agent alerts that cause automated execution of the referenced job.
ms219078.pubmethod(en-US,SQL.90).gif EnumHistory Overloaded. Enumerates a list of execution history items associated with the referenced job.
ms219078.pubmethod(en-US,SQL.90).gif EnumJobStepLogs Overloaded. Enumerates a list of job step log files.
ms219078.pubmethod(en-US,SQL.90).gif EnumJobStepsByID Returns an array of JobStep objects that belong to the referenced job and that are ordered by ID value.
ms219078.pubmethod(en-US,SQL.90).gif EnumTargetServers Enumerates a list of execution target servers that have been assigned to the referenced job.
ms219078.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from Object )
ms219078.pubmethod(en-US,SQL.90).gif GetHashCode  (inherited from Object )
ms219078.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms219078.pubmethod(en-US,SQL.90).gif Initialize  Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject)
ms219078.pubmethod(en-US,SQL.90).gif Invoke Runs the job.
ms219078.pubmethod(en-US,SQL.90).gif PurgeHistory Removes system records maintaining execution history for the referenced job.
ms219078.pubmethod(en-US,SQL.90).gifms219078.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms219078.pubmethod(en-US,SQL.90).gif Refresh  Refreshes the object and retrieves properties when the object is next accessed. (inherited from SqlSmoObject)
ms219078.pubmethod(en-US,SQL.90).gif RemoveAllJobSchedules Overloaded. Removes all shared and unshared schedules from the job.
ms219078.pubmethod(en-US,SQL.90).gif RemoveAllJobSteps Removes all the job steps associated with the job.
ms219078.pubmethod(en-US,SQL.90).gif RemoveFromTargetServer Removes an execution target server from the list of target servers maintained for a job.
ms219078.pubmethod(en-US,SQL.90).gif RemoveFromTargetServerGroup Removes a group of execution target servers from the list of target servers maintained for a job.
ms219078.pubmethod(en-US,SQL.90).gif RemoveSharedSchedule Removes a shared schedule.
ms219078.pubmethod(en-US,SQL.90).gif Rename Renames the job.
ms219078.pubmethod(en-US,SQL.90).gif Script Overloaded. Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job.
ms219078.pubmethod(en-US,SQL.90).gif Start Overloaded. Runs the referenced job.
ms219078.pubmethod(en-US,SQL.90).gif Stop Stops executing the referenced job.
ms219078.pubmethod(en-US,SQL.90).gif ToString  Returns a String that represents the referenced object. (inherited from SqlSmoObject)

Top

Protected Methods

  Name Description
ms219078.protmethod(en-US,SQL.90).gif AlterImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif AlterImplFinish  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif AlterImplInit  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif AlterImplWorker  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif BindDefaultImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif BindRuleImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif CheckCollation  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif CheckObjectState  Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject)
ms219078.protmethod(en-US,SQL.90).gif CheckObjectStateImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif CheckVersion80  Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject)
ms219078.protmethod(en-US,SQL.90).gif CheckVersion80SP3  Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject)
ms219078.protmethod(en-US,SQL.90).gif CheckVersion90  Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject)
ms219078.protmethod(en-US,SQL.90).gif CheckVersionBelow90  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif CleanObject  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif CreateImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif CreateImplFinish  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif CreateImplInit  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif DropImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif DropImplWorker  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms219078.protmethod(en-US,SQL.90).gif FormatSqlVariant  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GenerateDataSpaceScript  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetBindDefaultScript  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetBindRuleScript  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetBoolParameter  Overloaded. (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetDateTimeParameter  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetDateTimeParameterAsInt  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetDBName  Gets the database name that is associated with the object. (inherited from AgentObjectBase)
ms219078.protmethod(en-US,SQL.90).gif GetEnumParameter  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetFragOptionString  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetGuidParameter  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetParameter  Overloaded. (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetPropValue  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetPropValueOptional  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetPropValueOptionalAllowNull  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetRealValue  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetScriptingOptionsForCreate  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetServerName  Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms219078.protmethod(en-US,SQL.90).gif GetSqlServerVersionName  Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms219078.protmethod(en-US,SQL.90).gif GetStringParameter  Overloaded. (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetTimeSpanParameterAsInt  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif GetUrnRecursive  Overloaded. (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif ImplInitialize  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gifms219078.static(en-US,SQL.90).gif IsCollectionDirty  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif IsObjectDirty  Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of Microsoft SQL Server. (inherited from SqlSmoObject)
ms219078.protmethod(en-US,SQL.90).gif IsObjectInitialized  Verifies whether the object has been initialized. (inherited from SqlSmoObject)
ms219078.protmethod(en-US,SQL.90).gif IsObjectInSpace  Verifies whether the object is isolated or connected to the instance of Microsoft SQL Server. (inherited from SqlSmoObject)
ms219078.protmethod(en-US,SQL.90).gif IsVersion80SP3  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif MarkDropped  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif MarkForDropImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )
ms219078.protmethod(en-US,SQL.90).gif PostAlter  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif PostCreate  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif PostDrop  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif RenameImpl  (inherited from NamedSmoObject )
ms219078.protmethod(en-US,SQL.90).gif RenameImplWorker  (inherited from NamedSmoObject )
ms219078.protmethod(en-US,SQL.90).gif ScriptAlter  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif ScriptChangeOwner  (inherited from NamedSmoObject )
ms219078.protmethod(en-US,SQL.90).gif ScriptCreate  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif ScriptDdl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif ScriptDrop  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif ScriptImpl  Overloaded. (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif ScriptImplWorker  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif ScriptRename  (inherited from NamedSmoObject )
ms219078.protmethod(en-US,SQL.90).gif SetParentImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gifms219078.static(en-US,SQL.90).gif Trace  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif UnbindDefaultImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gif UnbindRuleImpl  (inherited from SqlSmoObject )
ms219078.protmethod(en-US,SQL.90).gifms219078.static(en-US,SQL.90).gif UpdateCollectionState2  (inherited from SqlSmoObject )

Top

See Also

Reference

Job Class
Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Scheduling Automatic Administrative Tasks in SQL Server Agent
Automating Administrative Tasks (SQL Server Agent)
sp_add_job (Transact-SQL)