sp_syscollector_delete_collection_item (Transact-SQL)
コレクション セットからコレクション アイテムを削除します。
適用対象: SQL Server (SQL Server 2008 から現在のバージョンまで) |
構文
sp_syscollector_delete_collection_item [[ @collection_item_id = ] collection_item_id ]
, [[ @name = ] 'name' ]
引数
[ @collection\_item\_id = ] collection_item_id
コレクション アイテムの一意な識別子を指定します。 collection_item_id のデータ型は int で、既定値は NULL です。 name が NULL の場合は必ず collection_item_id の値を指定する必要があります。[ @name = ] 'name'
コレクション アイテムの名前を指定します。 name のデータ型は sysname で、既定値は NULL です。 collection_item_id が NULL の場合は必ず name の値を指定する必要があります。
リターン コードの値
0 (成功) または 1 (失敗)
説明
sp_syscollector_delete_collection_item は、msdb システム データベースのコンテキストで実行する必要があります。 コレクション アイテムは、システム コレクション セットから削除できません。
この操作が実行されている間、コレクション アイテムを含むコレクション セットは停止し、再開されます。
権限
このプロシージャを実行するには、(EXECUTE 権限を持つ) dc_admin 固定データベース ロールのメンバーシップが必要です。
使用例
次の例では、MyCollectionItem1 というコレクション アイテムを削除します。
USE msdb;
GO
EXEC sp_syscollector_delete_collection_item @name = 'MyCollectionItem1';
関連項目
参照
sp_syscollector_create_collection_item (Transact-SQL)
データ コレクター ストアド プロシージャ (Transact-SQL)
syscollector_collection_items (Transact-SQL)