sp_help_agent_default (Transact-SQL)

適用対象: SQL Server Azure SQL Managed Instance

パラメーターとして渡されたエージェント タイプについて、既定の構成の ID を取得します。 このストアド プロシージャは、任意のデータベース上のディストリビューター側で実行されます。

Transact-SQL 構文表記規則

構文

sp_help_agent_default [ @profile_id = ] profile_id OUTPUT
        , [ @agent_type = ] agent_type
[ ; ]

引数

[ @profile_id = ] profile_id OUTPUT

エージェントの種類の既定の構成の ID。 @profile_id は int で、既定値はありません。 @profile_id は OUTPUT パラメーターでもあり、エージェントの種類の既定の構成の ID を返します。

[ @agent_type = ] 'agent_type'

エージェントの種類。 @agent_type は既定値なしで int であり、次のいずれかの値を指定できます。

Value	説明
1	スナップショット エージェント
2	ログ リーダー エージェント (Log Reader Agent)
3	ディストリビューション エージェント
4	[マージ エージェント]
9	キュー リーダー エージェント (Queue Reader Agent)

リターン コードの値

0 (成功) または 1 (失敗)。

解説

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

アクセス許可

sysadmin固定サーバー ロールまたは replmonitor 固定データベース ロールのメンバーのみがsp_help_agent_defaultを実行できます。

関連するコンテンツ

• システム ストアド プロシージャ (Transact-SQL)