Job クラス
Job クラスは、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.Job
名前空間: Microsoft.SqlServer.Management.Smo.Agent
アセンブリ: Microsoft.SqlServer.Smo (Microsoft.SqlServer.Smo.dll)
構文
'宣言
Public NotInheritable Class Job _
Inherits AgentObjectBase _
Implements IAlterable, ICreatable, IDroppable, IRenamable, _
IScriptable
'使用
Dim instance As Job
public sealed class Job : AgentObjectBase, IAlterable,
ICreatable, IDroppable, IRenamable, IScriptable
public ref class Job sealed : public AgentObjectBase,
IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
[<SealedAttribute>]
type Job =
class
inherit AgentObjectBase
interface IAlterable
interface ICreatable
interface IDroppable
interface IRenamable
interface IScriptable
end
public final class Job extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
Job 型は、以下のメンバーを公開しています。
コンストラクター
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック メソッド") |
Job() | Job クラスの新しいインスタンスを初期化します。 |
|
Job(JobServer, String) | 指定した Microsoft SQL Server エージェントのインスタンスで、指定した名前を使用して Job クラスの新しいインスタンスを初期化します。 |
|
Job(JobServer, String, Int32) | 指定した SQL Server エージェントのインスタンスで、指定した名前とカテゴリを使用して Job クラスの新しいインスタンスを初期化します。 |
先頭に戻る
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
Category | ジョブが属するカテゴリを取得します。値の設定も可能です。 |
|
CategoryID | ジョブ カテゴリを一意に識別する ID 値を取得します。 |
|
CategoryType | ローカル ジョブまたはマルチサーバー ジョブについて、カテゴリの種類を取得します。値の設定も可能です。 |
|
CurrentRunRetryAttempt | Microsoft SQL Server エージェントがジョブを実行しようとして失敗した回数を取得します。 |
|
CurrentRunStatus | ジョブの現在の実行状態を取得します。 |
|
CurrentRunStep | 現在実行されているジョブ ステップに関する情報を取得します。 |
|
DateCreated | ジョブが作成された日時を取得します。 |
|
DateLastModified | ジョブが前回変更された日時を取得します。 |
|
DeleteLevel | ジョブの実行の終了時にジョブ定義を削除するかどうかを示す完了操作を取得します。値の設定も可能です。 |
|
Description | ジョブの説明テキストを取得します。値の設定も可能です。 |
|
EmailLevel | ジョブの実行の終了時に電子メールによる通知をオペレーターに送信するかどうかを示す完了操作を取得します。値の設定も可能です。 |
|
EventLogLevel | ジョブの実行の終了時にオペレーティング システムのイベント ログ エントリを生成するかどうかを示す完了操作を取得します。値の設定も可能です。 |
|
HasSchedule | ジョブに少なくとも 1 つのスケジュールがあるかどうかを示す Boolean プロパティ値を取得します。 |
|
HasServer | マルチサーバー操作に割り当てられている対象サーバーがジョブにあるかどうかを示す Boolean プロパティ値を取得します。 |
|
HasStep | ジョブに少なくとも 1 つのジョブ ステップがあるかどうかを示す Boolean プロパティ値を取得します。 |
|
IsEnabled | ジョブが有効かどうかを示す Boolean プロパティ値を取得します。値の設定も可能です。 |
|
JobID | ジョブ ID 値を取得します。 |
|
JobSchedules | ジョブに割り当てられたスケジュールを表す JobSchedule オブジェクトのコレクションを取得します。 |
|
JobSteps | ジョブに定義されたジョブ ステップを表す JobStep オブジェクトのコレクションを取得します。 |
|
JobType | ジョブがローカルまたはマルチサーバーのどちらであるかを示すジョブの種類を取得します。 |
|
LastRunDate | ジョブが前回実行された日時を取得します。 |
|
LastRunOutcome | ジョブの実行が前回完了したときのジョブの結果を取得します。 |
|
Name | ジョブの名前を取得または設定します。 (NamedSmoObject.Name をオーバーライドします。) |
|
NetSendLevel | ジョブの実行の終了時に Net Send による通知をオペレーターに送信するかどうかを示す完了操作を取得します。値の設定も可能です。 |
|
NextRunDate | ジョブの次回の実行がスケジュールされている日時を取得します。 |
|
NextRunScheduleID | 次回にジョブを実行するスケジュールの ID 値を取得します。 |
|
OperatorToEmail | ジョブの実行の終了時に電子メールによる通知を受信するオペレーターを取得します。値の設定も可能です。 |
|
OperatorToNetSend | ジョブの実行の終了時に Net Send による通知を受信するオペレーターを取得します。値の設定も可能です。 |
|
OperatorToPage | ジョブの実行の終了時にポケットベルによる通知を受信するオペレーターを取得します。値の設定も可能です。 |
|
OriginatingServer | マルチサーバー ジョブのマスター サーバーとして動作しているサーバーの名前を取得します。 |
|
OwnerLoginName | ジョブの所有者を取得します。値の設定も可能です。 |
|
PageLevel | ジョブの実行の終了時にポケットベルによる通知をオペレーターに送信するかどうかを示す完了操作を取得します。値の設定も可能です。 |
|
Parent | Job オブジェクトの親である JobServer オブジェクトを取得します。値の設定も可能です。 |
|
Properties | オブジェクトのプロパティを表す Property オブジェクトのコレクションを取得します。 (SqlSmoObject から継承されています。) |
|
StartStepID | シーケンスで実行される最初のジョブ ステップの ID 値を取得します。値の設定も可能です。 |
|
State | 参照先のオブジェクトの状態を取得します。 (SmoObjectBase から継承されています。) |
|
Urn | オブジェクトを一意に識別する URN (Uniform Resource Name) アドレスの値を取得します。 (SqlSmoObject から継承されています。) |
|
UserData | 参照先のオブジェクトに関連付けられたユーザー定義データを取得します。値の設定も可能です。 (SmoObjectBase から継承されています。) |
|
VersionNumber | ジョブが変更されるたびに増分されるシステム管理値を取得します。 |
先頭に戻る
メソッド
| 名前 | 説明 | |
|---|---|---|
|
AddSharedSchedule | Microsoft SQL Server エージェント ジョブに共有スケジュールを追加します。 |
|
Alter | Microsoft SQL Server インスタンス上での Job オブジェクトのプロパティに対する変更をすべて更新します。 |
|
ApplyToTargetServer | 参照先の Microsoft SQL Server エージェント ジョブによる管理対象サーバーの一覧にサーバーを追加します。 |
|
ApplyToTargetServerGroup | 参照先の Microsoft SQL Server エージェント ジョブによる管理対象サーバーの一覧に 1 つ以上のサーバーを追加します。 |
|
Create | Microsoft SQL Server のインスタンスで、Job オブジェクトによる定義に基づいてジョブを作成します。 |
|
DeleteJobStepLogs(DateTime) | 指定した日付より古いジョブ ステップのログ ファイルを削除します。 |
|
DeleteJobStepLogs(Int32) | 指定したログ ID 番号より大きいジョブ ステップのログ ファイルを削除します。 |
|
Discover | Object 型の一覧を検出します。 (SqlSmoObject から継承されています。) |
|
Drop() | 既存のジョブを削除します。 |
|
Drop(Boolean) | 既存のジョブを削除します。 |
|
EnumAlerts | 参照先のジョブの自動実行を発生させるエージェント警告の一覧を列挙します。 |
|
EnumHistory() | 参照先のジョブに関連付けられた実行履歴の一覧を列挙します。 |
|
EnumHistory(JobHistoryFilter) | 参照先のジョブに関連付けられた実行履歴の一覧を列挙します。 |
|
EnumJobStepLogs() | 参照先のジョブに対するジョブ ステップのログ ファイルの一覧を列挙します。 |
|
EnumJobStepLogs(Int32) | 指定した ID 値を持つジョブ ステップのジョブ ステップ ログ ファイルの一覧を列挙します。 |
|
EnumJobStepLogs(String) | 指定した名前を持つジョブ ステップのジョブ ステップ ログ ファイルの一覧を列挙します。 |
|
EnumJobStepsByID | 参照先のジョブに属し、ID 値によって並べ替えられる JobStep オブジェクトの配列を返します。 |
|
EnumTargetServers | 参照先のジョブに割り当てられている実行対象サーバーの一覧を列挙します。 |
|
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 から継承されています。) |
|
Invoke | ジョブを実行します。 |
|
IsObjectInitialized | オブジェクトが初期化されたかどうかを確認します。 (SqlSmoObject から継承されています。) |
|
IsObjectInSpace | オブジェクトが孤立しているか、または SQL Server のインスタンスに接続されているかを確認します。 (SqlSmoObject から継承されています。) |
|
PurgeHistory | 参照先のジョブの実行履歴を管理するシステム レコードを削除します。 |
|
Refresh | オブジェクトが次回アクセスされるときに、オブジェクトを更新し、プロパティを取得します。 (SqlSmoObject から継承されています。) |
|
RemoveAllJobSchedules() | ジョブからすべての共有スケジュールおよび非共有スケジュールを削除します。 |
|
RemoveAllJobSchedules(Boolean) | ジョブから未使用のスケジュールをすべて削除します。 |
|
RemoveAllJobSteps | ジョブに関連付けられたすべてのジョブ ステップを削除します。 |
|
RemoveFromTargetServer | ジョブに対して管理された対象サーバーの一覧から実行対象サーバーを削除します。 |
|
RemoveFromTargetServerGroup | ジョブに対して管理されている対象サーバーの一覧から実行対象サーバーのグループを削除します。 |
|
RemoveSharedSchedule(Int32) | 指定した共有スケジュールをジョブから削除します。 |
|
RemoveSharedSchedule(Int32, Boolean) | 指定した共有スケジュールをジョブから削除し、未使用のスケジュールを保持します。 |
|
Rename | ジョブの名前を変更します。 |
|
Script() | Microsoft SQL Server エージェント ジョブの再作成に使用できる Transact-SQL スクリプトを生成します。 |
|
Script(ScriptingOptions) | スクリプト作成オプションで指定したとおりに Microsoft SQL Server エージェント ジョブを再作成するために使用できる Transact-SQL スクリプトを生成します。 |
|
SetParentImpl | SqlSmoObject の親を newParent パラメーターに設定します。 (SqlSmoObject から継承されています。) |
|
Start() | 参照先のジョブを実行します。 |
|
Start(String) | 指定したジョブ ステップから、参照先のジョブを実行します。 |
|
Stop | 参照先のジョブの実行を停止します。 |
|
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 から継承されています。) |
先頭に戻る
説明
Job オブジェクトのプロパティを取得または設定するには、MSDB データベースに対するデータベース ロール SQLAgentUserRole のメンバー、ジョブの所有者、または固定サーバー ロール sysadmin のメンバーである必要があります。
ジョブを作成するには、MSDB データベースに対するデータベース ロール SQLAgentUserRole、SQLAgentReaderRole、および SQLAgentOperatorRole のメンバー、または固定サーバー ロール sysadmin のメンバーである必要があります。
ジョブを削除するには、MSDB データベースに対するデータベース ロール SQLAgentUserRole のメンバー、ジョブの所有者、または固定サーバー ロール sysadmin のメンバーである必要があります。
スレッド セーフ
この型の public static (Microsoft Visual Basic では Shared) のすべてのメンバーは、マルチスレッド操作で安全に使用できます。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
使用例
SQL Server エージェントでの自動管理タスクのスケジュール設定
スレッド セーフ
この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
関連項目
参照
Microsoft.SqlServer.Management.Smo.Agent 名前空間