AgentProfile Class
Encapsulates all operations on replication agent profiles, such as creating, deleting, adding, and removing parameters, and assigning specific profiles to certain agents.
Assembly: Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
Microsoft.SqlServer.Replication.ReplicationObject
Microsoft.SqlServer.Replication.AgentProfile
| Name | Description | |
|---|---|---|
 | AgentProfile() | Initializes a new instance of the AgentProfile class. |
| AgentProfile(Int32, ServerConnection) | Initializes a new instance of the AgentProfile class with a specified agent profile ID value and server connection. |
| AgentProfile(String, ServerConnection) | Initializes a new instance of the AgentProfile class with the specified profile name and server connection. |
| Name | Description | |
|---|---|---|
 | AgentType | Gets or sets the type of replication agent for which the profile is intended. |
| CachePropertyChanges | Gets or sets whether to cache changes made to the replication properties or to apply them immediately.(Inherited from ReplicationObject.) |
| ConnectionContext | Gets or sets the connection to an instance of Microsoft SQL Server.(Inherited from ReplicationObject.) |
| Default | Specifies whether this profile is the default profile for the given replication agent type. |
| Description | Gets or sets a textual description of the replication agent profile. |
| IsExistingObject | Gets whether the object exists on the server or not.(Inherited from ReplicationObject.) |
| Name | Gets or sets the name of the replication agent profile. |
| ProfileId | Gets the profile ID. |
| SqlServerName | Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.) |
| Type | Specifies whether the replication agent profile is pre-defined by replication or created by a user. |
| UserData | Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.) |
| Name | Description | |
|---|---|---|
| AddParameter(String, String) | Adds a parameter to the replication agent profile. |
| AssignToAgent(String, Int32) | Assigns the replication agent profile to a specific replication agent job. |
| ChangeParameter(String, String) | Changes the value of an existing replication agent parameter in the profile. |
| CommitPropertyChanges() | Sends all the cached property change statements to the instance of Microsoft SQL Server.(Inherited from ReplicationObject.) |
| Create() | Creates the replication agent profile on the instance of SQL Server by using the current properties. |
| Decouple() | Decouples the referenced replication object from the server. (Inherited from ReplicationObject.) |
| EnumParameterInfo() | Returns information about parameters that can be set and that are available for the replication agent profile. |
| EnumParameters() | Returns all existing parameters that are set for the replication agent profile. |
| Equals(Object) | (Inherited from Object.) |
| GetHashCode() | (Inherited from Object.) |
| GetType() | (Inherited from Object.) |
| Load() | Loads the properties of an existing object from the server. (Inherited from ReplicationObject.) |
| LoadProperties() | Loads the properties of an existing object from the server. (Inherited from ReplicationObject.) |
| MakeDefault() | Sets the profile as the default profile for all replication agents of the same type. |
| Refresh() | Reloads the properties of the object. (Inherited from ReplicationObject.) |
| Remove() | Removes an existing replication agent profile from the Distributor. |
| RemoveParameter(String) | Removes an existing parameter from the replication agent profile. |
| Script(ScriptOptions) | Generates a Transact-SQL script that can be used to re-create the agent profile. |
| ToString() | (Inherited from Object.) |
Public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Microsoft.SqlServer.Replication Namespace
Replication Agents Overview)