Condividi tramite

  • Articolo

Classe JobStep

The JobStep class represents a Microsoft SQL Server job step.

Spazio dei nomi  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Sintassi

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

Nel tipo JobStep sono esposti i membri seguenti.

Costruttori

  Nome Descrizione
Metodo pubblico JobStep() () () () Initializes a new instance of the JobStep class.
Metodo pubblico JobStep(Job, String) Initializes a new instance of the JobStep class for the specified job and with the specified name.

In alto

Proprietà

  Nome Descrizione
Proprietà pubblica Command Gets or sets the command execution string for the job step.
Proprietà pubblica CommandExecutionSuccessCode Gets or sets the process exit code from a command shell process executed as a job step.
Proprietà pubblica DatabaseName Gets or sets the name of the database to which the job step command execution is confined.
Proprietà pubblica DatabaseUserName Gets or sets the database user account that the job step assumes when executing the command string.
Proprietà protetta ExecuteForScalar Ottiene o imposta il valore della proprietà Boolean che specifica se l'oggetto viene impostato su Esegui per l'opzione scalare. Ereditato da SqlSmoObject.
Proprietà pubblica ID Gets or sets the ID value that uniquely identifies the job step.
Proprietà protetta IsTouched Ottiene il valore della proprietà Boolean che specifica se le proprietà dell'oggetto sono state aggiornate ma non sono ancora persistenti nel server. Ereditato da SqlSmoObject.
Proprietà pubblica JobStepFlags The JobStepFlags property is reserved for future use.
Proprietà pubblica LastRunDate Gets the date and time when the job step was last executed.
Proprietà pubblica LastRunDuration Gets the time that the referenced job step took to run when it was last executed.
Proprietà pubblica LastRunOutcome Gets the outcome of the job step when it was last executed.
Proprietà pubblica LastRunRetries Gets the number of retries that were attempted when the job step was last executed.
Proprietà pubblica Name Gets or sets the name of the object. Ereditato da NamedSmoObject.
Proprietà protetta ObjectInSpace Ottiene il valore della proprietà Boolean che specifica se l'oggetto esiste in isolamento o se è connesso direttamente o indirettamente all'istanza di SQL Server. Ereditato da SqlSmoObject.
Proprietà pubblica OnFailAction Gets or sets the action to take when the job step finishes execution with failure.
Proprietà pubblica OnFailStep Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of failure.
Proprietà pubblica OnSuccessAction Gets or sets the action to take when the job step finishes execution with success.
Proprietà pubblica OnSuccessStep Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of success.
Proprietà pubblica OSRunPriority Gets or sets the execution thread scheduling for job steps executing operating system tasks.
Proprietà pubblica OutputFileName Gets or sets the name and path of the operating system file that records job step result message text.
Proprietà pubblica Parent Gets or sets the Job object that is the parent of the JobStep object.
Proprietà pubblica Properties Ottiene una raccolta di oggetti Property che rappresentano le proprietà dell'oggetto. Ereditato da SqlSmoObject.
Proprietà pubblica ProxyName Gets or sets the name of the Microsoft SQL Server Agent proxy account that is required by the job step.
Proprietà pubblica RetryAttempts Gets or sets the maximum number of times a job step is retried before it is returned with a completion status of failure.
Proprietà pubblica 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.
Proprietà protetta ScalarResult Ottiene il risultato scalare per l'oggetto a cui si fa riferimento. Ereditato da SqlSmoObject.
Proprietà pubblica Server Gets or sets the name of the server on which the job step runs.
Proprietà pubblica State Gets the state of the referenced object. Ereditato da SmoObjectBase.
Proprietà pubblica SubSystem Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text.
Proprietà pubblica Urn Ottiene il valore dell'indirizzo URN (Uniform Resource Name) che identifica in modo univoco l'oggetto. Ereditato da SqlSmoObject.
Proprietà pubblica UserData Gets or sets user-defined data associated with the referenced object. Ereditato da SmoObjectBase.

In alto

Metodi

  Nome Descrizione
