sp_update_job (Transact-SQL)

Изменяет атрибуты задания.

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

Синтаксис

sp_update_job [ @job_id =] job_id | [@job_name =] 'job_name'
     [, [@new_name =] 'new_name' ] 
     [, [@enabled =] enabled ]
     [, [@description =] 'description' ] 
     [, [@start_step_id =] step_id ]
     [, [@category_name =] 'category' ] 
     [, [@owner_login_name =] 'login' ]
     [, [@notify_level_eventlog =] eventlog_level ]
     [, [@notify_level_email =] email_level ]
     [, [@notify_level_netsend =] netsend_level ]
     [, [@notify_level_page =] page_level ]
     [, [@notify_email_operator_name =] 'email_name' ]
          [, [@notify_netsend_operator_name =] 'netsend_operator' ]
          [, [@notify_page_operator_name =] 'page_operator' ]
     [, [@delete_level =] delete_level ] 
     [, [@automatic_post =] automatic_post ]

Аргументы

  • [ @job_id =] job_id
    Идентификатор обновляемого задания. Аргумент job_id имеет тип uniqueidentifier.

  • [ @job_name =] "job_name"
    Имя задания. Аргумент job_name имеет тип nvarchar(128).

    ПримечаниеПримечание

    Должен быть задан аргумент job_id или аргумент job_name, но одновременно эти аргументы задаваться не могут.

  • [ @new_name =] 'new_name'
    Новое имя задания. Аргумент new_name имеет тип nvarchar(128).

  • [ @enabled =] enabled
    Указывает, включено задание (1) или не включено (0). Аргумент enabled имеет тип tinyint.

  • [ @description=] 'description'
    Описание задания. Аргумент description имеет тип nvarchar(512).

  • [ @start_step_id = ] step_id
    Идентификатор первого этапа, выполняемого в ходе задания. Аргумент step_id имеет тип int.

  • [ @category_name =] 'category'
    Категория задания. Аргумент category имеет тип nvarchar(128).

  • [ @owner_login_name =] 'login'
    Имя учетной записи, владеющей заданием. Аргумент login имеет тип nvarchar(128). Только члены предопределенной роли сервера sysadmin могут изменять владельца задания.

  • [ @notify_level_eventlog =] eventlog_level
    Указывает, следует ли помещать запись в журнал приложений Microsoft Windows для данного задания. Аргумент eventlog_level имеет тип int и может принимать одно из следующих значений.

    Значение

    Описание (действие)

    0

    Никогда

    1

    При успешном завершении

    2

    При сбое

    3

    Всегда

  • [ @notify_level_email =] email_level
    Указывает, нужно ли послать сообщение электронной почты по завершении этого задания. Аргумент email_level имеет тип int. Аргумент email_level использует те же значения, что и аргумент eventlog_level.

  • [ @notify_level_netsend =] netsend_level
    Указывает, нужно ли послать сетевое сообщение по завершении этого задания. Аргумент netsend_level имеет тип int. Аргумент netsend_level использует те же значения, что и аргумент eventlog_level.

  • [ @notify_level_page =] page_level
    Указывает, необходимо ли послать страницу по завершении этого задания. Аргумент page_level имеет тип int. Аргумент page_level использует те же значения, что и аргумент eventlog_level.

  • [ @notify_email_operator_name =] 'email_name'
    Имя электронной почты оператора, которому посылается сообщение электронной почты, если сработал аргумент email_level. Аргумент email_name имеет тип nvarchar(128).

  • [ @notify_netsend_operator_name =] 'netsend_operator'
    Имя оператора, которому посылается сетевое сообщение. Аргумент netsend_operator имеет тип nvarchar(128).

  • [ @notify_page_operator_name =] 'page_operator'
    Имя оператора, которому посылается страница. Аргумент page_operator имеет тип nvarchar(128).

  • [ @delete_level =] delete_level
    Задается, если необходимо удалить задание. Аргумент delete_value имеет тип int. Аргумент delete_level использует те же значения, что и аргумент eventlog_level.

  • [ @automatic_post =] automatic_post
    Зарезервировано.

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

0 (успешное завершение) или 1 (неуспешное завершение)

Замечания

Процедура sp_update_job должна запускаться из базы данных msdb.

Процедура sp_update_job изменяет только те установки, для которых предоставляются значения параметров. Если параметр пропущен, сохраняется текущая настройка.

Разрешения

По умолчанию эту хранимую процедуру могут выполнять только члены предопределенной роли сервера sysadmin. Другим пользователям должна быть предоставлена одна из следующих предопределенных ролей базы данных агента сервера SQL Server в базе данных msdb:

  • SQLAgentUserRole;

  • SQLAgentReaderRole;

  • SQLAgentOperatorRole.

Дополнительные сведения о разрешениях для этих ролей см. в разделе Предопределенные роли базы данных агента SQL Server.

Использовать эту хранимую процедуру для редактирования атрибутов заданий, владельцами которых являются другие пользователи, могут только члены роли sysadmin.

Примеры

В следующем примере изменяются имя, описание и включенное состояние задания NightlyBackups.

USE msdb ;
GO

EXEC dbo.sp_update_job
    @job_name = N'NightlyBackups',
    @new_name = N'NightlyBackups -- Disabled',
    @description = N'Nightly backups disabled during server migration.',
    @enabled = 0 ;
GO