sp_syscollector_stop_collection_set (Transact-SQL)

適用対象:SQL Server

コレクション セットを停止します。

Transact-SQL 構文表記規則

構文

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. @collection_set_id@name場合は値が必要ですNULL。

[ @name = ] N'name'

コレクション セットの名前。 @nameは sysname で、既定値は NULL. @nameが の場合は値 @collection_set_idをNULL持つ必要があります。

[ @stop_collection_job = ] stop_collection_job

コレクション セットが実行されている場合は、コレクション セットのコレクション ジョブを停止することを指定します。 @stop_collection_jobはビットで、既定値1です。

@stop_collection_jobは、コレクション モードがキャッシュに設定されているコレクション セットにのみ適用されます。 詳細については、「sp_syscollector_create_collection_set (Transact-SQL)」を参照してください。

リターン コードの値

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

解説

sp_syscollector_create_collection_set は、システム データベースのコンテキストで実行する msdb 必要があります。

アクセス許可

このプロシージャを実行するには、(EXECUTE 権限を持つ) dc_operator固定データベース ロールのメンバーシップが必要です。

例

次の例では、その識別子を使用してコレクション セットを停止します。

USE msdb;
GO
EXEC sp_syscollector_stop_collection_set
    @collection_set_id = 1;

関連するコンテンツ

• データ コレクション
• データ コレクター ストアド プロシージャ (Transact-SQL)