Classe JobStep

  • Article

The JobStep class represents a Microsoft SQL Server job step.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Management.Smo.Agent
Assembly :  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Syntaxe

'Déclaration
<SfcElementTypeAttribute("Step")> _
Public NotInheritable Class JobStep _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
'Utilisation
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

Le type JobStep expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique JobStep() Initializes a new instance of the JobStep class.
Méthode publique JobStep(Job, String) Initializes a new instance of the JobStep class for the specified job and with the specified name.

Haut de la page

Propriétés

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

Haut de la page

Méthodes

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

Haut de la page

Événements

  Nom Description
Événement public PropertyChanged Represents the event that occurs when a property is changed. (hérité de SqlSmoObject.)
Événement public PropertyMetadataChanged Represents the event that occurs when property metadata changes. (hérité de SqlSmoObject.)

Haut de la page

Implémentations d'interfaces explicites

  Nom Description
Implémentation d'interface expliciteMéthode privée IAlienObject.Discover Discovers any dependencies. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetDomainRoot Returns the root of the domain. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetParent Gets the parent of this object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetPropertyType Gets the type of the specified property. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetPropertyValue Gets the value of the specified property. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.SetPropertyValue Sets the property value. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (hérité de SqlSmoObject.)

Haut de la page

Notes

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

Tout membre statique public (Partagé dans Microsoft Visual Basic) de ce type est sûr dans le cadre des opérations à plusieurs threads. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.  

Exemples

Planification des tâches administratives automatiques dans l'Agent SQL Server

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Management.Smo.Agent

Autres ressources

Planification des tâches administratives automatiques dans l'Agent SQL Server

Tâches d'administration automatisée (Agent SQL Server)

sp_help_jobstep (Transact-SQL)