Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

AgentProfile Class

 

Applies To: SQL Server 2016 Preview

Encapsulates all operations on replication agent profiles, such as creating, deleting, adding, and removing parameters, and assigning specific profiles to certain agents.

Namespace:   Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.AgentProfile

public sealed class AgentProfile : ReplicationObject

NameDescription
System_CAPS_pubmethodAgentProfile()

Initializes a new instance of the AgentProfile class.

System_CAPS_pubmethodAgentProfile(Int32, ServerConnection)

Initializes a new instance of the AgentProfile class with a specified agent profile ID value and server connection.

System_CAPS_pubmethodAgentProfile(String, ServerConnection)

Initializes a new instance of the AgentProfile class with the specified profile name and server connection.

NameDescription
System_CAPS_pubpropertyAgentType

Gets or sets the type of replication agent for which the profile is intended.

System_CAPS_pubpropertyCachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyDefault

Specifies whether this profile is the default profile for the given replication agent type.

System_CAPS_pubpropertyDescription

Gets or sets a textual description of the replication agent profile.

System_CAPS_pubpropertyIsExistingObject

Gets whether the object exists on the server or not.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyName

Gets or sets the name of the replication agent profile.

System_CAPS_pubpropertyProfileId

System_CAPS_pubpropertySqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)

System_CAPS_pubpropertyType

Specifies whether the replication agent profile is pre-defined by replication or created by a user.

System_CAPS_pubpropertyUserData

Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

NameDescription
System_CAPS_pubmethodAddParameter(String, String)

Adds a parameter to the replication agent profile.

System_CAPS_pubmethodAssignToAgent(String, Int32)

Assigns the replication agent profile to a specific replication agent job.

System_CAPS_pubmethodChangeParameter(String, String)

Changes the value of an existing replication agent parameter in the profile.

System_CAPS_pubmethodCommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubmethodCreate()

Creates the replication agent profile on the instance of SQL Server by using the current properties. 

System_CAPS_pubmethodDecouple()

Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodEnumParameterInfo()

Returns information about parameters that can be set and that are available for the replication agent profile.

System_CAPS_pubmethodEnumParameters()

Returns all existing parameters that are set for the replication agent profile.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoad()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodLoadProperties()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodMakeDefault()

Sets the profile as the default profile for all replication agents of the same type.

System_CAPS_pubmethodRefresh()

Reloads the properties of the object. (Inherited from ReplicationObject.)

System_CAPS_pubmethodRemove()

Removes an existing replication agent profile from the Distributor.

System_CAPS_pubmethodRemoveParameter(String)

Removes an existing parameter from the replication agent profile.

System_CAPS_pubmethodScript(ScriptOptions)

Generates a Transact-SQL script that can be used to re-create the agent profile.

System_CAPS_pubmethodToString()

(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.

Return to top

Community Additions

Show:
© 2015 Microsoft