JobStep 类

The JobStep class represents a Microsoft SQL Server job step.

继承层次结构

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

命名空间:  Microsoft.SqlServer.Management.Smo.Agent
程序集:  Microsoft.SqlServer.Smo(在 Microsoft.SqlServer.Smo.dll 中)

语法

声明
<SfcElementTypeAttribute("Step")> _
Public NotInheritable Class JobStep _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
用法
Dim instance As JobStep
[SfcElementTypeAttribute("Step")]
public sealed class JobStep : AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
[SfcElementTypeAttribute(L"Step")]
public ref class JobStep sealed : public AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
[<SealedAttribute>]
[<SfcElementTypeAttribute("Step")>]
type JobStep =  
    class 
        inherit AgentObjectBase 
        interface IAlterable 
        interface ICreatable 
        interface IDroppable 
        interface IRenamable 
        interface IScriptable 
    end
public final class JobStep extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

JobStep 类型公开以下成员。

构造函数

  名称 说明
公共方法 JobStep() Initializes a new instance of the JobStep class.
公共方法 JobStep(Job, String) Initializes a new instance of the JobStep class for the specified job and with the specified name.

页首

属性

  名称 说明
公共属性 Command Gets or sets the command execution string for the job step.
公共属性 CommandExecutionSuccessCode Gets or sets the process exit code from a command shell process executed as a job step.
公共属性 DatabaseName Gets or sets the name of the database to which the job step command execution is confined.
公共属性 DatabaseUserName Gets or sets the database user account that the job step assumes when executing the command string.
公共属性 ID Gets or sets the ID value that uniquely identifies the job step.
公共属性 JobStepFlags The JobStepFlags property is reserved for future use.
公共属性 LastRunDate Gets the date and time when the job step was last executed.
公共属性 LastRunDuration Gets the time that the referenced job step took to run when it was last executed.
公共属性 LastRunOutcome Gets the outcome of the job step when it was last executed.
公共属性 LastRunRetries Gets the number of retries that were attempted when the job step was last executed.
公共属性 Name Gets or sets the name of the object. (从 NamedSmoObject 继承。)
公共属性 OnFailAction Gets or sets the action to take when the job step finishes execution with failure.
公共属性 OnFailStep Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of failure.
公共属性 OnSuccessAction Gets or sets the action to take when the job step finishes execution with success.
公共属性 OnSuccessStep Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of success.
公共属性 OSRunPriority Gets or sets the execution thread scheduling for job steps executing operating system tasks.
公共属性 OutputFileName Gets or sets the name and path of the operating system file that records job step result message text.
公共属性 Parent Gets or sets the Job object that is the parent of the JobStep object.
公共属性 Properties Gets a collection of Property objects that represent the object properties. (从 SqlSmoObject 继承。)
公共属性 ProxyName Gets or sets the name of the Microsoft SQL Server Agent proxy account that is required by the job step.
公共属性 RetryAttempts Gets or sets the maximum number of times a job step is retried before it is returned with a completion status of failure.
公共属性 RetryInterval Gets or sets the number of minutes that Microsoft SQL Server Agent waits before trying to execute a job step that has previously failed.
公共属性 Server Gets or sets the name of the server on which the job step runs.
公共属性 State Gets the state of the referenced object. (从 SmoObjectBase 继承。)
公共属性 SubSystem Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text.
公共属性 Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (从 SqlSmoObject 继承。)
公共属性 UserData Gets or sets user-defined data associated with the referenced object. (从 SmoObjectBase 继承。)

页首

方法

  名称 说明
