JobStep クラス
JobStep クラスは、Microsoft SQL Server のジョブ ステップを表します。
継承階層
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() | JobStep クラスの新しいインスタンスを初期化します。 |
|
JobStep(Job, String) | 指定した名前を使用して、指定したジョブの JobStep クラスの新しいインスタンスを初期化します。 |
先頭に戻る
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
Command | ジョブ ステップのコマンド実行文字列を取得します。値の設定も可能です。 |
|
CommandExecutionSuccessCode | ジョブ ステップとして実行されたコマンド シェル プロセスから、プロセス終了コードを取得します。値の設定も可能です。 |
|
DatabaseName | ジョブ ステップのコマンド実行の対象として限定されるデータベースの名前を取得します。値の設定も可能です。 |
|
DatabaseUserName | コマンド文字列の実行時に、ジョブ ステップが想定するデータベース ユーザー アカウントを取得します。値の設定も可能です。 |
|
ID | ジョブ ステップを一意に識別する ID 値を取得します。値の設定も可能です。 |
|
JobStepFlags | JobStepFlags プロパティは、将来使用するために予約されています。 |
|
LastRunDate | ジョブ ステップが前回実行された日時を取得します。 |
|
LastRunDuration | 参照先ジョブ ステップが前回実行されたときの実行所要時間を取得します。 |
|
LastRunOutcome | ジョブ ステップが前回実行されたときの結果を取得します。 |
|
LastRunRetries | ジョブ ステップが前回実行されたときの再試行回数を取得します。 |
|
Name | オブジェクトの名前を取得または設定します。 (NamedSmoObject から継承されています。) |
|
OnFailAction | ジョブ ステップの実行が失敗して終了するときに実行されるアクションを取得します。値の設定も可能です。 |
|
OnFailStep | 参照先ジョブ ステップの実行が失敗を表す完了状態で終了した後に実行されるジョブ ステップを取得します。値の設定も可能です。 |
|
OnSuccessAction | ジョブ ステップの実行が正常に終了したときに実行されるアクションを取得します。値の設定も可能です。 |
|
OnSuccessStep | 参照先ジョブ ステップの実行が成功を表す完了状態で終了した後に実行されるジョブ ステップを取得します。値の設定も可能です。 |
|
OSRunPriority | オペレーティング システムのタスクを実行しているジョブ ステップの実行スレッド スケジューリングを取得します。値の設定も可能です。 |
|
OutputFileName | ジョブ ステップの結果のメッセージ テキストを記録するオペレーティング システム ファイルの名前とパスを取得します。値の設定も可能です。 |
|
Parent | JobStep オブジェクトの親である Job オブジェクトを取得します。値の設定も可能です。 |
|
Properties | オブジェクトのプロパティを表す Property オブジェクトのコレクションを取得します。 (SqlSmoObject から継承されています。) |
|
ProxyName | ジョブ ステップに必要な Microsoft SQL Server エージェント プロキシ アカウントの名前を取得します。値の設定も可能です。 |
|
RetryAttempts | ジョブ ステップが、失敗を表す完了状態で返されるまでに再試行される最大回数を取得します。値の設定も可能です。 |
|
RetryInterval | 以前に失敗したジョブ ステップの実行を試行する前に Microsoft SQL Server エージェントが待機する数値を分単位で取得します。値の設定も可能です。 |
|
Server | ジョブ ステップが実行されるサーバーの名前を取得します。値の設定も可能です。 |
|
State | 参照先のオブジェクトの状態を取得します。 (SmoObjectBase から継承されています。) |
|
SubSystem | ジョブ ステップのコマンド テキストを解釈するために使用する Microsoft SQL Server エージェント実行サブシステムを取得します。値の設定も可能です。 |
|
Urn | オブジェクトを一意に識別する URN (Uniform Resource Name) アドレスの値を取得します。 (SqlSmoObject から継承されています。) |
|
UserData | 参照先のオブジェクトに関連付けられたユーザー定義データを取得します。値の設定も可能です。 (SmoObjectBase から継承されています。) |
先頭に戻る
メソッド
| 名前 | 説明 | |
|---|---|---|
|
Alter | Microsoft SQL Server のインスタンスでの JobStep オブジェクトのプロパティに対する変更をすべて更新します。 |
|
Create | Microsoft SQL Server のインスタンスで、JobStep オブジェクトによる定義に基づいてジョブ ステップを作成します。 |
|
DeleteLogs(DateTime) | 指定した日付より古いジョブ ステップのログ ファイルを削除します。 |
|
DeleteLogs(Int32) | 指定した値より下位のログ番号を持つジョブ ステップのログ ファイルを削除します。 |
|
Discover | Object 型の一覧を検出します。 (SqlSmoObject から継承されています。) |
|
Drop | 参照先ジョブ ステップを削除します。 |
|
EnumLogs | 列挙されたジョブ ステップのログ ファイルの一覧を返します。 |
|
Equals | (Object から継承されています。) |
.gif "プロテクト メソッド") |
FormatSqlVariant | SqlVariant 型としてオブジェクトの書式を設定します。 (SqlSmoObject から継承されています。) |
|
GetContextDB | このオブジェクトに関連付けられているコンテキスト データベースを取得します。 (SqlSmoObject から継承されています。) |
|
GetDBName | オブジェクトに関連付けられたデータベース名を取得します。 (AgentObjectBase から継承されています。) |
|
GetHashCode | (Object から継承されています。) |
|
GetPropValue | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) |
|
GetPropValueOptional | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) |
|
GetPropValueOptionalAllowNull | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) |
|
GetServerObject | SqlSmoObject オブジェクトのサーバーを取得します。 (SqlSmoObject から継承されています。) |
|
GetType | (Object から継承されています。) |
|
Initialize() | オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。) |
|
Initialize(Boolean) | オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。) |
|
IsObjectInitialized | オブジェクトが初期化されたかどうかを確認します。 (SqlSmoObject から継承されています。) |
|
IsObjectInSpace | オブジェクトが孤立しているか、または SQL Server のインスタンスに接続されているかを確認します。 (SqlSmoObject から継承されています。) |
|
Refresh | オブジェクトが次回アクセスされるときに、オブジェクトを更新し、プロパティを取得します。 (SqlSmoObject から継承されています。) |
|
Rename | ジョブ ステップの名前を変更します。 |
|
Script() | Microsoft SQL Server エージェント ジョブ ステップの再作成に使用できる Transact-SQL スクリプトを生成します。 |
|
Script(ScriptingOptions) | スクリプト作成オプションで指定したとおりに Microsoft SQL Server エージェント ジョブ ステップを再作成するために使用できる Transact-SQL スクリプトを生成します。 |
|
SetParentImpl | SqlSmoObject の親を newParent パラメーターに設定します。 (SqlSmoObject から継承されています。) |
|
ToString | 参照するオブジェクトを表す String を返します。 (SqlSmoObject から継承されています。) |
|
Validate | オブジェクトの状態を検証します。 (SmoObjectBase から継承されています。) |
先頭に戻る
イベント
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック イベント") |
PropertyChanged | プロパティが変更されるときに発生するイベントを表します。 (SqlSmoObject から継承されています。) |
|
PropertyMetadataChanged | プロパティ メタデータが変更されたときに発生するイベントを表します。 (SqlSmoObject から継承されています。) |
先頭に戻る
明示的なインターフェイスの実装
| 名前 | 説明 | |
|---|---|---|
.gif "明示的なインターフェイスの実装") .gif "プライベート メソッド") |
IAlienObject.Discover | 依存関係を検出します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) |
|
IAlienObject.GetDomainRoot | ドメインのルートを返します。 (SqlSmoObject から継承されています。) |
|
IAlienObject.GetParent | このオブジェクトの親を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) |
|
IAlienObject.GetPropertyType | 指定したプロパティの種類を取得します。 (SqlSmoObject から継承されています。) |
|
IAlienObject.GetPropertyValue | 指定されたプロパティの値を取得します。 (SqlSmoObject から継承されています。) |
|
IAlienObject.GetUrn | オブジェクトの Unified Resource Name (URN) を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) |
|
IAlienObject.Resolve | オブジェクトに関する情報を含むインスタンスを、オブジェクトの Unified Resource Name (URN) から取得します。 (SqlSmoObject から継承されています。) |
|
IAlienObject.SetObjectState | オブジェクトの状態を、指定した SfcObjectState 値に設定します。 (SqlSmoObject から継承されています。) |
|
IAlienObject.SetPropertyValue | プロパティの値を設定します。 (SqlSmoObject から継承されています。) |
|
ISfcPropertyProvider.GetPropertySet | このオブジェクトのプロパティ セットへのインターフェイス リファレンスを取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) |
先頭に戻る
説明
SQL Server エージェント ジョブには、ステップと呼ばれる 1 つ以上の実行単位が含まれます。 各ジョブ ステップには、テキスト コマンド、コマンドの解釈を指定する実行の種類、およびステップが成功または失敗した場合のジョブの動作を決定するロジックが含まれます。 たとえば、ジョブ ステップには次のものが含まれます。
コマンド テキスト。 たとえば、
DBCC CHECKDB ('Northwind') WITH NO_INFOMSGSジョブ ステップの実行の種類。たとえば、Transact-SQL。
ステップが失敗した場合にジョブを停止させる指示。
JobStep オブジェクトを使用すると、次のような操作を実行できます。
SQL Server エージェント ジョブ ステップの作成。
SQL Server エージェント ジョブからのジョブ ステップの削除。
コマンド テキストや、ステップの成功時または失敗時に実行するアクションなどを変更することによる、既存のジョブ ステップの管理。
ステップの最後に試行された実行に関する詳細の取得。
JobStep オブジェクトのプロパティを取得するには、MSDB データベースに対するデータベース ロール SQLAgentUserRole、または固定サーバー ロール sysadmin のメンバーである必要があります。
JobStep オブジェクトのプロパティを設定するには、MSDB データベースに対するデータベース ロール SQLAgentUserRole のメンバーであるか、ジョブ ステップの所有者であるか、または固定サーバー ロール sysadmin のメンバーである必要があります。
ジョブ ステップを作成するには、MSDB データベースに対するデータベース ロール SQLAgentUserRole のメンバーであるか、または固定サーバー ロール sysadmin のメンバーである必要があります。 また、そのジョブ ステップで使用されるプロキシ アカウントに対する権限を持っている必要があります。
ジョブ ステップを削除するには、MSDB データベースに対するデータベース ロール SQLAgentUserRole のメンバーであるか、ジョブ ステップの所有者であるか、または固定サーバー ロール sysadmin のメンバーである必要があります。
スレッド セーフ
この型の public static (Microsoft Visual Basic では Shared) のすべてのメンバーは、マルチスレッド操作で安全に使用できます。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
使用例
SQL Server エージェントでの自動管理タスクのスケジュール設定
スレッド セーフ
この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
関連項目
参照
Microsoft.SqlServer.Management.Smo.Agent 名前空間