Metodo protetto AddDatabaseContext(StringCollection) Aggiungere il contesto del database alla raccolta di query identificate dal parametro queries. Ereditato da SqlSmoObject.
Metodo protetto AddDatabaseContext(StringCollection, ScriptingOptions) Aggiungere il contesto del database alla raccolta di query identificate dal parametro queries e utilizzando le opzioni di scripting specificate. Ereditato da SqlSmoObject.
Metodo pubblico Alter Updates any JobStep object property changes on instance of Microsoft SQL Server. 
Metodo protetto AlterImpl Attiva l'evento modificato dall'oggetto. Ereditato da SqlSmoObject.
Metodo protetto AlterImplFinish Metodo chiamato quando l'evento modificato dall'oggetto viene completato. Ereditato da SqlSmoObject.
Metodo protetto AlterImplInit Metodo chiamato quando l'evento modificato dall'oggetto viene inizializzato. Ereditato da SqlSmoObject.
Metodo protetto AlterImplWorker Chiama i metodi Alter. Ereditato da SqlSmoObject.
Metodo protetto BindDefaultImpl Associa gli elementi predefiniti identificati dai parametri. Ereditato da SqlSmoObject.
Metodo protetto BindRuleImpl Associa lo schema della regola alla regola e alle colonne identificate dai parametri. Ereditato da SqlSmoObject.
Metodo protetto CheckCollation Verifica l'ordine delle opzioni di scripting mediante il metodo delle regole di confronto identificato dal parametro collationName. Ereditato da SqlSmoObject.
Metodo protetto CheckObjectState() () () () Convalida lo stato dell'oggetto a cui si fa riferimento. Ereditato da SqlSmoObject.
Metodo protetto CheckObjectState(Boolean) Convalida lo stato dell'oggetto a cui si fa riferimento con l'opzione che specifica di generare un'eccezione se l'oggetto non è stato ancora creato. Ereditato da SqlSmoObject.
Metodo protetto CheckObjectStateImpl Verifica lo stato di un oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto CheckVersion100 Verifica se la versione di SQL Server è SQL Server 2008. Ereditato da SqlSmoObject.
Metodo protetto CheckVersion80 Verifica la validità dell'oggetto in SQL Server 2000. Ereditato da SqlSmoObject.
Metodo protetto CheckVersion80SP3 Verifica la validità dell'oggetto in SQL Server 2000 SP3. Ereditato da SqlSmoObject.
Metodo protetto CheckVersion90 Verificare la validità dell'oggetto in SQL Server 2005. Ereditato da SqlSmoObject.
Metodo protetto CheckVersionBelow90 Verifica se la versione di SQL Server è precedente a SQL Server 2005. Ereditato da SqlSmoObject.
Metodo protetto CleanObject Imposta l'oggetto su uno stato non modificato. Ereditato da SqlSmoObject.
Metodo pubblico Create Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object.
Metodo protetto CreateImpl Crea un oggetto con opzioni di scripting. Ereditato da SqlSmoObject.
Metodo protetto CreateImplFinish Metodo chiamato quando l'evento Create viene completato. Ereditato da SqlSmoObject.
Metodo protetto CreateImplInit Metodo chiamato quando l'evento Create viene inizializzato. Ereditato da SqlSmoObject.
Metodo pubblico DeleteLogs(DateTime) Deletes job step log files that are older than the specified date.
Metodo pubblico DeleteLogs(Int32) Deletes job step log files that have log numbers lower than the specified value.
Metodo pubblico Discover Individua un elenco di tipo Object. Ereditato da SqlSmoObject.
Metodo pubblico Drop Removes the referenced job step.
Metodo protetto DropImpl Elimina un oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto DropImplWorker Chiama i metodi Drop. Ereditato da SqlSmoObject.
Metodo pubblico EnumLogs Returns an enumerated list of the job step log files.
Metodo protetto EnumScriptImpl Enumera gli script specificati dal parametro so. Ereditato da SqlSmoObject.
Metodo protetto EnumScriptImplWorker Chiama i metodi che enumerano gli script specificati dal parametro so. Ereditato da SqlSmoObject.
Metodo protetto EnumScriptImplWorkerSOChanged Restituisce una stringa IEnumerable che descrive le opzioni di scripting per un oggetto. Ereditato da SqlSmoObject.
Metodo pubblico Equals Ereditato da Object.
Metodo protetto ExecuteNonQuery Ereditato da SqlSmoObject.
Metodo protetto Finalize Ereditato da Object.
Metodo protetto FormatSqlVariant Formatta un oggetto come tipo SqlVariant. Ereditato da SqlSmoObject.
Metodo protetto GenerateDataSpaceFileStreamScript Genera uno script per creare file di dati. Ereditato da SqlSmoObject.
Metodo protetto GenerateDataSpaceScript Genera uno script per allocare spazio nel file di dati. Ereditato da SqlSmoObject.
Metodo protetto GetBindDefaultScript Ottiene lo script che associa le impostazioni predefinite specificate dai parametri defSchema e defName. Ereditato da SqlSmoObject.
Metodo protetto GetBindRuleScript Ottiene lo script che specifica le regole di associazione. Ereditato da SqlSmoObject.
Metodo protetto GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Assegna un parametro booleano dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Assegna una proprietà booleana dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetDateTimeParameter Assegna la proprietà datetime dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetDateTimeParameterAsInt Assegna la proprietà datetime dell'oggetto SqlSmoObject come valore intero se la proprietà datetime è diversa da null. Ereditato da SqlSmoObject.
Metodo protetto GetDBName Non fare riferimento direttamente a questo membro nel codice. Supporta l'infrastruttura di SQL Server. Gets the database name that is associated with the object. Ereditato da AgentObjectBase.
Metodo protetto GetEnumParameter Assegna una proprietà di enumerazione dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetFragOptionString Ottiene un oggetto FragmentationOption come valore stringa. Ereditato da SqlSmoObject.
Metodo protetto GetGuidParameter Assegna una proprietà Guid dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo pubblico GetHashCode Ereditato da Object.
Metodo protetto GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Assegna un parametro dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Assegna un parametro dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetPropValue Ottiene un valore della proprietà dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetPropValueOptional Ottiene un valore della proprietà dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetPropValueOptionalAllowNull Ottiene un valore della proprietà dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetRealValue Ottiene un valore della proprietà dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetScriptingOptionsForCreate Ottiene l'oggetto ScriptingOptions per l'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetServerName Ottiene il nome dell'istanza di SQL Server a cui è associato l'oggetto. Ereditato da SqlSmoObject.
Metodo protetto GetServerObject Ottiene il server dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetSqlServerVersionName Ottiene il nome della versione dell'istanza di SQL Server a cui è associato l'oggetto. Ereditato da SqlSmoObject.
Metodo protetto GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Assegna un parametro stringa dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Assegna un parametro stringa dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetTimeSpanParameterAsInt Assegna un parametro periodo di tempo dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo pubblico GetType Ereditato da Object.
Metodo protetto GetUrnRecursive(StringBuilder) Assegna un oggetto Urn dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto GetUrnRecursive(StringBuilder, UrnIdOption) Assegna un oggetto Urn dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto ImplInitialize Inizializza i campi dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo pubblico Initialize() () () () Inizializza l'oggetto e forza il caricamento delle proprietà. Ereditato da SqlSmoObject.
Metodo pubblico Initialize(Boolean) Inizializza l'oggetto e forza il caricamento delle proprietà. Ereditato da SqlSmoObject.
Metodo protetto IsObjectDirty Verifica se le proprietà dell'oggetto sono state modificate e se le modifiche non sono già persistenti nell'istanza di SQL Server. Ereditato da SqlSmoObject.
Metodo protetto IsObjectInitialized Verifica se l'oggetto è stato inizializzato. Ereditato da SqlSmoObject.
Metodo protetto IsObjectInSpace Verifica se l'oggetto è isolato o connesso all'istanza di SQL Server. Ereditato da SqlSmoObject.
Metodo protetto IsVersion80SP3 Determina se la versione di SQL Server è SQL Server 2000 con SP3. Ereditato da SqlSmoObject.
Metodo protetto IsVersion90AndAbove Determina se la versione di SQL Server è SQL Server 2005 o successiva. Ereditato da SqlSmoObject.
Metodo protetto MarkDropped Imposta l'oggetto SqlSmoState da eliminare. Ereditato da SqlSmoObject.
Metodo protetto MarkForDropImpl Imposta l'oggetto SqlSmoState da eliminare. Ereditato da SqlSmoObject.
Metodo protetto MemberwiseClone Ereditato da Object.
Metodo protetto PostAlter Metodo attivato dopo che l'oggetto SqlSmoObject viene modificato. Ereditato da SqlSmoObject.
Metodo protetto PostCreate Metodo attivato dopo la creazione dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto PostDrop Metodo attivato dopo l'eliminazione dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo pubblico Refresh Aggiorna l'oggetto e recupera le proprietà al successivo accesso all'oggetto. Ereditato da SqlSmoObject.
Metodo pubblico Rename Renames the job step.
Metodo protetto RenameImpl Identificato solo a scopo informativo. Non supportato. Non è garantita la compatibilità con le versioni future. Ereditato da NamedSmoObject.
Metodo protetto RenameImplWorker Identificato solo a scopo informativo. Non supportato. Non è garantita la compatibilità con le versioni future. Ereditato da NamedSmoObject.
Metodo pubblico Script() () () () Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step.
Metodo pubblico 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.
Metodo protetto ScriptAlter Modifica l'oggetto SqlSmoObject in base ai parametri. Ereditato da SqlSmoObject.
Metodo protetto ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. Ereditato da NamedSmoObject.
Metodo protetto ScriptCreate Modifica l'oggetto SqlSmoObject in base ai parametri. Ereditato da SqlSmoObject.
Metodo protetto ScriptDdl Genera un oggetto InvalidSmoOperationException. Ereditato da SqlSmoObject.
Metodo protetto ScriptDrop Genera un oggetto InvalidSmoOperationException. Ereditato da SqlSmoObject.
Metodo protetto ScriptImpl() () () () Ottiene una raccolta di script dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto ScriptImpl(ScriptingOptions) Ottiene una raccolta di script dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto ScriptImplWorker Ottiene una raccolta di script dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto ScriptOwner Alters the script owner authorization. Ereditato da NamedSmoObject.
Metodo protetto ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. Ereditato da NamedSmoObject.
Metodo protetto SetParentImpl Imposta l'elemento padre dell'oggetto SqlSmoObject sul parametro newParent. Ereditato da SqlSmoObject.
Metodo protetto SetSchemaOwned Sets the schema owned value. Ereditato da NamedSmoObject.
Metodo pubblico ToString Restituisce un oggetto String che rappresenta l'oggetto a cui si fa riferimento. Ereditato da SqlSmoObject.
Metodo protetto TouchImpl Non implementato. Ereditato da SqlSmoObject.
Metodo protetto UnbindDefaultImpl Annulla l'associazione delle colonne predefinite dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo protetto UnbindRuleImpl Annulla l'associazione delle regole dell'oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Metodo pubblico Validate Validates the state of an object. Ereditato da SmoObjectBase.

