sp_syscollector_delete_collection_item (Transact-SQL)

  • [アーティクル]

適用対象:SQL Server

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

Transact-SQL 構文表記規則

構文

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

引数

[ @collection_item_id = ] collection_item_id

コレクション項目の一意識別子。 @collection_item_idは int で、既定値は NULL. @nameの場合、@collection_item_idには値が必要ですNULL。

[ @name = ] N'name'

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

リターン コードの値

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

解説

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

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

アクセス許可

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

例

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

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

関連するコンテンツ