AgentProfile.AgentType 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 or sets the type of replication agent for which the profile is intended.
public:
property Microsoft::SqlServer::Replication::AgentType AgentType { Microsoft::SqlServer::Replication::AgentType get(); void set(Microsoft::SqlServer::Replication::AgentType value); };public Microsoft.SqlServer.Replication.AgentType AgentType { get; set; }member this.AgentType : Microsoft.SqlServer.Replication.AgentType with get, setPublic Property AgentType As AgentTypeProperty Value
An AgentType object value that specifies the replication agent type.
Exceptions
When you set AgentType for an existing profile.
When MiscellaneousAgents or any other unsupported values of AgentType are supplied.
Remarks
The AgentType property is a read/write property, and it is necessary to set this property before the object is created. Once the profile has been created on the server, this property cannot be changed.
Setting a value of MiscellaneousAgents is not supported.
The AgentType property can be retrieved only by members of the sysadmin fixed server role at the Distributor or by members of the replmonitor fixed database role.
The AgentType property can be set only by members of the sysadmin fixed server role at the Distributor when a new profile is being created on the server.
Retrieving AgentType is equivalent to executing sp_help_agent_profile (Transact-SQL).
Setting AgentType and calling Create is equivalent to executing sp_add_agent_profile (Transact-SQL).