公共方法 Alter Updates any JobStep object property changes on instance of Microsoft SQL Server.
公共方法 Create Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object.
公共方法 DeleteLogs(DateTime) Deletes job step log files that are older than the specified date.
公共方法 DeleteLogs(Int32) Deletes job step log files that have log numbers lower than the specified value.
公共方法 Discover Discovers a list of type Object. (从 SqlSmoObject 继承。)
公共方法 Drop Removes the referenced job step.
公共方法 EnumLogs Returns an enumerated list of the job step log files.
公共方法 Equals (从 Object 继承。)
受保护方法 FormatSqlVariant Formats an object as SqlVariant type. (从 SqlSmoObject 继承。)
受保护方法 GetContextDB Gets the context database that is associated with this object. (从 SqlSmoObject 继承。)
受保护方法 GetDBName Gets the database name that is associated with the object. (从 AgentObjectBase 继承。)
公共方法 GetHashCode (从 Object 继承。)
受保护方法 GetPropValue Gets a property value of the SqlSmoObject object. (从 SqlSmoObject 继承。)
受保护方法 GetPropValueOptional Gets a property value of the SqlSmoObject object. (从 SqlSmoObject 继承。)
受保护方法 GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (从 SqlSmoObject 继承。)
受保护方法 GetServerObject Gets the server of the SqlSmoObject object. (从 SqlSmoObject 继承。)
公共方法 GetType (从 Object 继承。)
公共方法 Initialize() Initializes the object and forces the properties be loaded. (从 SqlSmoObject 继承。)
公共方法 Initialize(Boolean) Initializes the object and forces the properties be loaded. (从 SqlSmoObject 继承。)
受保护方法 IsObjectInitialized Verifies whether the object has been initialized. (从 SqlSmoObject 继承。)
受保护方法 IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (从 SqlSmoObject 继承。)
公共方法 Refresh Refreshes the object and retrieves properties when the object is next accessed. (从 SqlSmoObject 继承。)
公共方法 Rename Renames the job step.
公共方法 Script() Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step.
公共方法 Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step as specified by the scripting options.
受保护方法 SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (从 SqlSmoObject 继承。)
公共方法 ToString Returns a String that represents the referenced object. (从 SqlSmoObject 继承。)
公共方法 Validate Validates the state of an object. (从 SmoObjectBase 继承。)

页首

事件

  名称 说明
公共事件 PropertyChanged Represents the event that occurs when a property is changed. (从 SqlSmoObject 继承。)
公共事件 PropertyMetadataChanged Represents the event that occurs when property metadata changes. (从 SqlSmoObject 继承。)

页首

显式接口实现

  名称 说明
显式接口实现私有方法 IAlienObject.Discover Discovers any dependencies. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetDomainRoot Returns the root of the domain. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetParent Gets the parent of this object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetPropertyType Gets the type of the specified property. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetPropertyValue Gets the value of the specified property. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (从 SqlSmoObject 继承。)
显式接口实现私有方法 IAlienObject.SetPropertyValue Sets the property value. (从 SqlSmoObject 继承。)
显式接口实现私有方法 ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (从 SqlSmoObject 继承。)

页首

注释

SQL Server Agent jobs contain one or more execution units called steps. Each job step contains a textual command, type of execution that specifies command interpretation, and logic that determines the behavior of the job if the step succeeds or fails. For example, a job step can contain:

  • The command text. For example:

    DBCC CHECKDB ('Northwind') WITH NO_INFOMSGS
    
  • A job step execution type: Transact-SQL for example.

  • An indication that the job should stop if the step fails.

With the JobStep object, you can do the following:

  • Create a SQL Server Agent job step.

  • Remove a job step from a SQL Server Agent job.

  • Manage existing job steps by changing, for example, the command text or the actions taken on success or failure of the step.

  • Obtain details about the last attempted execution of the step.

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

To set JobStep object properties, users must be a member of SQLAgentUserRole database role on the MSDB database, be the owner of the owner of the job step, or be a member of the sysadmin fixed server role.

To create a job step, users must be a member of SQLAgentUserRole database role on the MSDB database or be a member of the sysadmin fixed server role. The user must also have permission on any proxy accounts used by the job step.

To drop a job step, users must be a member of SQLAgentUserRole database role on the MSDB database, be the owner of the job step, or be a member of the sysadmin fixed server role.

Thread Safety

此类型的任何公共静态(Microsoft Visual Basic 中的 Shared)成员在多线程操作中是安全的。但不保证所有实例成员都是线程安全的。  

示例

在 SQL Server 代理中计划自动管理任务

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.Smo.Agent 命名空间

其他资源

在 SQL Server 代理中计划自动管理任务

自动执行管理任务(SQL Server 代理)

sp_help_jobstep (Transact-SQL)