JobStep-Klasse
The JobStep class represents a Microsoft SQL Server job step.
Vererbungshierarchie
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 (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
<SfcElementTypeAttribute("Step")> _
Public NotInheritable Class JobStep _
Inherits AgentObjectBase _
Implements IAlterable, ICreatable, IDroppable, IRenamable, _
IScriptable
'Usage
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
Der JobStep-Typ macht folgende Elemente verfügbar.
Konstruktoren
Name | Beschreibung | |
---|---|---|
JobStep() () () () | Initializes a new instance of the JobStep class. | |
JobStep(Job, String) | Initializes a new instance of the JobStep class for the specified job and with the specified name. |
Zum Anfang
Eigenschaften
Name | Beschreibung | |
---|---|---|
Command | Gets or sets the command execution string for the job step. | |
CommandExecutionSuccessCode | Gets or sets the process exit code from a command shell process executed as a job step. | |
DatabaseName | Gets or sets the name of the database to which the job step command execution is confined. | |
DatabaseUserName | Gets or sets the database user account that the job step assumes when executing the command string. | |
ExecuteForScalar | Ruft den Boolean-Eigenschaftswert ab, der angibt, ob das Objekt auf die ExecuteForScalar-Option festgelegt ist, oder legt ihn fest. (Geerbt von SqlSmoObject.) | |
ID | Gets or sets the ID value that uniquely identifies the job step. | |
IsTouched | Ruft den Boolean-Eigenschaftswert ab, der angibt, ob die Objekteigenschaften aktualisiert, aber noch nicht permanent auf dem Server gespeichert wurden. (Geerbt von SqlSmoObject.) | |
JobStepFlags | The JobStepFlags property is reserved for future use. | |
LastRunDate | Gets the date and time when the job step was last executed. | |
LastRunDuration | Gets the time that the referenced job step took to run when it was last executed. | |
LastRunOutcome | Gets the outcome of the job step when it was last executed. | |
LastRunRetries | Gets the number of retries that were attempted when the job step was last executed. | |
Name | Gets or sets the name of the object. (Geerbt von NamedSmoObject.) | |
ObjectInSpace | Ruft den Boolean-Eigenschaftswert ab, der angibt, ob das Objekt isoliert vorhanden bzw. direkt oder indirekt mit der SQL Server-Instanz verbunden ist. (Geerbt von SqlSmoObject.) | |
OnFailAction | Gets or sets the action to take when the job step finishes execution with failure. | |
OnFailStep | Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of failure. | |
OnSuccessAction | Gets or sets the action to take when the job step finishes execution with success. | |
OnSuccessStep | Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of success. | |
OSRunPriority | Gets or sets the execution thread scheduling for job steps executing operating system tasks. | |
OutputFileName | Gets or sets the name and path of the operating system file that records job step result message text. | |
Parent | Gets or sets the Job object that is the parent of the JobStep object. | |
Properties | Ruft eine Auflistung von Property-Objekten ab, die die Objekteigenschaften darstellen. (Geerbt von SqlSmoObject.) | |
ProxyName | Gets or sets the name of the Microsoft SQL Server Agent proxy account that is required by the job step. | |
RetryAttempts | Gets or sets the maximum number of times a job step is retried before it is returned with a completion status of failure. | |
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. | |
ScalarResult | Ruft das skalare Ergebnis für das Objekt ab, auf das verwiesen wird. (Geerbt von SqlSmoObject.) | |
Server | Gets or sets the name of the server on which the job step runs. | |
State | Gets the state of the referenced object. (Geerbt von SmoObjectBase.) | |
SubSystem | Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text. | |
Urn | Ruft den Wert der URN (Uniform Resource Name)-Adresse ab, durch den das Objekt eindeutig identifiziert wird. (Geerbt von SqlSmoObject.) | |
UserData | Gets or sets user-defined data associated with the referenced object. (Geerbt von SmoObjectBase.) |
Zum Anfang
Methoden
Name | Beschreibung | |
---|---|---|
AddDatabaseContext(StringCollection) | Fügt der Auflistung der vom queries-Parameter identifizierten Abfragen den Datenbankkontext hinzu. (Geerbt von SqlSmoObject.) | |
AddDatabaseContext(StringCollection, ScriptingOptions) | Fügt der Auflistung der vom queries-Parameter identifizierten Abfragen den Datenbankkontext gemäß den angegebenen Skriptoptionen hinzu. (Geerbt von SqlSmoObject.) | |
Alter | Updates any JobStep object property changes on instance of Microsoft SQL Server. | |
AlterImpl | Aktiviert das Änderungsereignis des Objekts. (Geerbt von SqlSmoObject.) | |
AlterImplFinish | Die Methode, die nach Beendigung des Änderungsereignisses des Objekts aufgerufen wird. (Geerbt von SqlSmoObject.) | |
AlterImplInit | Die Methode, die bei der Initialisierung des Änderungsereignisses des Objekts aufgerufen wird. (Geerbt von SqlSmoObject.) | |
AlterImplWorker | Ruft die ALTER-Methoden auf. (Geerbt von SqlSmoObject.) | |
BindDefaultImpl | Bindet die von den Parametern identifizierten Standardelemente. (Geerbt von SqlSmoObject.) | |
BindRuleImpl | Bindet das Regelschema an die Regel und die Spalten, die von den Parametern identifiziert werden. (Geerbt von SqlSmoObject.) | |
CheckCollation | Überprüft die Reihenfolge der Skriptoptionen anhand der vom collationName-Parameter identifizierten Sortierungsmethode. (Geerbt von SqlSmoObject.) | |
CheckObjectState() () () () | Überprüft den Status des Objekts, auf das verwiesen wird. (Geerbt von SqlSmoObject.) | |
CheckObjectState(Boolean) | Überprüft den Status des Objekts, auf das verwiesen wird. Optional kann angegeben werden, dass eine Ausnahme ausgelöst wird, wenn das Objekt noch nicht erstellt wurde. (Geerbt von SqlSmoObject.) | |
CheckObjectStateImpl | Überprüft den Zustand von SqlSmoObject. (Geerbt von SqlSmoObject.) | |
CheckVersion100 | Überprüft, ob die SQL Server-Version SQL Server 2008 ist. (Geerbt von SqlSmoObject.) | |
CheckVersion80 | Überprüft die Gültigkeit des Objekts für SQL Server 2000. (Geerbt von SqlSmoObject.) | |
CheckVersion80SP3 | Überprüft die Gültigkeit des Objekts für SQL Server 2000 SP3. (Geerbt von SqlSmoObject.) | |
CheckVersion90 | Überprüft die Gültigkeit des Objekts für SQL Server 2005. (Geerbt von SqlSmoObject.) | |
CheckVersionBelow90 | Überprüft, ob die SQL Server-Version älter als SQL Server 2005 ist. (Geerbt von SqlSmoObject.) | |
CleanObject | Legt für das Objekt den unveränderten Zustand fest. (Geerbt von SqlSmoObject.) | |
Create | Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object. | |
CreateImpl | Erstellt ein Objekt mit Skriptoptionen. (Geerbt von SqlSmoObject.) | |
CreateImplFinish | Die Methode, die nach Beendigung des CREATE-Ereignisses aufgerufen wird. (Geerbt von SqlSmoObject.) | |
CreateImplInit | Die Methode, die bei Initialisierung des CREATE-Ereignisses aufgerufen wird. (Geerbt von SqlSmoObject.) | |
DeleteLogs(DateTime) | Deletes job step log files that are older than the specified date. | |
DeleteLogs(Int32) | Deletes job step log files that have log numbers lower than the specified value. | |
Discover | Ermittelt eine Liste vom Typ Object. (Geerbt von SqlSmoObject.) | |
Drop | Removes the referenced job step. | |
DropImpl | Löscht SqlSmoObject. (Geerbt von SqlSmoObject.) | |
DropImplWorker | Ruft die DROP-Methoden auf. (Geerbt von SqlSmoObject.) | |
EnumLogs | Returns an enumerated list of the job step log files. | |
EnumScriptImpl | Listet die vom so-Parameter angegebenen Skripts auf. (Geerbt von SqlSmoObject.) | |
EnumScriptImplWorker | Ruft die Methoden auf, die die vom so-Parameter angegebenen Skripts auflisten. (Geerbt von SqlSmoObject.) | |
EnumScriptImplWorkerSOChanged | Gibt eine IEnumerable-Zeichenfolge zurück, die die Skriptoptionen für ein Objekt beschreibt. (Geerbt von SqlSmoObject.) | |
Equals | (Geerbt von Object.) | |
ExecuteNonQuery | (Geerbt von SqlSmoObject.) | |
Finalize | (Geerbt von Object.) | |
FormatSqlVariant | Formatiert ein Objekt als SqlVariant-Typ. (Geerbt von SqlSmoObject.) | |
GenerateDataSpaceFileStreamScript | Generiert ein Skript zum Erstellen der Datendatei. (Geerbt von SqlSmoObject.) | |
GenerateDataSpaceScript | Generiert ein Skript zum Zuordnen von Speicherplatz in der Datendatei. (Geerbt von SqlSmoObject.) | |
GetBindDefaultScript | Ruft das Skript ab, durch das die vom defSchema-Parameter und defName-Parameter angegebenen Standardwerte gebunden werden. (Geerbt von SqlSmoObject.) | |
GetBindRuleScript | Ruft das Skript ab, das die Bindungsregeln angibt. (Geerbt von SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Weist einen booleschen Parameter von SqlSmoObject zu. (Geerbt von SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Weist eine boolesche Eigenschaft von SqlSmoObject zu. (Geerbt von SqlSmoObject.) | |
GetDateTimeParameter | Weist die datetime-Eigenschaft von SqlSmoObject zu. (Geerbt von SqlSmoObject.) | |
GetDateTimeParameterAsInt | Weist die datetime-Eigenschaft von SqlSmoObject als ganzzahligen Wert zu, wenn die datetime-Eigenschaft nicht NULL ist. (Geerbt von SqlSmoObject.) | |
GetDBName | Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. Gets the database name that is associated with the object. (Geerbt von AgentObjectBase.) | |
GetEnumParameter | Weist die Enumerationseigenschaft von SqlSmoObject zu. (Geerbt von SqlSmoObject.) | |
GetFragOptionString | Ruft ein FragmentationOption-Objekt als Zeichenfolgenwert ab. (Geerbt von SqlSmoObject.) | |
GetGuidParameter | Weist eine Guid-Eigenschaft von SqlSmoObject zu. (Geerbt von SqlSmoObject.) | |
GetHashCode | (Geerbt von Object.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Weist einen Parameter von SqlSmoObject zu. (Geerbt von SqlSmoObject.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Weist einen Parameter von SqlSmoObject zu. (Geerbt von SqlSmoObject.) | |
GetPropValue | Ruft einen Eigenschaftswert des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.) | |
GetPropValueOptional | Ruft einen Eigenschaftswert des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.) | |
GetPropValueOptionalAllowNull | Ruft einen Eigenschaftswert des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.) | |
GetRealValue | Ruft einen Eigenschaftswert des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.) | |
GetScriptingOptionsForCreate | Ruft ScriptingOptions für das SqlSmoObject-Objekt ab. (Geerbt von SqlSmoObject.) | |
GetServerName | Ruft den Namen der SQL Server-Instanz ab, der das Objekt zugeordnet ist. (Geerbt von SqlSmoObject.) | |
GetServerObject | Ruft den Server des SqlSmoObject-Objekts ab. (Geerbt von SqlSmoObject.) | |
GetSqlServerVersionName | Ruft den Versionsnamen der SQL Server-Instanz ab, der das Objekt zugeordnet ist. (Geerbt von SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Weist einen Zeichenfolgenparameter des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Weist einen Zeichenfolgenparameter des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.) | |
GetTimeSpanParameterAsInt | Weist einen Zeitraumparameter des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.) | |
GetType | (Geerbt von Object.) | |
GetUrnRecursive(StringBuilder) | Weist ein Urn-Objekt des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | Weist ein Urn-Objekt des SqlSmoObject-Objekts zu. (Geerbt von SqlSmoObject.) | |
ImplInitialize | Initialisiert die Felder des SqlSmoObject-Objekts. (Geerbt von SqlSmoObject.) | |
Initialize() () () () | Initialisiert das Objekt und erzwingt das Laden der Eigenschaften. (Geerbt von SqlSmoObject.) | |
Initialize(Boolean) | Initialisiert das Objekt und erzwingt das Laden der Eigenschaften. (Geerbt von SqlSmoObject.) | |
IsObjectDirty | Überprüft, ob die Objekteigenschaften geändert und die Änderungen noch nicht permanent für die SQL Server-Instanz gespeichert wurden. (Geerbt von SqlSmoObject.) | |
IsObjectInitialized | Überprüft, ob das Objekt initialisiert wurde. (Geerbt von SqlSmoObject.) | |
IsObjectInSpace | Überprüft, ob das Objekt isoliert vorhanden oder mit der SQL Server-Instanz verbunden ist. (Geerbt von SqlSmoObject.) | |
IsVersion80SP3 | Ermittelt, ob die SQL Server-Version SQL Server 2000 mit SP3 ist. (Geerbt von SqlSmoObject.) | |
IsVersion90AndAbove | Ermittelt, ob die SQL Server-Version SQL Server 2005 oder höher ist. (Geerbt von SqlSmoObject.) | |
MarkDropped | Legt den zu löschenden SqlSmoState fest. (Geerbt von SqlSmoObject.) | |
MarkForDropImpl | Legt den zu löschenden SqlSmoState fest. (Geerbt von SqlSmoObject.) | |
MemberwiseClone | (Geerbt von Object.) | |
PostAlter | Die Methode, die nach dem Ändern von SqlSmoObject aktiviert wird. (Geerbt von SqlSmoObject.) | |
PostCreate | Die Methode, die nach dem Erstellen von SqlSmoObject aktiviert wird. (Geerbt von SqlSmoObject.) | |
PostDrop | Die Methode, die nach dem Löschen von SqlSmoObject aktiviert wird. (Geerbt von SqlSmoObject.) | |
Refresh | Aktualisiert das Objekt und ruft beim nächsten Zugriff auf das Objekt Eigenschaften ab. (Geerbt von SqlSmoObject.) | |
Rename | Renames the job step. | |
RenameImpl | Nur für Informationszwecke identifiziert. Nicht unterstützt. Zukünftige Kompatibilität wird nicht sichergestellt. (Geerbt von NamedSmoObject.) | |
RenameImplWorker | Nur für Informationszwecke identifiziert. Nicht unterstützt. Zukünftige Kompatibilität wird nicht sichergestellt. (Geerbt von NamedSmoObject.) | |
Script() () () () | Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step. | |
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. | |
ScriptAlter | Ändert SqlSmoObject gemäß den Parametern. (Geerbt von SqlSmoObject.) | |
ScriptChangeOwner | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Geerbt von NamedSmoObject.) | |
ScriptCreate | Ändert SqlSmoObject gemäß den Parametern. (Geerbt von SqlSmoObject.) | |
ScriptDdl | Löst InvalidSmoOperationException aus. (Geerbt von SqlSmoObject.) | |
ScriptDrop | Löst InvalidSmoOperationException aus. (Geerbt von SqlSmoObject.) | |
ScriptImpl() () () () | Ruft eine Skriptauflistung von SqlSmoObject ab. (Geerbt von SqlSmoObject.) | |
ScriptImpl(ScriptingOptions) | Ruft eine Skriptauflistung von SqlSmoObject ab. (Geerbt von SqlSmoObject.) | |
ScriptImplWorker | Ruft eine Skriptauflistung von SqlSmoObject ab. (Geerbt von SqlSmoObject.) | |
ScriptOwner | Alters the script owner authorization. (Geerbt von NamedSmoObject.) | |
ScriptRename | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Geerbt von NamedSmoObject.) | |
SetParentImpl | Legt das übergeordnete Element von SqlSmoObject auf den newParent-Parameter fest. (Geerbt von SqlSmoObject.) | |
SetSchemaOwned | Sets the schema owned value. (Geerbt von NamedSmoObject.) | |
ToString | Gibt eine String zurück, die das Objekt darstellt, auf das verwiesen wird. (Geerbt von SqlSmoObject.) | |
TouchImpl | Nicht implementiert. (Geerbt von SqlSmoObject.) | |
UnbindDefaultImpl | Hebt die Bindung der Standardspalten von SqlSmoObject auf. (Geerbt von SqlSmoObject.) | |
UnbindRuleImpl | Hebt die Bindung der Regeln von SqlSmoObject auf. (Geerbt von SqlSmoObject.) | |
Validate | Validates the state of an object. (Geerbt von SmoObjectBase.) |
Zum Anfang
Ereignisse
Name | Beschreibung | |
---|---|---|
PropertyChanged | Stellt das Ereignis dar, das bei Änderung einer Eigenschaft auftritt. (Geerbt von SqlSmoObject.) | |
PropertyMetadataChanged | Stellt das Ereignis dar, das bei Änderungen an den Eigenschaftsmetadaten auftritt. (Geerbt von SqlSmoObject.) |
Zum Anfang
Felder
Name | Beschreibung | |
---|---|---|
m_ExtendedProperties | Stellt eine Eigenschaft dar, die zur Erweiterung der von SqlSmoObject bereitgestellten Eigenschaften definiert wird. (Geerbt von SqlSmoObject.) | |
singletonParent | Stellt das übergeordnete Singleton-Element dar. (Geerbt von SqlSmoObject.) |
Zum Anfang
Explizite Schnittstellenimplementierungen
Name | Beschreibung | |
---|---|---|
IAlienObject. . :: . .Discover | Ermittelt alle Abhängigkeiten. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.) | |
IAlienObject. . :: . .GetDomainRoot | Gibt den Stamm der Domäne zurück. (Geerbt von SqlSmoObject.) | |
IAlienObject. . :: . .GetParent | Ruft das übergeordnete Element dieses Objekts ab. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyType | Ruft den Typ der angegebenen Eigenschaft ab. (Geerbt von SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyValue | Ruft den Wert der angegebenen Eigenschaft ab. (Geerbt von SqlSmoObject.) | |
IAlienObject. . :: . .GetUrn | Ruft den URN (Uniform Resource Name) des Objekts ab. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.) | |
IAlienObject. . :: . .Resolve | Ruft aus dem URN die Instanz ab, die die Informationen zum Objekt enthält. (Geerbt von SqlSmoObject.) | |
IAlienObject. . :: . .SetObjectState | Legt den Objektstatus auf den angegebenen SfcObjectState-Wert fest. (Geerbt von SqlSmoObject.) | |
IAlienObject. . :: . .SetPropertyValue | Legt den Eigenschaftswert fest. (Geerbt von SqlSmoObject.) | |
ISfcPropertyProvider. . :: . .GetPropertySet | Ruft den Schnittstellenverweis auf den Eigenschaftensatz dieses Objekts ab. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.) |
Zum Anfang
Hinweise
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
Alle öffentlichen, statischen Elemente dieses Typs (Shared in Microsoft Visual Basic) sind für Vorgänge mit mehreren Threads sicher. Für Instanzelemente kann nicht sichergestellt werden, dass sie für Threads sicher sind.
Threadsicherheit
Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.