Publication.CreateSnapshotAgent Publication.CreateSnapshotAgent Publication.CreateSnapshotAgent Publication.CreateSnapshotAgent Method

Definition

Creates the SQL Server Agent job that is used to generate the initial snapshot for the publication, if this job does not already exist.

public:
 void CreateSnapshotAgent();
public void CreateSnapshotAgent ();
member this.CreateSnapshotAgent : unit -> unit
Public Sub CreateSnapshotAgent ()

Exceptions

The publication does not exist on the server, the server is not running on SQL Server 2005 or later, or the job already exists.

Remarks

The CreateSnapshotAgent method is used to create a snapshot job for an existing publication that was created with the CreateSnapshotAgentByDefault property set to false.

When configuring a Publisher with a remote Distributor, the values supplied for all properties, including SnapshotGenerationAgentProcessSecurity, are sent to the Distributor as plain text. You should encrypt the connection between the Publisher and its remote Distributor before calling the CreateSnapshotAgent method. For more information, see Encrypting Connections to SQL Server.

The CreateSnapshotAgent method can be called by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database.

Calling CreateSnapshotAgent is equivalent to executing sp_addpublication_snapshot (Transact-SQL).

Applies to