Export (0) Print
Expand All

JobStep Class

The JobStep class represents a Microsoft SQL Server job step.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

[SfcElementTypeAttribute("Step")]
public sealed class JobStep : AgentObjectBase, 
	IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

The JobStep type exposes the following members.

  NameDescription
Public methodJobStep()Initializes a new instance of the JobStep class.
Public methodJobStep(Job, String)Initializes a new instance of the JobStep class for the specified job and with the specified name.
Top

  NameDescription
Public propertyCommandGets or sets the command execution string for the job step.
Public propertyCommandExecutionSuccessCodeGets or sets the process exit code from a command shell process executed as a job step.
Public propertyDatabaseNameGets or sets the name of the database to which the job step command execution is confined.
Public propertyDatabaseUserNameGets or sets the database user account that the job step assumes when executing the command string.
Public propertyIDGets or sets the ID value that uniquely identifies the job step.
Public propertyJobStepFlagsThe JobStepFlags property is reserved for future use.
Public propertyLastRunDateGets the date and time when the job step was last executed.
Public propertyLastRunDurationGets the time that the referenced job step took to run when it was last executed.
Public propertyLastRunOutcomeGets the outcome of the job step when it was last executed.
Public propertyLastRunRetriesGets the number of retries that were attempted when the job step was last executed.
Public propertyNameGets or sets the name of the object. (Inherited from NamedSmoObject.)
Public propertyOnFailActionGets or sets the action to take when the job step finishes execution with failure.
Public propertyOnFailStepGets or sets the job step that is executed after the referenced job step finishes execution with a completion status of failure.
Public propertyOnSuccessActionGets or sets the action to take when the job step finishes execution with success.
Public propertyOnSuccessStepGets or sets the job step that is executed after the referenced job step finishes execution with a completion status of success.
Public propertyOSRunPriorityGets or sets the execution thread scheduling for job steps executing operating system tasks.
Public propertyOutputFileNameGets or sets the name and path of the operating system file that records job step result message text.
Public propertyParentGets or sets the Job object that is the parent of the JobStep object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyProxyNameGets or sets the name of the Microsoft SQL Server Agent proxy account that is required by the job step.
Public propertyRetryAttemptsGets or sets the maximum number of times a job step is retried before it is returned with a completion status of failure.
Public propertyRetryIntervalGets or sets the number of minutes that Microsoft SQL Server Agent waits before trying to execute a job step that has previously failed.
Public propertyServerGets or sets the name of the server on which the job step runs.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertySubSystemGets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text.
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.)
Top

  NameDescription
Public methodAlterUpdates any JobStep object property changes on instance of Microsoft SQL Server.
Public methodCreateCreates a job step on the instance of Microsoft SQL Server as defined by the JobStep object.
Public methodDeleteLogs(DateTime)Deletes job step log files that are older than the specified date.
Public methodDeleteLogs(Int32)Deletes job step log files that have log numbers lower than the specified value.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropRemoves the referenced job step.
Public methodEnumLogsReturns an enumerated list of the job step log files.
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 methodRenameRenames the job step.
Public methodScript()Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step.
Public methodScript(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.
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 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

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

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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft