JobStep 類別
The JobStep class represents a Microsoft SQL Server job step.
繼承階層
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
命名空間： Microsoft.SqlServer.Management.Smo.Agent
組件： Microsoft.SqlServer.Smo (在 Microsoft.SqlServer.Smo.dll 中)
語法
'宣告
<SfcElementTypeAttribute("Step")> _
Public NotInheritable Class JobStep _
Inherits AgentObjectBase _
Implements IAlterable, ICreatable, IDroppable, IRenamable, _
IScriptable
'用途
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
JobStep 型別公開下列成員。
建構函式
| 名稱 | 說明 | |
|---|---|---|
.gif "公用方法") |
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. |
上層
屬性
| 名稱 | 說明 | |
|---|---|---|
.gif "公用屬性") |
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. |
.gif "受保護的屬性") |
ExecuteForScalar | 取得或設定 Boolean 屬性值，指定物件是否設定為執行純量選項。 (繼承自 SqlSmoObject。) |
|
ID | Gets or sets the ID value that uniquely identifies the job step. |
|
IsTouched | 取得 Boolean 屬性值，指定物件屬性是否已更新但尚未保存在伺服器上。 (繼承自 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. (繼承自 NamedSmoObject。) |
|
ObjectInSpace | 取得 Boolean 屬性值，指定物件是否存在於隔離中，或是直接或間接連接至 SQL Server 執行個體。 (繼承自 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 | 取得代表物件屬性的 Property 物件集合。 (繼承自 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 | 取得受參考物件的純量結果。 (繼承自 SqlSmoObject。) |
|
Server | Gets or sets the name of the server on which the job step runs. |
|
State | Gets the state of the referenced object. (繼承自 SmoObjectBase。) |
|
SubSystem | Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text. |
|
Urn | 取得可唯一識別物件的統一資源名稱 (URN) 位址值。 (繼承自 SqlSmoObject。) |
|
UserData | Gets or sets user-defined data associated with the referenced object. (繼承自 SmoObjectBase。) |
上層
方法
.gif "受保護的方法")
上層
事件
| 名稱 | 說明 | |
|---|---|---|
.gif "公用事件") |
PropertyChanged | 代表屬性變更時所發生的事件。 (繼承自 SqlSmoObject。) |
|
PropertyMetadataChanged | 代表屬性中繼資料變更時所發生的事件。 (繼承自 SqlSmoObject。) |
上層
欄位
| 名稱 | 說明 | |
|---|---|---|
.gif "受保護的欄位") |
m_ExtendedProperties | 代表屬性，此屬性定義為擴充 SqlSmoObject 所提供的屬性。 (繼承自 SqlSmoObject。) |
|
singletonParent | 代表單一父代。 (繼承自 SqlSmoObject。) |
上層
明確 繼承 實作
| 名稱 | 說明 | |
|---|---|---|
.gif "明確介面實作") .gif "私用方法") |
IAlienObject. . :: . .Discover | 探索任何相依性。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetDomainRoot | 傳回網域的根目錄。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetParent | 取得此物件的父系。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetPropertyType | 取得指定的屬性類型。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetPropertyValue | 取得指定的屬性值。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .GetUrn | 取得物件的統一資源名稱。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .Resolve | 取得執行個體，其中包含物件統一資源名稱之物件的相關資訊。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .SetObjectState | 將物件狀態設定為指定的 SfcObjectState 值。 (繼承自 SqlSmoObject。) |
|
IAlienObject. . :: . .SetPropertyValue | 設定屬性值。 (繼承自 SqlSmoObject。) |
|
ISfcPropertyProvider. . :: . .GetPropertySet | 取得此物件屬性集的介面參考。不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
上層
備註
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_INFOMSGSA 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
此型別的任何公用靜態 (在 Microsoft Visual Basic 為共用) 成員具備多執行緒作業安全。不保證所有執行個體成員都是安全執行緒。
執行緒安全性
這個型別的任何公用 static (在 Visual Basic 中為 Shared) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。