sp_syscollector_stop_collection_set (Transact-SQL)
適用対象: 
SQL Server
コレクション セットを停止します。
構文
sp_syscollector_stop_collection_set
[ [ @collection_set_id = ] collection_set_id ]
[ , [ @name = ] N'name' ]
[ , [ @stop_collection_job = ] stop_collection_job ]
[ ; ]
引数
[ @collection_set_id = ] collection_set_id
コレクション セットの一意のローカル識別子。 @collection_set_id は int で、既定値は NULL です。 @nameがNULL場合、@collection_set_idには値が必要です。
[ @name = ] N'name'
コレクション セットの名前。 @name は sysname で、既定値は NULL です。 @collection_set_idがNULL場合、@nameには値が必要です。
[ @stop_collection_job = ] stop_collection_job
コレクション セットが実行されている場合は、コレクション セットのコレクション ジョブを停止することを指定します。 @stop_collection_job は ビットで、既定の 1です。
@stop_collection_job は、コレクション モードがキャッシュに設定されているコレクション セットにのみ適用されます。 詳細については、「 sp_syscollector_create_collection_set」を参照してください。
リターン コードの値
0 (成功) または 1 (失敗)。
解説
sp_syscollector_create_collection_set は、 msdb システム データベースのコンテキストで実行する必要があります。
アクセス許可
このプロシージャを実行するには、(EXECUTE 権限を持つ) dc_operator 固定データベース ロールのメンバーシップが必要です。
例
次の例では、その識別子を使用してコレクション セットを停止します。
USE msdb;
GO
EXEC sp_syscollector_stop_collection_set
@collection_set_id = 1;