sp_help_job (Transact-sql)sp_help_job (Transact-SQL)

• 08/02/2016
• • 
  • 

適用対象: SQL Server Azure SQL Database Azure Synapse Analytics (SQL DW) Parallel Data Warehouse APPLIES TO: SQL Server Azure SQL Database Azure Synapse Analytics (SQL DW) Parallel Data Warehouse

自動化された操作を SQL ServerSQL Server で実行するときに SQL ServerSQL Server エージェントで使用されるジョブに関する情報を返します。Returns information about jobs that are used by SQL ServerSQL Server Agent to perform automated activities in SQL ServerSQL Server.

Transact-sql 構文表記規則 Transact-SQL Syntax Conventions

構文Syntax

  
sp_help_job { [ @job_id = ] job_id  
[ @job_name = ] 'job_name' }   
     [ , [ @job_aspect = ] 'job_aspect' ]   
     [ , [ @job_type = ] 'job_type' ]   
     [ , [ @owner_login_name = ] 'login_name' ]   
     [ , [ @subsystem = ] 'subsystem' ]   
     [ , [ @category_name = ] 'category' ]   
     [ , [ @enabled = ] enabled ]   
     [ , [ @execution_status = ] status ]   
     [ , [ @date_comparator = ] 'date_comparison' ]   
     [ , [ @date_created = ] date_created ]   
     [ , [ @date_last_modified = ] date_modified ]   
     [ , [ @description = ] 'description_pattern' ]  

引数Arguments

[ @job_id = ] job_idジョブの識別番号を指定します。[ @job_id = ] job_id The job identification number. job_idはuniqueidentifier,、既定値は NULL です。job_id is uniqueidentifier, with a default of NULL.

[ @job_name = ] 'job_name'ジョブの名前。[ @job_name = ] 'job_name' The name of the job. job_nameはsysname,、既定値は NULL です。job_name is sysname, with a default of NULL.

[ @job_aspect = ] 'job_aspect'表示するジョブ属性。[ @job_aspect = ] 'job_aspect' The job attribute to display. job_aspectはvarchar (9),、既定値は NULL の場合、これらの値のいずれかを指定できます。job_aspect is varchar(9), with a default of NULL, and can be one of these values.

[ @job_type = ] 'job_type'レポートに含めるジョブの種類。[ @job_type = ] 'job_type' The type of jobs to include in the report. job_typeはvarchar (12),、既定値は NULL です。job_type is varchar(12), with a default of NULL. Job_type ローカルまたはマルチサーバーを指定できます。job_type can be LOCAL or MULTI-SERVER.

[ @owner_login_name = ] 'login_name'ジョブの所有者のログイン名です。[ @owner_login_name = ] 'login_name' The login name of the owner of the job. login_nameはsysname,、既定値は NULL です。login_name is sysname, with a default of NULL.

[ @subsystem = ] 'subsystem'サブシステムの名前。[ @subsystem = ] 'subsystem' The name of the subsystem. サブシステムはnvarchar (40),、既定値は NULL です。subsystem is nvarchar(40), with a default of NULL.

[ @category_name = ] 'category'カテゴリの名前。[ @category_name = ] 'category' The name of the category. categoryはsysname,、既定値は NULL です。category is sysname, with a default of NULL.

[ @enabled = ] enabled有効なジョブまたは無効になっているジョブの情報を表示するかどうかを示す数値です。[ @enabled = ] enabled A number indicating whether information is shown for enabled jobs or disabled jobs. 有効になっているはtinyint,、既定値は NULL です。enabled is tinyint, with a default of NULL. 1は有効なジョブを示し、 0は無効になっているジョブを示します。1 indicates enabled jobs, and 0 indicates disabled jobs.

[ @execution_status = ] statusジョブの実行状態です。[ @execution_status = ] status The execution status for the jobs. 状態はint,、既定値は NULL の場合、これらの値のいずれかを指定できます。status is int, with a default of NULL, and can be one of these values.

[ @date_comparator = ] 'date_comparison'Date_createdとdate_modifiedの比較に使用する比較演算子。[ @date_comparator = ] 'date_comparison' The comparison operator to use in comparisons of date_created and date_modified. date_comparisonはchar (1) で、=、 <、または > にすることができます。date_comparison is char(1),and can be =, <, or >.

[ @date_created = ] date_createdジョブが作成された日付。[ @date_created = ] date_created The date the job was created. date_createdはdatetime,、既定値は NULL です。date_createdis datetime, with a default of NULL.

