Share via

Clase JobStep

  • Artículo

The JobStep class represents a Microsoft SQL Server job step.

Jerarquía de herencia

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

Espacio de nombres:  Microsoft.SqlServer.Management.Smo.Agent
Ensamblado:  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Sintaxis

'Declaración
<SfcElementTypeAttribute("Step")> _
Public NotInheritable Class JobStep _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
'Uso
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

El tipo JobStep expone los siguientes miembros.

Constructores

  Nombre Descripción
Método público JobStep() Initializes a new instance of the JobStep class.
Método público JobStep(Job, String) Initializes a new instance of the JobStep class for the specified job and with the specified name.

Arriba

Propiedades

  Nombre Descripción
Propiedad pública Command Gets or sets the command execution string for the job step.
Propiedad pública CommandExecutionSuccessCode Gets or sets the process exit code from a command shell process executed as a job step.
Propiedad pública DatabaseName Gets or sets the name of the database to which the job step command execution is confined.
Propiedad pública DatabaseUserName Gets or sets the database user account that the job step assumes when executing the command string.
Propiedad pública ID Gets or sets the ID value that uniquely identifies the job step.
Propiedad pública JobStepFlags The JobStepFlags property is reserved for future use.
Propiedad pública LastRunDate Gets the date and time when the job step was last executed.
Propiedad pública LastRunDuration Gets the time that the referenced job step took to run when it was last executed.
Propiedad pública LastRunOutcome Gets the outcome of the job step when it was last executed.
Propiedad pública LastRunRetries Gets the number of retries that were attempted when the job step was last executed.
Propiedad pública Name Gets or sets the name of the object. (Se hereda de NamedSmoObject.)
Propiedad pública OnFailAction Gets or sets the action to take when the job step finishes execution with failure.
Propiedad pública OnFailStep Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of failure.
Propiedad pública OnSuccessAction Gets or sets the action to take when the job step finishes execution with success.
Propiedad pública OnSuccessStep Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of success.
Propiedad pública OSRunPriority Gets or sets the execution thread scheduling for job steps executing operating system tasks.
Propiedad pública OutputFileName Gets or sets the name and path of the operating system file that records job step result message text.
Propiedad pública Parent Gets or sets the Job object that is the parent of the JobStep object.
Propiedad pública Properties Gets a collection of Property objects that represent the object properties. (Se hereda de SqlSmoObject.)
Propiedad pública ProxyName Gets or sets the name of the Microsoft SQL Server Agent proxy account that is required by the job step.
Propiedad pública RetryAttempts Gets or sets the maximum number of times a job step is retried before it is returned with a completion status of failure.
Propiedad pública 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.
Propiedad pública Server Gets or sets the name of the server on which the job step runs.
Propiedad pública State Gets the state of the referenced object. (Se hereda de SmoObjectBase.)
Propiedad pública SubSystem Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text.
Propiedad pública Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Se hereda de SqlSmoObject.)
Propiedad pública UserData Gets or sets user-defined data associated with the referenced object. (Se hereda de SmoObjectBase.)

Arriba

Métodos

  Nombre Descripción
Método público Alter Updates any JobStep object property changes on instance of Microsoft SQL Server.
Método público Create Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object.
Método público DeleteLogs(DateTime) Deletes job step log files that are older than the specified date.
Método público DeleteLogs(Int32) Deletes job step log files that have log numbers lower than the specified value.
Método público Discover Discovers a list of type Object. (Se hereda de SqlSmoObject.)
Método público Drop Removes the referenced job step.
Método público EnumLogs Returns an enumerated list of the job step log files.
Método público Equals (Se hereda de Object.)
Método protegido FormatSqlVariant Formats an object as SqlVariant type. (Se hereda de SqlSmoObject.)
Método protegido GetContextDB Gets the context database that is associated with this object. (Se hereda de SqlSmoObject.)
Método protegido GetDBName Gets the database name that is associated with the object. (Se hereda de AgentObjectBase.)
Método público GetHashCode (Se hereda de Object.)
Método protegido GetPropValue Gets a property value of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido GetPropValueOptional Gets a property value of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método protegido GetServerObject Gets the server of the SqlSmoObject object. (Se hereda de SqlSmoObject.)
Método público GetType (Se hereda de Object.)
Método público Initialize() Initializes the object and forces the properties be loaded. (Se hereda de SqlSmoObject.)
Método público Initialize(Boolean) Initializes the object and forces the properties be loaded. (Se hereda de SqlSmoObject.)
Método protegido IsObjectInitialized Verifies whether the object has been initialized. (Se hereda de SqlSmoObject.)
Método protegido IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Se hereda de SqlSmoObject.)
Método público Refresh Refreshes the object and retrieves properties when the object is next accessed. (Se hereda de SqlSmoObject.)
Método público Rename Renames the job step.
Método público Script() Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step.
Método público 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.
Método protegido SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Se hereda de SqlSmoObject.)
Método público ToString Returns a String that represents the referenced object. (Se hereda de SqlSmoObject.)
Método público Validate Validates the state of an object. (Se hereda de SmoObjectBase.)

Arriba

Eventos

  Nombre Descripción
Evento público PropertyChanged Represents the event that occurs when a property is changed. (Se hereda de SqlSmoObject.)
Evento público PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Se hereda de SqlSmoObject.)

Arriba

Implementaciones de interfaces explícitas

  Nombre Descripción
Implementación de interfaces explícitasMétodo privado IAlienObject.Discover Discovers any dependencies. No haga referencia directamente a este miembro en el código. Admite la infraestructura de SQL Server. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetDomainRoot Returns the root of the domain. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetParent Gets the parent of this object. No haga referencia directamente a este miembro en el código. Admite la infraestructura de SQL Server. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetPropertyType Gets the type of the specified property. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetPropertyValue Gets the value of the specified property. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. No haga referencia directamente a este miembro en el código. Admite la infraestructura de SQL Server. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject.SetPropertyValue Sets the property value. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Se hereda de SqlSmoObject.)

Arriba

Comentarios

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

Todos los miembros estáticos (compartidos en Microsoft Visual Basic) públicos de este tipo son seguros para operaciones multiproceso. No se garantiza que los miembros de instancia sean seguros para subprocesos.  

Ejemplos

Programar tareas administrativas automáticas en el Agente SQL Server

Seguridad para subprocesos

Cualquier miembro público static (Shared en Visual Basic) de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Vea también

Referencia

Espacio de nombres Microsoft.SqlServer.Management.Smo.Agent

Otros recursos

Programar tareas administrativas automáticas en el Agente SQL Server

Tareas administrativas automatizadas (Agente SQL Server)

sp_help_jobstep (Transact-SQL)