In alto

Eventi

  Nome Descrizione
Evento pubblico PropertyChanged Rappresenta l'evento che si verifica quando viene modificata una proprietà. Ereditato da SqlSmoObject.
Evento pubblico PropertyMetadataChanged Rappresenta l'evento che si verifica quando vengono modificati i metadati di una proprietà. Ereditato da SqlSmoObject.

In alto

Campi

  Nome Descrizione
Campo protetto m_ExtendedProperties Rappresenta una proprietà definita per estendere le proprietà fornite da un oggetto SqlSmoObject. Ereditato da SqlSmoObject.
Campo protetto singletonParent Rappresenta il padre singleton. Ereditato da SqlSmoObject.

In alto

Implementazioni esplicite dell'interfaccia

  Nome Descrizione
Implementazione esplicita dell'interfacciaMetodo privato IAlienObject. . :: . .Discover Individua eventuali dipendenze. Non fare riferimento direttamente a questo membro nel codice. Supporta l'infrastruttura di SQL Server. Ereditato da SqlSmoObject.
Implementazione esplicita dell'interfacciaMetodo privato IAlienObject. . :: . .GetDomainRoot Restituisce la radice del dominio. Ereditato da SqlSmoObject.
Implementazione esplicita dell'interfacciaMetodo privato IAlienObject. . :: . .GetParent Ottiene l'elemento padre di questo oggetto. Non fare riferimento direttamente a questo membro nel codice. Supporta l'infrastruttura di SQL Server. Ereditato da SqlSmoObject.
Implementazione esplicita dell'interfacciaMetodo privato IAlienObject. . :: . .GetPropertyType Ottiene il tipo della proprietà specificata. Ereditato da SqlSmoObject.
Implementazione esplicita dell'interfacciaMetodo privato IAlienObject. . :: . .GetPropertyValue Ottiene il valore della proprietà specificata. Ereditato da SqlSmoObject.
Implementazione esplicita dell'interfacciaMetodo privato IAlienObject. . :: . .GetUrn Ottiene l'URN (Unified Resource Name) dell'oggetto. Non fare riferimento direttamente a questo membro nel codice. Supporta l'infrastruttura di SQL Server. Ereditato da SqlSmoObject.
Implementazione esplicita dell'interfacciaMetodo privato IAlienObject. . :: . .Resolve Ottiene l'istanza che contiene le informazioni sull'oggetto dall'URN (Unified Resource Name) dell'oggetto. Ereditato da SqlSmoObject.
Implementazione esplicita dell'interfacciaMetodo privato IAlienObject. . :: . .SetObjectState Imposta lo stato dell'oggetto sul valore SfcObjectState specificato. Ereditato da SqlSmoObject.
Implementazione esplicita dell'interfacciaMetodo privato IAlienObject. . :: . .SetPropertyValue Imposta il valore della proprietà. Ereditato da SqlSmoObject.
Implementazione esplicita dell'interfacciaMetodo privato ISfcPropertyProvider. . :: . .GetPropertySet Ottiene il riferimento di interfaccia al set di proprietà di questo oggetto. Non fare riferimento direttamente a questo membro nel codice. Supporta l'infrastruttura di SQL Server. Ereditato da SqlSmoObject.

In alto

Osservazioni

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

Tutti i membri statici pubblici (Shared in Microsoft Visual Basic) di questo tipo sono sicuri per le operazioni a thread multipli. Non è invece garantita la sicurezza dei membri dell'istanza. 

Protezione dei thread

I membri static (Shared in Visual Basic) pubblici di questo tipo sono affidabili. Non è invece garantita la sicurezza dei membri dell'istanza.