[ @date_last_modified = ] date_modifiedジョブが最後に変更された日付。[ @date_last_modified = ] date_modified The date the job was last modified. date_modifiedはdatetime,、既定値は NULL です。date_modified is datetime, with a default of NULL.

[ @description = ] 'description_pattern'ジョブの説明。[ @description = ] 'description_pattern' The description of the job. description_patternはnvarchar (512),、既定値は NULL です。description_pattern is nvarchar(512), with a default of NULL. description_patternには、パターンマッチングに SQL Server ワイルドカード文字を含めることができます。description_pattern can include the SQL Server wildcard characters for pattern matching.

リターン コードの値Return Code Values

0 (成功) または1 (失敗)0 (success) or 1 (failure)

結果セットResult Sets

引数を指定しない場合、 sp_help_jobはこの結果セットを返します。If no arguments are specified, sp_help_job returns this result set.

Job_idまたはjob_nameが指定されている場合、 sp_help_jobは、ジョブステップ、ジョブスケジュール、およびジョブ対象サーバーに対してこれらの追加の結果セットを返します。If job_id or job_name is specified, sp_help_job returns these additional result sets for job steps, job schedules, and job target servers.

次に、ジョブ ステップに関する結果セットを示します。This is the result set for job steps.

これは、ジョブスケジュールの結果セットです。This is the result set for job schedules.

次に、ジョブターゲット サーバーに関する結果セットを示します。This is the result set for job target servers.

アクセス許可Permissions

既定では、 sysadmin固定サーバーロールのメンバーは、このストアドプロシージャを実行できます。By default, members of the sysadmin fixed server role can execute this stored procedure. 他のユーザーには、 SQL ServerSQL Server msdb データベースの次のいずれかの エージェント固定データベース ロールが許可されている必要があります。Other users must be granted one of the following SQL ServerSQL Server Agent fixed database roles in the msdb database:

• SQLAgentUserRoleSQLAgentUserRole

• SQLAgentReaderRoleSQLAgentReaderRole

• SQLAgentOperatorRoleSQLAgentOperatorRole

これらのロールの権限の詳細については、「 SQL Server エージェントの固定データベース ロール」を参照してください。For details about the permissions of these roles, see SQL Server Agent Fixed Database Roles.

SQLAgentUserRoleのメンバーは、自分が所有しているジョブのみを表示できます。Members of SQLAgentUserRole can only view jobs that they own. Sysadmin、 SQLAgentReaderRole、およびSqlagentoperatorroleのメンバーは、すべてのローカルジョブとマルチサーバージョブを表示できます。Members of sysadmin, SQLAgentReaderRole, and SQLAgentOperatorRole can view all local and multiserver jobs.

例Examples

A.A. すべてのジョブの情報を一覧表示するList information for all jobs

次の例ではsp_help_job 、パラメーターを指定せずにプロシージャを実行し、 msdbデータベースで現在定義されているすべてのジョブの情報を返します。The following example executes the sp_help_job procedure with no parameters to return the information for all of the jobs currently defined in the msdb database.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_job ;  
GO  

B.B. 特定の条件に一致するジョブの情報を一覧表示するListing information for jobs matching a specific criteria

次の例では、françoisa が所有するマルチサーバー ジョブのジョブ情報を一覧表示します。ここでは、有効でかつ、実行中のジョブが対象になります。The following example lists job information for the multiserver jobs owned by françoisa where the job is enabled and executing.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_job   
   @job_type = N'MULTI-SERVER',  
   @owner_login_name = N'françoisa',  
   @enabled = 1,  
   @execution_status = 1 ;  
GO  

C.C. ジョブに関するすべての属性情報を一覧表示するListing all aspects of information for a job

次の例では、NightlyBackups ジョブに関するすべての属性情報を一覧表示します。The following example lists all aspects of the information for the job NightlyBackups.

USE msdb ;  
GO  
  
EXEC dbo.sp_help_job  
    @job_name = N'NightlyBackups',  
    @job_aspect = N'ALL' ;  
GO  

参照See Also

sp_add_job (Transact-sql) sp_add_job (Transact-SQL)
sp_delete_job (Transact-sql) sp_delete_job (Transact-SQL)
sp_update_job (Transact-sql) sp_update_job (Transact-SQL)
システムストアドプロシージャ (Transact-sql)System Stored Procedures (Transact-SQL)