sp_update_job (Transact-SQL)

Altera os atributos de um trabalho.

Ícone de vínculo de tópicoConvenções de sintaxe Transact-SQL

Sintaxe

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 ]

Argumentos

  • [ @job_id =] job_id
    O número de identificação do trabalho a ser atualizado. job_id é uniqueidentifier.

  • [ @job_name =] 'job_name'
    O nome do trabalho. job_nameé nvarchar(128).

    ObservaçãoObservação

    É necessário especificar a job_id ou o job_name, mas não é possível especificar ambos ao mesmo tempo.

  • [ @new_name =] 'new_name'
    O novo nome do trabalho. new_nameé nvarchar(128).

  • [ @enabled =] enabled
    Especifica se o trabalho está habilitado (1) ou não habilitado (0). enabled é tinyint.

  • [ @description =] 'description'
    A descrição do trabalho. description é nvarchar(512).

  • [ @start_step_id =] step_id
    O número de identificação da primeira etapa a ser executada para o trabalho. step_idé int.

  • [ @category_name =] 'category'
    A categoria do trabalho. categoryé nvarchar(128).

  • [ @owner_login_name =] 'login'
    O nome do logon que é proprietário do trabalho. loginé nvarchar(128). Somente membros da função de servidor fixa sysadmin podem alterar a propriedade do trabalho.

  • [ @notify_level_eventlog =] eventlog_level
    Especifica quando colocar uma entrada no log de aplicativos do Microsoft Windows para esse trabalho. eventlog_levelé int e pode ser um destes valores.

    Valor

    Descrição (ação)

    0

    Nunca

    1

    Caso haja êxito

    2

    Caso haja falha

    3

    Sempre

  • [ @notify_level_email =] email_level
    Especifica quando enviar um email após a conclusão deste trabalho. email_levelé int. email_levelusa os mesmos valores que eventlog_level.

  • [ @notify_level_netsend =] netsend_level
    Especifica quando enviar uma mensagem de rede após a conclusão deste trabalho. netsend_levelé int. netsend_levelusa os mesmos valores que eventlog_level.

  • [ @notify_level_page =] page_level
    Especifica quando enviar uma página após a conclusão deste trabalho. page_levelé int. page_levelusa os mesmos valores que eventlog_level.

  • [ @notify_email_operator_name =] 'email_name'
    O nome de email do operador para o qual o email é enviado quando email_level é alcançado. email_name é nvarchar(128).

  • [ @notify_netsend_operator_name =] 'netsend_operator'
    O nome do operador para o qual a mensagem de rede é enviada. netsend_operator é nvarchar(128).

  • [ @notify_page_operator_name =] 'page_operator'
    O nome do operador para o qual a página é enviada. page_operator é nvarchar(128).

  • [ @delete_level =] delete_level
    Especifica quando excluir um trabalho. delete_valueé int. delete_levelusa os mesmos valores que eventlog_level.

  • [ @automatic_post =] automatic_post
    Reservado.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Comentários

sp_update_job deve ser executado a partir do banco de dados msdb.

sp_update_job altera somente essas configurações para as quais são fornecidos valores de parâmetro. Se um parâmetro for omitido, a configuração atual será retida.

Permissões

Por padrão, os membros da função de servidor fixa sysadmin podem executar este procedimento armazenado. Deve ser concedida a outros usuários uma das seguintes funções de banco de dados fixas do SQL Server Agent no banco de dados msdb:

  • SQLAgentUserRole

  • SQLAgentReaderRole

  • SQLAgentOperatorRole

Para obter detalhes sobre as permissões dessas funções, consulte Funções de banco de dados fixas do SQL Server Agent.

Somente os membros de sysadmin podem usar este procedimento armazenado para editar os atributos de trabalhos que são de propriedade de outros usuários.

Exemplos

O exemplo a seguir altera o nome, a descrição e o status habilitado do trabalho 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