PullSubscription.AgentSchedule Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets the schedule for the agent job used to synchronize the subscription.
public:
property Microsoft::SqlServer::Replication::ReplicationAgentSchedule ^ AgentSchedule { Microsoft::SqlServer::Replication::ReplicationAgentSchedule ^ get(); };public Microsoft.SqlServer.Replication.ReplicationAgentSchedule AgentSchedule { get; }member this.AgentSchedule : Microsoft.SqlServer.Replication.ReplicationAgentSchedulePublic ReadOnly Property AgentSchedule As ReplicationAgentScheduleProperty Value
A ReplicationAgentSchedule object that represents the schedule for the subscription.
Remarks
You must set the properties of the returned ReplicationAgentSchedule object before creating the subscription. Once the schedule is set, you cannot change it using Replication Management Objects (RMO). Instead you must call the JobSchedule class or execute sp_update_schedule (Transact-SQL) to change an existing schedule, where <xref:Microsoft.SqlServer.Replication.PullSubscription.AgentJobID%2A> represents the ID of the job's schedule.
The AgentSchedule property can only be retrieved by members of the sysadmin fixed server role at the Subscriber or by members of the db_owner fixed database role on the subscription database.
Retrieving the AgentSchedule property is equivalent to executing sp_helppullsubscription (Transact-SQL) or sp_helpmergepullsubscription (Transact-SQL).
Setting an agent schedule is equivalent to executing sp_addpullsubscription_agent (Transact-SQL) or sp_addmergepullsubscription_agent (Transact-SQL).