sp_help_agent_profile (Transact-SQL)

指定されたエージェントのプロファイルを表示します。このストアドプロシージャは、ディストリビュータ側で任意のデータベースについて実行されます。

構文

sp_help_agent_profile [ [ @agent_type = ] agent_type ] 
    [ , [ @profile_id = ] profile_id ]

[ @agent_type=] agent_type
エージェントのタイプを指定します。agent_type のデータ型は int で、既定値は 0 です。次のいずれかの値をとります。

[ @profile_id=] profile_id
表示対象のプロファイルの ID を指定します。profile_id のデータ型は int で、既定値は -1 です。-1 は、MSagent_profiles テーブル内のすべてのプロファイルを返すことを示します。

列名	データ型	説明
profile_id	int	プロファイルの ID です。
profile_name	sysname	エージェントタイプに一意です。
agent_type	int	1 = スナップショットエージェント 2 = ログリーダーエージェント 3 = ディストリビューションエージェント 4 = マージエージェント 9 = キューリーダーエージェント
Type	int	0 = システム 1 = カスタム
description	varchar(3000)	プロファイルの説明です。
def_profile	bit	このプロファイルがこのエージェントタイプの既定値かどうかを示します。

sp_help_agent_profile は、すべての種類のレプリケーションで使用します。

sp_help_agent_profile を実行できるのは、固定サーバーロール sysadmin または固定データベースロール replmonitor のメンバだけです。

成功した場合は 0 を、失敗した場合は 1 をそれぞれ返します。