sp_help_agent_profile (Transact-SQL)
適用対象: SQL Server Azure SQL Managed Instance
指定されたエージェントのプロファイルを表示します。 このストアド プロシージャは、任意のデータベースのディストリビューターで実行されます。
構文
sp_help_agent_profile
[ [ @agent_type = ] agent_type ]
[ , [ @profile_id = ] profile_id ]
[ ; ]
引数
[ @agent_type = ] agent_type
エージェントの種類。 @agent_type は int であり、これらの値のいずれかを指定できます。
値 | 説明 |
---|---|
0 (既定値) |
すべてのエージェントの種類 |
1 |
スナップショット エージェント |
2 |
ログ リーダー エージェント (Log Reader Agent) |
3 |
ディストリビューション エージェント |
4 |
[マージ エージェント] |
9 |
キュー リーダー エージェント (Queue Reader Agent) |
[ @profile_id = ] profile_id
表示するプロファイルの ID。 @profile_id は int で、既定値は -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 | このプロファイルがこのエージェントの種類の既定値かどうかを指定します。 |
リターン コードの値
0
(成功) または 1
(失敗)。
解説
sp_help_agent_profile
は、すべての種類のレプリケーションで使用されます。
アクセス許可
sysadmin固定サーバー ロールまたは replmonitor 固定データベース ロールのメンバーのみがsp_help_agent_profile
を実行できます。