TechNet
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, IDropIfExists, IRenamable, IScriptable

NameDescription
System_CAPS_pubmethodJobStep()

Initializes a new instance of the JobStep class.

System_CAPS_pubmethodJobStep(Job, String)

Initializes a new instance of the JobStep class for the specified job and with the specified name.

NameDescription
System_CAPS_pubpropertyCommand

Gets or sets the command execution string for the job step.

System_CAPS_pubpropertyCommandExecutionSuccessCode

Gets or sets the process exit code from a command shell process executed as a job step.

System_CAPS_pubpropertyDatabaseName

Gets or sets the name of the database to which the job step command execution is confined.

System_CAPS_pubpropertyDatabaseUserName

Gets or sets the database user account that the job step assumes when executing the command string.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyID

Gets or sets the ID value that uniquely identifies the job step.

System_CAPS_pubpropertyJobStepFlags

The JobStepFlags property is reserved for future use.

System_CAPS_pubpropertyLastRunDate

Gets the date and time when the job step was last executed.

System_CAPS_pubpropertyLastRunDuration

Gets the time that the referenced job step took to run when it was last executed.

System_CAPS_pubpropertyLastRunOutcome

Gets the outcome of the job step when it was last executed.

System_CAPS_pubpropertyLastRunRetries

Gets the number of retries that were attempted when the job step was last executed.

System_CAPS_pubpropertyName

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

System_CAPS_pubpropertyOnFailAction

Gets or sets the action to take when the job step finishes execution with failure.

System_CAPS_pubpropertyOnFailStep

Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of failure.

System_CAPS_pubpropertyOnSuccessAction

Gets or sets the action to take when the job step finishes execution with success.

System_CAPS_pubpropertyOnSuccessStep

Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of success.

System_CAPS_pubpropertyOSRunPriority

Gets or sets the execution thread scheduling for job steps executing operating system tasks.

System_CAPS_pubpropertyOutputFileName

Gets or sets the name and path of the operating system file that records job step result message text.

System_CAPS_pubpropertyParent

Gets or sets the Job object that is the parent of the JobStep object.

System_CAPS_pubpropertyProperties

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

System_CAPS_pubpropertyProxyName

Gets or sets the name of the Microsoft SQL Server Agent proxy account that is required by the job step.

System_CAPS_pubpropertyRetryAttempts

Gets or sets the maximum number of times a job step is retried before it is returned with a completion status of failure.

System_CAPS_pubpropertyRetryInterval

Gets or sets the number of minutes that Microsoft SQL Server Agent waits before trying to execute a job step that has previously failed.

System_CAPS_pubpropertyServer

Gets or sets the name of the server on which the job step runs.

System_CAPS_pubpropertyState

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

System_CAPS_pubpropertySubSystem

Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text.

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

NameDescription
System_CAPS_pubmethodAlter()

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

System_CAPS_pubmethodCreate()

Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object.

System_CAPS_pubmethodDeleteLogs(DateTime)

Deletes job step log files that are older than the specified date.

System_CAPS_pubmethodDeleteLogs(Int32)

Deletes job step log files that have log numbers lower than the specified value.

System_CAPS_pubmethodDiscover()

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

System_CAPS_pubmethodDrop()

Removes the referenced job step.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodEnumLogs()

Returns an enumerated list of the job step log files.

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_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRename(String)

Renames the job step.

System_CAPS_pubmethodScript()

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

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

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

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.

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
Show:
© 2016 Microsoft