sp_syscollector_stop_collection_set
停止收集组。
语法
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 系统数据库的上下文中运行。
权限
必须具有 dc_operator(拥有 EXECUTE 权限)固定数据库角色的成员身份才能执行此过程。
示例
以下示例使用收集组的标识符停止此收集组。
USE msdb;
GO
EXEC sp_syscollector_stop_collection_set @collection_set_id = 1;