JobServer クラス
JobServer オブジェクトは、SQL Server エージェント サブシステムと msdb データベースを表します。
継承階層
System.Object
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.Agent.JobServer
名前空間: Microsoft.SqlServer.Management.Smo.Agent
アセンブリ: Microsoft.SqlServer.Smo (Microsoft.SqlServer.Smo.dll)
構文
'宣言
Public NotInheritable Class JobServer _
Inherits SqlSmoObject _
Implements IAlterable, IScriptable
'使用
Dim instance As JobServer
public sealed class JobServer : SqlSmoObject,
IAlterable, IScriptable
public ref class JobServer sealed : public SqlSmoObject,
IAlterable, IScriptable
[<SealedAttribute>]
type JobServer =
class
inherit SqlSmoObject
interface IAlterable
interface IScriptable
end
public final class JobServer extends SqlSmoObject implements IAlterable, IScriptable
JobServer 型は、以下のメンバーを公開しています。
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
AgentDomainGroup | SQL Server エージェントのドメイン グループを取得します。 |
|
AgentLogLevel | SQL Server エージェントによってログに記録されるメッセージの種類を取得します。値の設定も可能です。 |
|
AgentMailType | SQL Server エージェントのメールの種類を取得します。値の設定も可能です。 |
|
AgentShutdownWaitTime | シャットダウンするまでに SQL Server エージェントがジョブの完了を待機する時間を取得します。値の設定も可能です。 |
|
AlertCategories | AlertCategory オブジェクトのコレクションを表します。各 AlertCategory オブジェクトは、SQL Server エージェントで定義された警告カテゴリを表します。 |
|
Alerts | Alert オブジェクトのコレクションを表します。各 Alert オブジェクトは、SQL Server エージェントで定義された警告を表します。 |
|
AlertSystem | AlertSystem オブジェクトは、SQL Server エージェントで定義されたすべての警告に適用される情報を格納します。 |
|
DatabaseMailProfile | データベース メール プロファイルを取得します。値の設定も可能です。 |
|
ErrorLogFile | SQL Server エージェントがエラーを記録するファイルの名前とパスを取得します。値の設定も可能です。 |
|
HostLoginName | SQL Server にログインするために使用されるログイン情報を取得します。値の設定も可能です。 |
|
IdleCpuDuration | アイドル状態であると見なされるまで、プロセッサが CPU のアイドル状態の割合値を保持する必要がある時間を秒数で取得します。値の設定も可能です。 |
|
IdleCpuPercentage | アイドル状態であると見なされるまで、プロセッサが到達する必要のある CPU アイドル割合のしきい値を取得します。値の設定も可能です。 |
|
IsCpuPollingEnabled | CPU ポーリングが有効かどうかを示す Boolean プロパティ値を取得します。値の設定も可能です。 |
|
JobCategories | JobCategory オブジェクトのコレクションを表します。各 JobCategory オブジェクトは、Microsoft SQL Server エージェントで定義されたジョブ カテゴリを表します。 |
|
Jobs | Job オブジェクトのコレクションを表します。各 Job オブジェクトは、SQL Server エージェントで定義されたジョブを表します。 |
|
JobServerType | マルチサーバー管理に関してジョブ サーバーの種類を取得します。値の設定も可能です。 |
|
LocalHostAlias | SQL Server のローカル インスタンスへの接続に使用されるローカル ホスト別名を取得します。値の設定も可能です。 |
|
LoginTimeout | 接続の試行がタイムアウトするまでの秒数を取得します。値の設定も可能です。 |
|
MaximumHistoryRows | 保持される履歴の最大行数を取得します。値の設定も可能です。 |
|
MaximumJobHistoryRows | ジョブごとに保持される履歴の最大行数を取得します。値の設定も可能です。 |
|
MsxAccountCredentialName | Windows 認証を使用しているマスター サーバーに接続するのに必要な Windows アカウントを取得します。値の設定も可能です。 |
|
MsxAccountName | SQL Server 認証を使用しているマスター サーバーに接続するのに必要なログインを取得します。値の設定も可能です。 |
|
MsxServerName | マルチサーバー管理に参加しているマスター サーバーの名前を取得します。値の設定も可能です。 |
|
Name | SQL Server エージェント サービスの名前を取得します。 |
|
NetSendRecipient | Net Send メッセージの受信者を取得します。値の設定も可能です。 |
|
OperatorCategories | OperatorCategory オブジェクトのコレクションを表します。各 OperatorCategory オブジェクトは、SQL Server エージェントで定義されたオペレーター カテゴリを表します。 |
|
Operators | Operator オブジェクトのコレクションを表します。各 Operator オブジェクトは、SQL Server エージェントで定義されたオペレーターを表します。 |
|
Parent | JobServer オブジェクトの親である Server オブジェクトを取得します。 |
|
Properties | オブジェクトのプロパティを表す Property オブジェクトのコレクションを取得します。 (SqlSmoObject から継承されています。) |
|
ProxyAccounts | ProxyAccount オブジェクトのコレクションを表します。各 ProxyAccount オブジェクトは、Microsoft SQL Server エージェントで定義されたプロキシ アカウントを表します。 |
|
ReplaceAlertTokensEnabled | SQL Server エージェントのインスタンスで警告トークンが置き換えられるかどうかを示す Boolean 値を取得します。値の設定も可能です。 |
|
SaveInSentFolder | 通知を保存するかどうかを示す Boolean プロパティ値を取得します。値の設定も可能です。 |
|
ServiceAccount | SQL Server エージェント サービスを実行するアカウントを取得します。 |
|
ServiceStartMode | SQL Server エージェント サービスの開始に使用されるモードを取得します。 |
|
SharedSchedules | JobSchedule オブジェクトのコレクションを表します。各 JobSchedule オブジェクトは、SQL Server エージェントで定義された共有スケジュールを表します。 |
|
SqlAgentAutoStart | SQL Server エージェントを自動的に起動するかどうかを示す Boolean プロパティ値を取得します。値の設定も可能です。 |
|
SqlAgentMailProfile | SQL Server エージェントのメール プロファイルを取得します。値の設定も可能です。 |
|
SqlAgentRestart | SQL Server エージェントを監視し、停止した場合は再起動するかどうかを示す Boolean プロパティ値を取得します。値の設定も可能です。 |
|
SqlServerRestart | SQL Server サービスを監視し、停止した場合は再起動するかどうかを示す Boolean プロパティ値を取得します。値の設定も可能です。 |
|
State | 参照先のオブジェクトの状態を取得します。 (SmoObjectBase から継承されています。) |
|
SysAdminOnly | CmdExec コマンドと ActiveX コマンドが固定サーバー ロール sysadmin のメンバーによってのみ実行されるかどうかを示す Boolean プロパティ値を取得します。 |
|
TargetServerGroups | TargetServerGroup オブジェクトのコレクションを表します。各 TargetServerGroup オブジェクトは、SQL Server エージェントで定義された対象サーバー グループを表します。 |
|
TargetServers | TargetServer オブジェクトのコレクションを表します。各 TargetServer オブジェクトは、SQL Server エージェントで定義された対象サーバーを表します。 |
|
Urn | オブジェクトを一意に識別する URN (Uniform Resource Name) アドレスの値を取得します。 (SqlSmoObject から継承されています。) |
|
UserData | 参照先のオブジェクトに関連付けられたユーザー定義データを取得します。値の設定も可能です。 (SmoObjectBase から継承されています。) |
|
WriteOemErrorLog | Unicode 以外の形式のファイルにエラー ログを書き込むかどうかを示す Boolean プロパティ値を取得します。値の設定も可能です。 |
先頭に戻る
メソッド
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック メソッド") |
Alter | SQL Server のインスタンスの JobServer オブジェクトのプロパティに対する変更をすべて更新します。 |
|
ClearHostLoginAccount | ホスト ログイン アカウントを消去し、統合セキュリティを使用して SQL Server にログインします。 |
|
ClearMsxAccount | マスター サーバー ログイン アカウントを消去し、統合セキュリティを使用してマスター サーバーにログインします。 |
|
CycleErrorLog | 現在のエラー ログを閉じ、名前を変更してから、新しい空のエラー ログ ファイルを作成します。 |
|
Discover | Object 型の一覧を検出します。 (SqlSmoObject から継承されています。) |
|
DropJobByID | 指定した ID 値のジョブを削除します。 |
|
DropJobsByLogin | 指定したログイン名のジョブを削除します。 |
|
DropJobsByServer | 指定したサーバーのジョブを削除します。 |
|
EnumErrorLogs | SQL Server エージェントのエラー ログ情報の一覧を列挙します。 |
|
EnumJobHistory() | SQL Server エージェントのジョブ履歴情報の一覧を列挙します。 |
|
EnumJobHistory(JobHistoryFilter) | ジョブ履歴情報の一覧を列挙します。 |
|
EnumJobs() | 現在のジョブに関する情報の一覧を列挙します。 |
|
EnumJobs(JobFilter) | 現在のジョブに関する情報の一覧を列挙します。 |
|
EnumPerformanceCounters() | SQL Server エージェントのパフォーマンス カウンター情報の一覧を列挙します。 |
|
EnumPerformanceCounters(String) | 指定したオブジェクトの SQL Server エージェントのパフォーマンス カウンター情報の一覧を列挙します。 |
|
EnumPerformanceCounters(String, String) | 指定したオブジェクトおよび指定したカウンターについて、SQL Server エージェントのパフォーマンス カウンター情報の一覧を列挙します。 |
|
EnumPerformanceCounters(String, String, String) | 指定したオブジェクト、指定したカウンター、および指定した SQL Server のインスタンスについて、SQL Server エージェントのパフォーマンス カウンター情報の一覧を列挙します。 |
|
EnumSubSystems | SQL Server エージェント実行サブシステムの一覧を列挙します。 |
|
Equals | (Object から継承されています。) |
.gif "プロテクト メソッド") |
FormatSqlVariant | SqlVariant 型としてオブジェクトの書式を設定します。 (SqlSmoObject から継承されています。) |
|
GetContextDB | このオブジェクトに関連付けられているコンテキスト データベースを取得します。 (SqlSmoObject から継承されています。) |
|
GetDBName | オブジェクトに関連付けられたデータベース名を取得します。 (SqlSmoObject から継承されています。) |
|
GetHashCode | (Object から継承されています。) |
|
GetJobByID | 指定した ID 値のジョブを返します。 |
|
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 から継承されています。) |
|
MsxDefect() | マルチサーバー管理グループの Microsoft SQL Server エージェントの参加を終了します。 |
|
MsxDefect(Boolean) | 強制的に参加を解除するオプションにより、マルチサーバー管理グループの SQL Server エージェントの参加を終了します。 |
|
MsxEnlist | マルチサーバー管理内の指定したマスター サーバーに対象サーバーとして SQL Server エージェントを参加させます。 |
|
PurgeJobHistory() | SQL Server エージェント ジョブのすべてのログ記録されたレコードを削除します。 |
|
PurgeJobHistory(JobHistoryFilter) | SQL Server エージェント ジョブのすべてのログ記録されたレコードを、フィルターの指定に従って削除します。 |
|
ReadErrorLog() | エラー ログを列挙します。 |
|
ReadErrorLog(Int32) | エラー ログを列挙します。 |
|
ReassignJobsByLogin | SQL Server ログインが現在所有する SQL Server エージェント ジョブの所有権を変更します。 |
|
Refresh | オブジェクトが次回アクセスされるときに、オブジェクトを更新し、プロパティを取得します。 (SqlSmoObject から継承されています。) |
|
RemoveJobByID | 指定した ID 値のジョブを削除します。 |
|
RemoveJobsByLogin | 指定したログインのジョブを削除します。 |
|
Script() | SQL Server エージェントの再作成に使用できる Transact-SQL スクリプトを生成します。 |
|
Script(ScriptingOptions) | スクリプト作成オプションの指定どおりに SQL Server エージェントを再作成するために使用できる Transact-SQL スクリプトを生成します。 |
|
SetHostLoginAccount | SQL Server へのログインに使用される SQL Server 認証アカウントとパスワードを設定します。 |
|
SetMsxAccount(String) | マルチサーバー管理のマスター サーバーへのログインに使用する、資格情報の名前を設定します。 |
|
SetMsxAccount(String, String) | マルチサーバー管理のマスター サーバーへのログインに使用する、資格情報の名前を設定します。 |
|
SetParentImpl | SqlSmoObject の親を newParent パラメーターに設定します。 (SqlSmoObject から継承されています。) |
|
StartMonitor | SQL Server のインスタンスによって、ローカルの SQL Server エージェント サービスの監視を開始します。 |
|
StopMonitor | SQL Server のインスタンスによって、ローカルの SQL Server エージェント サービスの監視を終了します。 |
|
TestMailProfile | 電子メール プロファイルの有効性をテストします。 |
|
TestNetSend | Net Send アドレスの有効性をテストします。 |
|
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 エージェント オブジェクトを使用する場合は、Server オブジェクトの JobServer オブジェクト プロパティを使用してそれらを参照できます。 JobServer オブジェクトのコンストラクターを呼び出す必要はありません。これは、Server オブジェクトに対してコンストラクターが呼び出されるときにこのオブジェクトが自動的に作成されるためです。
.gif "注意") 注 |
|---|
MSDB データベースの CompatibilityLevel プロパティが Version70 に設定されていると、SMO が COLLATE エラーによる例外をスローする可能性があります。 |
JobServer オブジェクトのプロパティを取得するには、MSDB データベースに対するデータベース ロール SQLAgentUserRole、または固定サーバー ロール sysadmin のメンバーである必要があります。
JobServer オブジェクトのプロパティを設定するには、固定サーバー ロール sysadmin のメンバーである必要があります。
JobServer オブジェクトでメソッドを実行するには、固定サーバー ロール sysadmin のメンバーである必要があります。
スレッド セーフ
この型の public static (Microsoft Visual Basic では Shared) のすべてのメンバーは、マルチスレッド操作で安全に使用できます。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
使用例
SQL Server エージェントでの自動管理タスクのスケジュール設定
スレッド セーフ
この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
関連項目
参照
Microsoft.SqlServer.Management.Smo.Agent 名前空間