Job.ApplyToTargetServerGroup Method
Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
Namespace: Microsoft.SqlServer.Management.Smo.Agent
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public Sub ApplyToTargetServerGroup ( _
groupName As String _
)
'Usage
Dim instance As Job
Dim groupName As String
instance.ApplyToTargetServerGroup(groupName)
public void ApplyToTargetServerGroup(
string groupName
)
public:
void ApplyToTargetServerGroup(
String^ groupName
)
member ApplyToTargetServerGroup :
groupName:string -> unit
public function ApplyToTargetServerGroup(
groupName : String
)
Parameters
- groupName
Type: System.String
A String that represents a server group.
Remarks
Before a SQL Server Agent job can execute, the job must have at least one step and an execution target.
Use either the ApplyToTargetServer or ApplyToTargetServerGroup method to add an execution target. When the job is to run on the local server, use the ApplyToTargetServer method to target the job and specify the server by using the string (local).
Examples
The following code example creates a job and sets it to execute on a server group.
C#
Server srv = new Server("(local)");
Job jb = new Job(srv.JobServer, "Test Job");
jb.Create();
jb.ApplyToTargetServerGroup("serverGroup")
PowerShell
$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$jb = new-object Microsoft.SqlServer.Management.Smo.Agent.Job($srv.JobServer, "Test Job")
$jb.Create()
$jb.ApplyToTargetServerGroup("serverGroup")