次の方法で共有

  • [アーティクル]

RemoveFromTargetServer メソッド

ジョブに対して管理された対象サーバーの一覧から実行対象サーバーを削除します。

名前空間:  Microsoft.SqlServer.Management.Smo.Agent
アセンブリ:  Microsoft.SqlServer.Smo (Microsoft.SqlServer.Smo.dll)

構文

'宣言
Public Sub RemoveFromTargetServer ( _
    serverName As String _
)
'使用
Dim instance As Job
Dim serverName As String

instance.RemoveFromTargetServer(serverName)

public void RemoveFromTargetServer(
    string serverName
)

public:
void RemoveFromTargetServer(
    String^ serverName
)

member RemoveFromTargetServer : 
        serverName:string -> unit 

public function RemoveFromTargetServer(
    serverName : String
)

パラメーター

説明

ジョブを作成、スケジュール、および実行する場合、ApplyToTargetServer メソッドまたは ApplyToTargetServerGroup メソッドを使用して、実行対象サーバーを追加します。ApplyToTargetServer メソッドを使用して単一の実行対象が追加されているときは、RemoveFromTargetServer メソッドを使用して削除できます。

ジョブが、Microsoft SQL Server エージェントを実行中のローカル サーバーで実行の対象になっている場合、実行対象を削除するには、文字列 (local) を使用してサーバー名を指定します。

マルチサーバー ジョブから実行対象が削除される場合、マスター サーバーは対象サーバーへ指示を送信します。これは、対象サーバーがジョブのローカル コピーを削除する必要があることを示します。ジョブは対象サーバーから削除されますが、マスター サーバーでは定義されたまま残されます。参加しているすべてのサーバーからジョブを完全に削除するには、Job オブジェクトの RemoveAllJobSteps メソッドまたは JobServer オブジェクトの RemoveJobByID を使用します。

使用例

次のコード例では、"Test Job" ジョブを無効にし、定義されているすべてのステップをこのジョブから削除します。

C#

Server srv = new Server("(local)");
Job jb = new Job(srv.JobServer, "Test Job");
jb.ApplyToTargetServer(srv.Name);
jb.RemoveFromTargetServer(srv.Name);

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$jb = new-object Microsoft.SqlServer.Management.Smo.Agent.Job($srv.JobServer, "Test Job")
$jb.RemoveFromTargetServer($srv.Name)