Compartir a través de

  • Artículo

Clase JobStep

The JobStep class represents a Microsoft SQL Server job step.

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 protegida ExecuteForScalar Obtiene o establece el valor de propiedad Boolean que especifica si el objeto está establecido para que se ejecute para la opción escalar. (Se hereda de SqlSmoObject.)
Propiedad pública ID Gets or sets the ID value that uniquely identifies the job step.
Propiedad protegida IsTouched Obtiene el valor de propiedad Boolean que especifica si las propiedades del objeto se han actualizado pero todavía no son persistentes en el servidor. (Se hereda de SqlSmoObject.)
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 protegida ObjectInSpace Obtiene el valor de propiedad Boolean que especifica si el objeto existe en aislamiento, o si está conectado directa o indirectamente con la instancia de SQL Server. (Se hereda de SqlSmoObject.)
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 Obtiene una colección de objetos Property que representa las propiedades del objeto. (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 protegida ScalarResult Obtiene el resultado escalar para el objeto al que se hace referencia. (Se hereda de SqlSmoObject.)
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 Obtiene el valor de la dirección URN (nombre de recursos uniforme) que identifica de forma única el objeto. (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 protegido AddDatabaseContext(StringCollection) Agrega el contexto de la base de datos a la colección de consultas identificada por el parámetro queries. (Se hereda de SqlSmoObject.)
Método protegido AddDatabaseContext(StringCollection, ScriptingOptions) Agrega el contexto de la base de datos a la colección de consultas identificada por el parámetro queries usando las opciones de scripting especificadas. (Se hereda de SqlSmoObject.)
Método público Alter Updates any JobStep object property changes on instance of Microsoft SQL Server. 
Método protegido AlterImpl Activa el evento de objeto modificado. (Se hereda de SqlSmoObject.)
Método protegido AlterImplFinish Método al que se llama cuando finaliza el evento de objeto modificado. (Se hereda de SqlSmoObject.)
Método protegido AlterImplInit Método al que se llama cuando se inicializa el evento de objeto modificado. (Se hereda de SqlSmoObject.)
Método protegido AlterImplWorker Llama a los métodos Alter. (Se hereda de SqlSmoObject.)
Método protegido BindDefaultImpl Enlaza los elementos predeterminados identificados por los parámetros. (Se hereda de SqlSmoObject.)
Método protegido BindRuleImpl Enlaza el esquema de la regla a la regla y las columnas identificadas por los parámetros. (Se hereda de SqlSmoObject.)
Método protegido CheckCollation Comprueba el orden de las opciones de scripting por el método de intercalación identificado por el parámetro collationName. (Se hereda de SqlSmoObject.)
Método protegido CheckObjectState() () () () Valida el estado del objeto al que se hace referencia. (Se hereda de SqlSmoObject.)
Método protegido CheckObjectState(Boolean) Valida el estado del objeto al que se hace referencia, con la opción de especificar que se produzca una excepción si todavía no se ha creado el objeto. (Se hereda de SqlSmoObject.)
Método protegido CheckObjectStateImpl Comprueba el estado de un objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido CheckVersion100 Comprueba si la versión de SQL Server es SQL Server 2008. (Se hereda de SqlSmoObject.)
Método protegido CheckVersion80 Comprueba la validez del objeto en SQL Server 2000. (Se hereda de SqlSmoObject.)
Método protegido CheckVersion80SP3 Comprueba la validez del objeto en SQL Server 2000 SP3. (Se hereda de SqlSmoObject.)
Método protegido CheckVersion90 Comprueba la validez del objeto en SQL Server 2005. (Se hereda de SqlSmoObject.)
Método protegido CheckVersionBelow90 Comprueba si la versión de SQL Server es anterior a SQL Server 2005. (Se hereda de SqlSmoObject.)
Método protegido CleanObject Establece el objeto en el estado no modificado. (Se hereda de SqlSmoObject.)
Método público Create Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object.
Método protegido CreateImpl Crea un objeto con opciones de scripting. (Se hereda de SqlSmoObject.)
Método protegido CreateImplFinish Método al que se llama cuando finaliza el evento Create. (Se hereda de SqlSmoObject.)
Método protegido CreateImplInit Método al que se llama cuando se inicializa el evento Create. (Se hereda de SqlSmoObject.)
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 Detecta una lista del tipo Object. (Se hereda de SqlSmoObject.)
Método público Drop Removes the referenced job step.
Método protegido DropImpl Quita un SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido DropImplWorker Llama a los métodos Drop. (Se hereda de SqlSmoObject.)
Método público EnumLogs Returns an enumerated list of the job step log files.
Método protegido EnumScriptImpl Enumera los scripts especificados por el parámetro so. (Se hereda de SqlSmoObject.)
Método protegido EnumScriptImplWorker Llama a los métodos que enumeran los scripts especificados por el parámetro so. (Se hereda de SqlSmoObject.)
Método protegido EnumScriptImplWorkerSOChanged Devuelve una cadena IEnumerable que describe las opciones de scripting de un objeto. (Se hereda de SqlSmoObject.)
Método público Equals (Se hereda de Object.)
Método protegido ExecuteNonQuery (Se hereda de SqlSmoObject.)
Método protegido Finalize (Se hereda de Object.)
Método protegido FormatSqlVariant Da formato a un objeto como tipo SqlVariant. (Se hereda de SqlSmoObject.)
Método protegido GenerateDataSpaceFileStreamScript Genera un script para crear el archivo de datos. (Se hereda de SqlSmoObject.)
Método protegido GenerateDataSpaceScript Genera un script para asignar espacio en el archivo de datos. (Se hereda de SqlSmoObject.)
Método protegido GetBindDefaultScript Obtiene el script que enlaza los valores predeterminados especificados por los parámetros defSchema y defName. (Se hereda de SqlSmoObject.)
Método protegido GetBindRuleScript Obtiene el script que especifica las reglas de enlace. (Se hereda de SqlSmoObject.)
Método protegido GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Asigna un parámetro booleano del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Asigna una propiedad booleana del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetDateTimeParameter Asigna la propiedad datetime del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetDateTimeParameterAsInt Asigna la propiedad datetime del objeto SqlSmoObject como un valor entero si la propiedad datetime no es NULL. (Se hereda de SqlSmoObject.)
Método protegido GetDBName No haga referencia directamente a este miembro en el código. Admite la infraestructura de SQL Server. Gets the database name that is associated with the object. (Se hereda de AgentObjectBase.)
Método protegido GetEnumParameter Asigna una propiedad enumeration del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetFragOptionString Obtiene un objeto FragmentationOption como un valor de cadena. (Se hereda de SqlSmoObject.)
Método protegido GetGuidParameter Asigna una propiedad Guid del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método público GetHashCode (Se hereda de Object.)
Método protegido GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Asigna un parámetro del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Asigna un parámetro del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetPropValue Obtiene un valor de propiedad del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetPropValueOptional Obtiene un valor de propiedad del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetPropValueOptionalAllowNull Obtiene un valor de propiedad del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetRealValue Obtiene un valor de propiedad del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetScriptingOptionsForCreate Obtiene ScriptingOptions para el objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetServerName Obtiene el nombre de la instancia de SQL Server con la que está asociado el objeto. (Se hereda de SqlSmoObject.)
Método protegido GetServerObject Obtiene el servidor del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetSqlServerVersionName Obtiene el nombre de la versión de la instancia de SQL Server con la que está asociado el objeto. (Se hereda de SqlSmoObject.)
Método protegido GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Asigna un parámetro de cadena del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Asigna un parámetro de cadena del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetTimeSpanParameterAsInt Asigna un parámetro de intervalo de tiempo del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método público GetType (Se hereda de Object.)
Método protegido GetUrnRecursive(StringBuilder) Asigna un objeto Urn del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido GetUrnRecursive(StringBuilder, UrnIdOption) Asigna un objeto Urn del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido ImplInitialize Inicializa los campos del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método público Initialize() () () () Inicializa el objeto y fuerza la carga de las propiedades. (Se hereda de SqlSmoObject.)
Método público Initialize(Boolean) Inicializa el objeto y fuerza la carga de las propiedades. (Se hereda de SqlSmoObject.)
Método protegido IsObjectDirty Comprueba si se han modificado las propiedades del objeto y los cambios todavía no son persistentes en la instancia de SQL Server. (Se hereda de SqlSmoObject.)
Método protegido IsObjectInitialized Comprueba si se ha inicializado el objeto. (Se hereda de SqlSmoObject.)
Método protegido IsObjectInSpace Comprueba si el objeto está aislado o conectado a la instancia de SQL Server. (Se hereda de SqlSmoObject.)
Método protegido IsVersion80SP3 Determina si la versión de SQL Server es SQL Server 2000 con SP3. (Se hereda de SqlSmoObject.)
Método protegido IsVersion90AndAbove Determina si la versión de SQL Server es SQL Server 2005 o posterior. (Se hereda de SqlSmoObject.)
Método protegido MarkDropped Establece SqlSmoState en quitado. (Se hereda de SqlSmoObject.)
Método protegido MarkForDropImpl Establece SqlSmoState en quitado. (Se hereda de SqlSmoObject.)
Método protegido MemberwiseClone (Se hereda de Object.)
Método protegido PostAlter Método que se activa tras modificar el objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido PostCreate Método que se activa tras crear el objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido PostDrop Método que se activa tras quitar el objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método público Refresh Actualiza el objeto y recupera las propiedades la próxima vez que se tiene acceso al objeto. (Se hereda de SqlSmoObject.)
Método público Rename Renames the job step.
Método protegido RenameImpl Solamente se identifica con fines informativos. No compatible. La compatibilidad con versiones posteriores no está garantizada. (Se hereda de NamedSmoObject.)
Método protegido RenameImplWorker Solamente se identifica con fines informativos. No compatible. La compatibilidad con versiones posteriores no está garantizada. (Se hereda de NamedSmoObject.)
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 ScriptAlter Modifica el objeto SqlSmoObject de acuerdo con los parámetros. (Se hereda de SqlSmoObject.)
Método protegido ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. (Se hereda de NamedSmoObject.)
Método protegido ScriptCreate Modifica el objeto SqlSmoObject de acuerdo con los parámetros. (Se hereda de SqlSmoObject.)
Método protegido ScriptDdl Inicia InvalidSmoOperationException. (Se hereda de SqlSmoObject.)
Método protegido ScriptDrop Inicia InvalidSmoOperationException. (Se hereda de SqlSmoObject.)
Método protegido ScriptImpl() () () () Obtiene una colección de los scripts del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido ScriptImpl(ScriptingOptions) Obtiene una colección de los scripts del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido ScriptImplWorker Obtiene una colección de los scripts del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido ScriptOwner Alters the script owner authorization. (Se hereda de NamedSmoObject.)
Método protegido ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. (Se hereda de NamedSmoObject.)
Método protegido SetParentImpl Establece el elemento primario del objeto SqlSmoObject en el parámetro newParent. (Se hereda de SqlSmoObject.)
Método protegido SetSchemaOwned Sets the schema owned value. (Se hereda de NamedSmoObject.)
Método público ToString Devuelve un valor String que representa el objeto al que se hace referencia. (Se hereda de SqlSmoObject.)
Método protegido TouchImpl No implementado. (Se hereda de SqlSmoObject.)
Método protegido UnbindDefaultImpl Desenlaza las columnas predeterminadas del objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Método protegido UnbindRuleImpl Desenlaza las reglas del objeto SqlSmoObject. (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 Representa el evento que se produce cuando se cambia una propiedad. (Se hereda de SqlSmoObject.)
Evento público PropertyMetadataChanged Representa el evento que se produce cuando cambian los metadatos de la propiedad. (Se hereda de SqlSmoObject.)

Arriba

Campos

  Nombre Descripción
Campo protegido m_ExtendedProperties Representa una propiedad definida para extender las propiedades proporcionadas por un objeto SqlSmoObject. (Se hereda de SqlSmoObject.)
Campo protegido singletonParent Representa el elemento primario singleton. (Se hereda de SqlSmoObject.)

Arriba

Implementaciones de interfaces explícitas

  Nombre Descripción
Implementación de interfaces explícitasMétodo privado IAlienObject. . :: . .Discover Detecta las dependencias. 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 Devuelve la raíz del dominio. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject. . :: . .GetParent Obtiene el elemento primario de este objeto. 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 Obtiene el tipo de la propiedad especificada. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject. . :: . .GetPropertyValue Obtiene el valor de la propiedad especificada. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject. . :: . .GetUrn Obtiene el Nombre de recursos uniforme del objeto. 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 Obtiene la instancia que contiene la información sobre el objeto del Nombre de recursos unificado del objeto. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject. . :: . .SetObjectState Establece el estado del objeto en el valor SfcObjectState especificado. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado IAlienObject. . :: . .SetPropertyValue Establece el valor de la propiedad. (Se hereda de SqlSmoObject.)
Implementación de interfaces explícitasMétodo privado ISfcPropertyProvider. . :: . .GetPropertySet Obtiene la referencia de interfaz al conjunto de propiedades de este objeto. No haga referencia directamente a este miembro en el código. Admite la infraestructura de SQL Server. (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. 

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.