Partilhar via

Classe JobStep

  • Artigo

The JobStep class represents a Microsoft SQL Server job step.

Hierarquia de herança

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

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

Sintaxe

'Declaração
<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

O tipo JobStep expõe os membros a seguir.

Construtores

  Nome Descrição
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.

Início

Propriedades

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

Início

Métodos

  Nome Descrição
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. (Herdado 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 (Herdado de Object.)
Método protegido FormatSqlVariant Formats an object as SqlVariant type. (Herdado de SqlSmoObject.)
Método protegido GetContextDB Gets the context database that is associated with this object. (Herdado de SqlSmoObject.)
Método protegido GetDBName Gets the database name that is associated with the object. (Herdado de AgentObjectBase.)
Método público GetHashCode (Herdado de Object.)
Método protegido GetPropValue Gets a property value of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptional Gets a property value of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método protegido GetServerObject Gets the server of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método público GetType (Herdado de Object.)
Método público Initialize() Initializes the object and forces the properties be loaded. (Herdado de SqlSmoObject.)
Método público Initialize(Boolean) Initializes the object and forces the properties be loaded. (Herdado de SqlSmoObject.)
Método protegido IsObjectInitialized Verifies whether the object has been initialized. (Herdado de SqlSmoObject.)
Método protegido IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Herdado de SqlSmoObject.)
Método público Refresh Refreshes the object and retrieves properties when the object is next accessed. (Herdado 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. (Herdado de SqlSmoObject.)
Método público ToString Returns a String that represents the referenced object. (Herdado de SqlSmoObject.)
Método público Validate Validates the state of an object. (Herdado de SmoObjectBase.)

Início

Eventos

  Nome Descrição
Evento público PropertyChanged Represents the event that occurs when a property is changed. (Herdado de SqlSmoObject.)
Evento público PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Herdado de SqlSmoObject.)

Início

Implementações de interfaces explícitas

  Nome Descrição
Implementações de interfaces explícitasMétodo privado IAlienObject.Discover Discovers any dependencies. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetDomainRoot Returns the root of the domain. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetParent Gets the parent of this object. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetPropertyType Gets the type of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetPropertyValue Gets the value of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações 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. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetPropertyValue Sets the property value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Herdado de SqlSmoObject.)

Início

Comentários

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

Qualquer membro público estático (Compartilhado no Microsoft Visual Basic) desse tipo é seguro para operações multi-threaded. Não há garantia de que qualquer membro de instância seja seguro para threads.  

Exemplos

Agendando tarefas administrativas automáticas no SQL Server Agent

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Management.Smo.Agent

Outros recursos

Agendando tarefas administrativas automáticas no SQL Server Agent

Tarefas de administração automatizadas (SQL Server Agent)

sp_help_jobstep (Transact-SQL)