• Article

Classe JobStep

The JobStep class represents a Microsoft SQL Server job step.

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é protégée ExecuteForScalar Obtient ou définit la valeur de la propriété Boolean qui spécifie si l'objet est défini selon l'option permettant l'exécution qui retourne une valeur scalaire. (hérité de SqlSmoObject.)
Propriété publique ID Gets or sets the ID value that uniquely identifies the job step.
Propriété protégée IsTouched Obtient la valeur de la propriété Boolean qui spécifie si les propriétés de l'objet ont été mises à jour mais n'ont pas encore été rendues persistantes sur le serveur. (hérité de SqlSmoObject.)
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é protégée ObjectInSpace Obtient la valeur de la propriété Boolean qui spécifie si l'objet existe dans l'isolation, ou s'il est connecté directement ou indirectement à l'instance de SQL Server. (hérité de SqlSmoObject.)
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 Obtient une collection d'objets Property qui représentent les propriétés de l'objet. (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é protégée ScalarResult Obtient le résultat scalaire pour l'objet référencé. (hérité de SqlSmoObject.)
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 Obtient la valeur URN (Uniform Resource Name) qui identifie de façon unique l'objet. (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 protégée AddDatabaseContext(StringCollection) Ajoute le contexte de base de données à la collection de requêtes identifiée par le paramètre queries. (hérité de SqlSmoObject.)
Méthode protégée AddDatabaseContext(StringCollection, ScriptingOptions) Ajoute le contexte de base de données à la collection de requêtes identifiée par le paramètre queries, à l'aide des options de script spécifiées. (hérité de SqlSmoObject.)
Méthode publique Alter Updates any JobStep object property changes on instance of Microsoft SQL Server. 
Méthode protégée AlterImpl Active l'événement d'objet modifié. (hérité de SqlSmoObject.)
Méthode protégée AlterImplFinish Méthode appelée lorsque l'événement d'objet modifié est terminé. (hérité de SqlSmoObject.)
Méthode protégée AlterImplInit Méthode appelée lorsque l'événement d'objet modifié est initialisé. (hérité de SqlSmoObject.)
Méthode protégée AlterImplWorker Appelle les méthodes de modification. (hérité de SqlSmoObject.)
Méthode protégée BindDefaultImpl Lie les éléments par défaut identifiés par les paramètres. (hérité de SqlSmoObject.)
Méthode protégée BindRuleImpl Lie le schéma de règle à la règle et aux colonnes identifiées par les paramètres. (hérité de SqlSmoObject.)
Méthode protégée CheckCollation Vérifie l'ordre des options de script par la méthode de classement identifiée par le paramètre collationName. (hérité de SqlSmoObject.)
Méthode protégée CheckObjectState() () () () Valide l'état de l'objet référencé. (hérité de SqlSmoObject.)
Méthode protégée CheckObjectState(Boolean) Valide l'état de l'objet référencé avec l'option permettant de spécifier qu'une exception est levée si l'objet n'est pas encore créé. (hérité de SqlSmoObject.)
Méthode protégée CheckObjectStateImpl Vérifie l'état de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée CheckVersion100 Vérifie si la version de SQL Server est SQL Server 2008. (hérité de SqlSmoObject.)
Méthode protégée CheckVersion80 Vérifie la validité de l'objet sur SQL Server 2000. (hérité de SqlSmoObject.)
Méthode protégée CheckVersion80SP3 Vérifie la validité de l'objet sur SQL Server 2000 SP3. (hérité de SqlSmoObject.)
Méthode protégée CheckVersion90 Vérifie la validité de l'objet sur SQL Server 2005. (hérité de SqlSmoObject.)
Méthode protégée CheckVersionBelow90 Vérifie si la version de SQL Server est antérieure à SQL Server 2005. (hérité de SqlSmoObject.)
Méthode protégée CleanObject Définit l'objet sur l'état non modifié. (hérité de SqlSmoObject.)
Méthode publique Create Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object.
Méthode protégée CreateImpl Crée un objet avec les options de script. (hérité de SqlSmoObject.)
Méthode protégée CreateImplFinish Méthode appelée lorsque l'événement de création est terminé. (hérité de SqlSmoObject.)
Méthode protégée CreateImplInit Méthode appelée lorsque l'événement de création est initialisé. (hérité de SqlSmoObject.)
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 Découvre une liste de type Object. (hérité de SqlSmoObject.)
Méthode publique Drop Removes the referenced job step.
Méthode protégée DropImpl Supprime un SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée DropImplWorker Appelle les méthodes de suppression. (hérité de SqlSmoObject.)
Méthode publique EnumLogs Returns an enumerated list of the job step log files.
Méthode protégée EnumScriptImpl Énumère des scripts spécifiés par le paramètre so. (hérité de SqlSmoObject.)
Méthode protégée EnumScriptImplWorker Appelle les méthodes qui énumèrent des scripts spécifiés par le paramètre so. (hérité de SqlSmoObject.)
Méthode protégée EnumScriptImplWorkerSOChanged Retourne une chaîne IEnumerable qui décrit les options de script pour un objet. (hérité de SqlSmoObject.)
Méthode publique Equals (hérité de Object.)
Méthode protégée ExecuteNonQuery (hérité de SqlSmoObject.)
Méthode protégée Finalize (hérité de Object.)
Méthode protégée FormatSqlVariant Met en forme un objet en tant que type SqlVariant. (hérité de SqlSmoObject.)
Méthode protégée GenerateDataSpaceFileStreamScript Génère un script pour créer un fichier de données. (hérité de SqlSmoObject.)
Méthode protégée GenerateDataSpaceScript Génère un script pour allouer l'espace dans le fichier de données. (hérité de SqlSmoObject.)
Méthode protégée GetBindDefaultScript Obtient le script qui lie les valeurs par défaut spécifiées par les paramètres defName et defSchema. (hérité de SqlSmoObject.)
Méthode protégée GetBindRuleScript Obtient le script qui spécifie les règles de liaison. (hérité de SqlSmoObject.)
Méthode protégée GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Affecte un paramètre booléen du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Affecte une propriété booléenne du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetDateTimeParameter Affecte une propriété datetime du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetDateTimeParameterAsInt Affecte la propriété datetime du SqlSmoObject comme une valeur entière, si la propriété datetime n'est pas Null. (hérité de SqlSmoObject.)
Méthode protégée GetDBName Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. Gets the database name that is associated with the object. (hérité de AgentObjectBase.)
Méthode protégée GetEnumParameter Affecte une propriété d'énumération du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetFragOptionString Obtient un objet FragmentationOption en tant que valeur de chaîne. (hérité de SqlSmoObject.)
Méthode protégée GetGuidParameter Affecte une propriété Guid du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode publique GetHashCode (hérité de Object.)
Méthode protégée GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Affecte un paramètre du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Affecte un paramètre du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetPropValue Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetPropValueOptional Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetPropValueOptionalAllowNull Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetRealValue Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetScriptingOptionsForCreate Obtient ScriptingOptions pour l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetServerName Obtient le nom de l'instance de SQL Server à laquelle l'objet est associé. (hérité de SqlSmoObject.)
Méthode protégée GetServerObject Obtient le serveur de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetSqlServerVersionName Obtient le nom de version de l'instance de SQL Server à laquelle l'objet est associé. (hérité de SqlSmoObject.)
Méthode protégée GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Affecte un paramètre de chaîne de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Affecte un paramètre de chaîne de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetTimeSpanParameterAsInt Affecte un paramètre d'intervalle de temps de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode publique GetType (hérité de Object.)
Méthode protégée GetUrnRecursive(StringBuilder) Affecte un objet Urn de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée GetUrnRecursive(StringBuilder, UrnIdOption) Affecte un objet Urn de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée ImplInitialize Initialise les champs de l'objet SqlSmoObject. (hérité de SqlSmoObject.)
Méthode publique Initialize() () () () Initialise l'objet et force le chargement des propriétés. (hérité de SqlSmoObject.)
Méthode publique Initialize(Boolean) Initialise l'objet et force le chargement des propriétés. (hérité de SqlSmoObject.)
Méthode protégée IsObjectDirty Vérifie si les propriétés de l'objet ont été modifiées et si les modifications n'ont pas encore été rendues persistantes sur l'instance de SQL Server. (hérité de SqlSmoObject.)
Méthode protégée IsObjectInitialized Vérifie si l'objet a été initialisé. (hérité de SqlSmoObject.)
Méthode protégée IsObjectInSpace Vérifie si l'objet est isolé ou connecté à l'instance de SQL Server. (hérité de SqlSmoObject.)
Méthode protégée IsVersion80SP3 Détermine si la version de SQL Server est SQL Server 2000 avec SP3. (hérité de SqlSmoObject.)
Méthode protégée IsVersion90AndAbove Détermine si la version de SQL Server est SQL Server 2005 ou une version ultérieure. (hérité de SqlSmoObject.)
Méthode protégée MarkDropped Définit l'objet SqlSmoState à supprimer. (hérité de SqlSmoObject.)
Méthode protégée MarkForDropImpl Définit l'objet SqlSmoState à supprimer. (hérité de SqlSmoObject.)
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode protégée PostAlter Méthode activée après la modification du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée PostCreate Méthode activée après la création du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée PostDrop Méthode activée après la suppression du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode publique Refresh Actualise l'objet et récupère les propriétés lors du prochain accès à l'objet. (hérité de SqlSmoObject.)
Méthode publique Rename Renames the job step.
Méthode protégée RenameImpl Identifié à titre d'information uniquement. Non pris en charge. La compatibilité future n'est pas garantie. (hérité de NamedSmoObject.)
Méthode protégée RenameImplWorker Identifié à titre d'information uniquement. Non pris en charge. La compatibilité future n'est pas garantie. (hérité de NamedSmoObject.)
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 ScriptAlter Modifie l'objet SqlSmoObject d'après les paramètres. (hérité de SqlSmoObject.)
Méthode protégée ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. (hérité de NamedSmoObject.)
Méthode protégée ScriptCreate Modifie l'objet SqlSmoObject d'après les paramètres. (hérité de SqlSmoObject.)
Méthode protégée ScriptDdl Lève une exception InvalidSmoOperationException. (hérité de SqlSmoObject.)
Méthode protégée ScriptDrop Lève une exception InvalidSmoOperationException. (hérité de SqlSmoObject.)
Méthode protégée ScriptImpl() () () () Obtient une collection de scripts du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée ScriptImpl(ScriptingOptions) Obtient une collection de scripts du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée ScriptImplWorker Obtient une collection de scripts du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée ScriptOwner Alters the script owner authorization. (hérité de NamedSmoObject.)
Méthode protégée ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. (hérité de NamedSmoObject.)
Méthode protégée SetParentImpl Définit le parent du SqlSmoObject sur le paramètre newParent. (hérité de SqlSmoObject.)
Méthode protégée SetSchemaOwned Sets the schema owned value. (hérité de NamedSmoObject.)
Méthode publique ToString Retourne un String qui représente l'objet référencé. (hérité de SqlSmoObject.)
Méthode protégée TouchImpl Non implémenté. (hérité de SqlSmoObject.)
Méthode protégée UnbindDefaultImpl Annule la liaison des colonnes par défaut du SqlSmoObject. (hérité de SqlSmoObject.)
Méthode protégée UnbindRuleImpl Annule la liaison des règles du SqlSmoObject. (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 Représente l'événement qui se produit lorsqu'une propriété est modifiée. (hérité de SqlSmoObject.)
Événement public PropertyMetadataChanged Représente l'événement qui se produit lorsque les métadonnées de la propriété sont modifiées. (hérité de SqlSmoObject.)

Haut de la page

Champs

  Nom Description
Champ protégé m_ExtendedProperties Représente une propriété définie pour étendre les propriétés fournies par un SqlSmoObject. (hérité de SqlSmoObject.)
Champ protégé singletonParent Représente le parent de singleton. (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 Découvre les éventuelles dépendances. Ne référencez pas directement 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 Retourne la racine du domaine. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .GetParent Obtient le parent de cet objet. Ne référencez pas directement 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 Obtient le type de la propriété spécifiée. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .GetPropertyValue Obtient la valeur de la propriété spécifiée. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .GetUrn Obtient l'URN (Uniform Resource Name) de l'objet. Ne référencez pas directement 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 Obtient l'instance qui contient les informations relatives à l'objet de l'URN (Unified Resource Name) de l'objet. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .SetObjectState Définit l'état de l'objet sur la valeur SfcObjectState spécifiée. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject. . :: . .SetPropertyValue Définit la valeur de la propriété. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée ISfcPropertyProvider. . :: . .GetPropertySet Obtient la référence d'interface au jeu de propriétés de cet objet. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (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. 

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.