AgentProfile クラス

定義

レプリケーションエージェントプロファイルに関するすべての操作をカプセル化します。例えば、パラメータの作成、削除、追加、削除、特定のエージェントへのプロファイル割り当てなどです。

public ref class AgentProfile sealed : Microsoft::SqlServer::Replication::ReplicationObject
public sealed class AgentProfile : Microsoft.SqlServer.Replication.ReplicationObject
type AgentProfile = class
    inherit ReplicationObject
Public NotInheritable Class AgentProfile
Inherits ReplicationObject
継承
AgentProfile

注釈

スレッド セーフ

このタイプのパブリックスタティック(Microsoft Visual BasicではShared)メンバーはマルチスレッド操作に安全です。 インスタンス メンバーがスレッド セーフであるとは限りません。

コンストラクター

名前 説明
AgentProfile()

AgentProfile クラスの新しいインスタンスを初期化します。

AgentProfile(Int32, ServerConnection)

指定されたエージェントプロファイルID値とサーバー接続を持つ新しい AgentProfile インスタンスを初期化します。

AgentProfile(String, ServerConnection)

指定されたプロファイル名とサーバー接続で AgentProfile クラスの新しいインスタンスを初期化します。

プロパティ

名前 説明
AgentType

プロファイルが意図されるレプリケーションエージェントの種類を取得するか設定します。

CachePropertyChanges

レプリケーションプロパティの変更をキャッシュするか、即座に適用するかを取得または設定します。

(継承元 ReplicationObject)
ConnectionContext

Microsoft SQL Serverのインスタンスへの接続を取得または設定します。

(継承元 ReplicationObject)
Default

このプロファイルが指定されたレプリケーションエージェントタイプのデフォルトプロファイルかどうかを指定します。

Description

複製エージェントプロファイルのテキスト記述を取得するか設定します。

IsExistingObject

オブジェクトがサーバー上に存在するかどうかを把握します。

(継承元 ReplicationObject)
Name

複製エージェントのプロファイル名を取得するか設定します。

ProfileId

プロファイルIDを取得します。

SqlServerName

このオブジェクトが接続されているMicrosoft SQL Serverインスタンスの名前を取得します。

(継承元 ReplicationObject)
Type

レプリケーションエージェントプロファイルがレプリケーションによって事前定義されているか、ユーザーによって作成されたかを指定します。

UserData

ユーザーが自分のデータをオブジェクトにアタッチできるオブジェクトプロパティを取得したり設定したりします。

(継承元 ReplicationObject)

メソッド

名前 説明
AddParameter(String, String)

レプリケーションエージェントプロファイルにパラメータを追加します。

AssignToAgent(String, Int32)

レプリケーションエージェントのプロファイルを特定のレプリケーションエージェントのジョブに割り当てます。

ChangeParameter(String, String)

プロファイル内の既存のレプリケーションエージェントパラメータの値を変更します。

CheckValidCreation()

有効な複製の作成を確認します。

(継承元 ReplicationObject)
CheckValidDefinition(Boolean)

定義が有効かどうかを示します。

(継承元 ReplicationObject)
CommitPropertyChanges()

キャッシュされたプロパティ変更文をすべてMicrosoft SQL Serverのインスタンスに送信します。

(継承元 ReplicationObject)
Create()

現在のプロパティを使ってSQL Serverインスタンス上でレプリケーションエージェントプロファイルを作成します。

Decouple()

参照されたレプリケーションオブジェクトをサーバーから切り離します。

(継承元 ReplicationObject)
EnumParameterInfo()

レプリケーションエージェントプロファイルで設定可能なパラメータや利用可能なパラメータの情報を返します。

EnumParameters()

レプリケーションエージェントプロファイルに設定されているすべての既存のパラメータを返します。

GetChangeCommand(StringBuilder, String, String)

レプリケーションからの変更コマンドを返します。

(継承元 ReplicationObject)
GetCreateCommand(StringBuilder, Boolean, ScriptOptions)

レプリケーションからcreateコマンドを返します。

(継承元 ReplicationObject)
GetDropCommand(StringBuilder, Boolean)

レプリケーションからドロップコマンドを返します。

(継承元 ReplicationObject)
InternalRefresh(Boolean)

レプリケーションから内部リフレッシュを開始します。

(継承元 ReplicationObject)
Load()

サーバーから既存のオブジェクトのプロパティを読み込みます。

(継承元 ReplicationObject)
LoadProperties()

サーバーから既存のオブジェクトのプロパティを読み込みます。

(継承元 ReplicationObject)
MakeDefault()

同じタイプのすべてのレプリケーションエージェントに対して、そのプロファイルをデフォルトのプロファイルとして設定します。

Refresh()

オブジェクトのプロパティをリロードします。

(継承元 ReplicationObject)
Remove()

ディストリビューターから既存のレプリケーションエージェントプロファイルを削除します。

RemoveParameter(String)

レプリケーションエージェントプロファイルから既存のパラメータを削除します。

Script(ScriptOptions)

エージェントプロファイルを再作成するための Transact-SQL スクリプトを生成します。

適用対象

こちらもご覧ください