Поделиться через


sp_syscollector_stop_collection_set (Transact-SQL)

Область применения: SQL Server

Останавливает набор элементов сбора.

Соглашения о синтаксисе Transact-SQL

Синтаксис

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. @collection_set_id должно иметь значение, если @name NULL.

[ @name = ] N'name'

Имя набора элементов сбора. @name имеет имя sysname с значением по умолчаниюNULL. @name должно иметь значение, если @collection_set_id NULL.

[ @stop_collection_job = ] stop_collection_job

Указывает, что задание коллекции для набора коллекций должно быть остановлено при его запуске. @stop_collection_job бит с значением по умолчанию1.

@stop_collection_job применяется только к наборам коллекций с режимом сбора, заданным в кэшированном режиме. Дополнительные сведения см. в sp_syscollector_create_collection_set.

Значения кода возврата

0 (успешно) или 1 (сбой).

Замечания

sp_syscollector_create_collection_set должен выполняться в контексте msdb системной базы данных.

Разрешения

Для выполнения этой процедуры требуется членство в предопределенных ролевые роли базы данных dc_operator (с разрешением EXECUTE).

Примеры

В следующем примере набор сбора останавливается с помощью его идентификатора.

USE msdb;
GO
EXEC sp_syscollector_stop_collection_set
    @collection_set_id = 1;