次の方法で共有

sp_add_agent_parameter (Transact-SQL)

  • [アーティクル]

適用対象: SQL Server Azure SQL Managed Instance

エージェント プロファイルに新しいパラメーターとその値を追加します。 このストアド プロシージャは、任意のデータベースのディストリビューターで実行されます。

Transact-SQL 構文表記規則

構文

sp_add_agent_parameter [ @profile_id = ] profile_id
        , [ @parameter_name = ] 'parameter_name'
        , [ @parameter_value = ] 'parameter_value'
[ ; ]

引数

[ @profile_id = ] profile_id

msdb データベースのMSagent_profiles テーブルのプロファイルの ID。 @profile_id は int で、既定値はありません。

この@profile_idが表すエージェントの種類を確認するには、MSagent_profiles テーブルで@profile_idを見つけて、agent_typeフィールドの値を書き留めます。 値は次のとおりです。

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

[ @parameter_name = ] 'parameter_name'

パラメーターの名前。 @parameter_name は sysname で、既定値はありません。 システム プロファイルで既に定義されているパラメーターの一覧については、「 Replication エージェント プロファイルを参照してください。 各エージェントの有効なパラメーターの完全な一覧については、次のトピックを参照してください。

[ @parameter_value = ] 'parameter_value'

パラメーターに割り当てる値。 @parameter_value は nvarchar(255)で、既定値はありません。

リターン コードの値

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

解説

sp_add_agent_parameter は、スナップショット レプリケーション、トランザクション レプリケーション、マージ レプリケーションで使用されます。

アクセス許可

sysadmin固定サーバー ロールのメンバーのみがsp_add_agent_parameterを実行できます。

関連するコンテンツ