sp_syscollector_delete_collection_set

删除用户定义的收集组及其所有收集项。

主题链接图标Transact-SQL 语法约定

语法

sp_syscollector_delete_collection_set [[ @collection_set_id = ] collection_set_id OUTPUT ]
        , [[ @name = ] 'name' ]

参数

  • [ @collection_set_id = ] collection_set_id
    是收集组的唯一标识符。collection_set_id 的数据类型为 int,且在 name 为 NULL 时必须具有值。

  • [ @name = ] 'name'
    是收集组的名称。name 的数据类型为 sysname,且在 collection_set_id 为 NULL 时必须具有值。

返回代码值

0(成功)或 1(失败)

注释

sp_syscollector_delete_collection_set 必须在 msdb 系统数据库的上下文中运行。

collection_set_id 或 name 必须具有值,不能两者均为 NULL。若要获取这些值,请查询 syscollector_collection_set 系统视图。

不能删除系统定义的收集组。

权限

必须具有 dc_admin(拥有 EXECUTE 权限)固定数据库角色的成员身份才能执行此过程。

示例

以下示例通过指定 collection_set_id 来删除用户定义的收集组。

USE msdb;
GO
EXEC dbo.sp_syscollector_delete_collection_set
    @collection_set_id = 4;