sp_syscollector_delete_collection_item (Transact-SQL)

適用対象: SQL サーバー

コレクション セットからコレクション項目を削除します。

Transact-SQL 構文表記規則

構文

sp_syscollector_delete_collection_item
    [ [ @collection_item_id = ] collection_item_id ]
    [ , [ @name = ] N'name' ]
[ ; ]

引数

[ @collection_item_id = ] collection_item_id

コレクション項目の一意識別子。 @collection_item_idint で、既定値は NULL です。 @nameNULLされている場合、@collection_item_idには値が必要です。

[ @name = ] N'name'

コレクション アイテムの名前です。 @namesysname で、既定値は空の文字列です。 @collection_item_idNULL場合は、@nameに値が必要です。

リターン コードの値

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

解説

sp_syscollector_delete_collection_item は、 msdb システム データベースのコンテキストで実行する必要があります。 コレクション項目をシステム コレクション セットから削除することはできません。

この操作が実行されている間、コレクション アイテムを含むコレクション セットは停止し、再開されます。

アクセス許可

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

次の例では、 MyCollectionItem1という名前のコレクション項目を削除します。

USE msdb;
GO
EXEC sp_syscollector_delete_collection_item @name = 'MyCollectionItem1';