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


sp_syscollector_stop_collection_set

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

Значок ссылки на разделСинтаксические обозначения в Transact-SQL

Синтаксис

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

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

  • [ @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;

См. также

Справочник

Другие ресурсы