sp_update_job (Transact-SQL)

Modifie les attributs d'un travail.

Icône Lien de rubriqueConventions de la syntaxe de Transact-SQL

Syntaxe

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 ]

Arguments

  • [ @job_id =] job_id
    Numéro d'identification du travail à mettre à jour. job_idest de type uniqueidentifier.

  • [ @job_name =] 'job_name'
    Nom du travail. job_nameest de type nvarchar(128).

    [!REMARQUE]

    Vous pouvez définir la valeur de job_id ou de job_name, mais pas les deux valeurs à la fois.

  • [ @new_name =] 'new_name'
    Nouveau nom du travail. new_nameest de type nvarchar(128).

  • [ @enabled =] enabled
    Indique si le travail est activé (1) ou désactivé (0). L'argument enabledest de type tinyint.

  • [ @description = ] 'description'
    Description du travail. description est de type nvarchar(512).

  • [ @start_step_id = ] step_id
    Numéro d'identification de la première étape à exécuter pour le travail. step_idest de type int.

  • [ @category_name =] 'category'
    Catégorie du travail. categoryest de type nvarchar(128).

  • [ @owner_login_name = ] 'login'
    Nom de la connexion propriétaire du travail. loginest de type nvarchar(128). Seuls les membres du rôle de serveur fixe sysadmin sont habilités à modifier la propriété d'un travail.

  • [ @notify_level_eventlog = ] eventlog_level
    Indique le moment auquel une entrée doit être ajoutée pour ce travail dans le journal d'applications Microsoft Windows. eventlog_levelest de type int et peut prendre l'une des valeurs suivantes.

    Valeur

    Description (action)

    0

    Jamais

    1

    Si succès

    2

    Si échec

    3

    Toujours

  • [ @notify_level_email = ] email_level
    Indique le moment où un message électronique doit être envoyé à la fin de ce travail. email_levelest de type int. Le paramètre email_levelutilise les mêmes valeurs que eventlog_level.

  • [ @notify_level_netsend = ] netsend_level
    Indique le moment où un message doit être envoyé sur le réseau à la fin de ce travail. netsend_levelest de type int. Le paramètre netsend_levelutilise les mêmes valeurs que eventlog_level.

  • [ @notify_level_page = ] page_level
    Indique le moment où une page doit être envoyée à la fin de ce travail. page_levelest de type int. Le paramètre page_levelutilise les mêmes valeurs que eventlog_level.

  • [ @notify_email_operator_name = ] 'email_name'
    Adresse électronique de l'opérateur auquel le message est envoyé une fois la valeur de email_level atteinte. email_name est de type nvarchar(128).

  • [ @notify_netsend_operator_name =] 'netsend_operator'
    Nom de l'opérateur auquel le message est envoyé par réseau. netsend_operator est de type nvarchar(128).

  • [ @notify_page_operator_name =] 'page_operator'
    Nom de l'opérateur auquel une page est envoyée. page_operator est de type nvarchar(128).

  • [ @delete_level = ] delete_level
    Indique le moment où le travail doit être supprimé. delete_valueest de type int. Le paramètre delete_levelutilise les mêmes valeurs que eventlog_level.

  • [ @automatic_post =] automatic_post
    Réservé.

Valeurs des codes renvoyés

0 (succès) ou 1 (échec)

Notes

La procédure sp_update_job doit être exécutée à partir de la base de données msdb.

sp_update_job modifie uniquement les paramètres possédant des valeurs. Si un paramètre est manquant, la valeur actuelle est retenue.

Autorisations

Seuls les membres du rôle de serveur fixe sysadmin peuvent exécuter cette procédure stockée. Les autres utilisateurs doivent disposer de l'un des rôles de base de données fixes SQL Server Agent suivants dans la base de données msdb.

  • SQLAgentUserRole

  • SQLAgentReaderRole

  • SQLAgentOperatorRole

Pour en savoir plus sur les autorisations de ces rôles, consultez Rôles de base de données fixes de l'Agent SQL Server.

Seuls les membres de sysadmin peuvent utiliser cette procédure stockée pour modifier les attributs des travaux que d'autres utilisateurs possèdent.

Exemple

Cet exemple modifie le nom, la description et l'état (activé ou non) du travail 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