sp_syscollector_stop_collection_set (Transact-SQL)

  • [アーティクル]

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

トピック リンク アイコン Transact-SQL 構文表記規則

構文

sp_syscollector_stop_collection_set 
    [ [ @collection_set_id = ] collection_set_id ]
    , [ [ @name = ] 'name' ]
    , [ [ @stop_collection_job = ] stop_collection_job ]

引数

  • [ @collection\_set\_id = ] collection_set_id
    コレクション セットの一意なローカル識別子を指定します。 collection_set_id のデータ型は int で、既定値は NULL です。 name が NULL の場合は必ず collection_set_id の値を指定する必要があります。

  • [ @name = ] 'name'
    コレクション セットの名前です。 name のデータ型は sysname で、既定値は NULL です。 collection_set_id が NULL の場合は必ず name の値を指定する必要があります。

  • [ @stop\_collection\_job = ] stop_collection_job
    コレクション セットのコレクション ジョブが実行されている場合に、停止を指定します。 stop_collection_job のデータ型は bit で、既定値は 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)

概念

データ コレクション