sp_syscollector_stop_collection_set (Transact-SQL)

项目
07/07/2023

停止收集组。

语法

sp_syscollector_stop_collection_set
    [ [ @collection_set_id = ] collection_set_id ]
    [ , [ @name = ] N'name' ]
    [ , [ @stop_collection_job = ] stop_collection_job ]
[ ; ]

参数

[ @collection_set_id = ] collection_set_id

收集组的唯一本地标识符。 @collection_set_id 为 int，默认值为 NULL。如果 @name 为 NULL，则@collection_set_id必须具有值。

[ @name = ] N'name'

收集组的名称。 @name 为 sysname，默认值为 NULL。如果 @collection_set_id 为 NULL，则@name必须具有值。

[ @stop_collection_job = ] stop_collection_job

指定收集组的收集作业在正在运行时应停止该作业。 @stop_collection_job 为位，默认 1为。

@stop_collection_job 仅适用于集合模式设置为缓存的收集组。有关详细信息，请参阅 sp_syscollector_create_collection_set (Transact-SQL) 。

返回代码值

0 (成功) 或 1 (失败) 。

备注

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

权限

需要具有 EXECUTE 权限) 固定数据库角色的 dc_operator (的成员身份才能执行此过程。

示例

以下示例使用收集组的标识符停止此收集组。

USE msdb;
GO
EXEC sp_syscollector_stop_collection_set
    @collection_set_id = 1;