通过

  • 项目

Job 类

The Job class represents a Microsoft SQL Server Agent job.

命名空间：  Microsoft.SqlServer.Management.Smo.Agent
程序集：  Microsoft.SqlServer.Smo（在 Microsoft.SqlServer.Smo.dll 中）

语法

声明
Public NotInheritable Class Job _
    Inherits AgentObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IRenamable,  _
    IScriptable
用法
Dim instance As Job

public sealed class Job : AgentObjectBase, IAlterable, 
    ICreatable, IDroppable, IRenamable, IScriptable

public ref class Job sealed : public AgentObjectBase, 
    IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

[<SealedAttribute>]
type Job =  
    class
        inherit AgentObjectBase
        interface IAlterable
        interface ICreatable
        interface IDroppable
        interface IRenamable
        interface IScriptable
    end

public final class Job extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable

Job 类型公开以下成员。

构造函数

  名称 说明
公共方法 Job() () () () Initializes a new instance of the Job class.
公共方法 Job(JobServer, String) Initializes a new instance of the Job class on the specified instance of Microsoft SQL Server Agent and with the specified name.
公共方法 Job(JobServer, String, Int32) Initializes a new instance of the Job class on the specified instance of SQL Server Agent and with the specified name and category

页首

属性

  名称 说明
公共属性 Category Gets or sets the category to which the job belongs.
公共属性 CategoryID Gets the ID value that uniquely identifies the job category.
公共属性 CategoryType Gets or sets the type of category, with respect to local or multiserver jobs.
公共属性 CurrentRunRetryAttempt Gets the number of times Microsoft SQL Server Agent has attempted to run the job unsuccessfully.
公共属性 CurrentRunStatus Gets the current execution status of the job.
公共属性 CurrentRunStep Gets information about the job step that is currently running.
公共属性 DateCreated Gets the date and time when the job was created.
公共属性 DateLastModified Gets the date and time when the job was last modified.
公共属性 DeleteLevel Gets or sets the completion action that determines whether to delete the job definition when the job finishes execution.
公共属性 Description Gets or sets the textual description of the job.
公共属性 EmailLevel Gets or sets the completion action that determines whether to send an e-mail notification to an operator when the job finishes execution.
公共属性 EventLogLevel Gets or sets the completion action that determines whether to generate an operating system event log entry when the job finishes execution.
受保护属性 ExecuteForScalar 获取或设置 Boolean 属性值，该值指定对象是否设置为针对标量选项执行。 （从 SqlSmoObject 继承。）
公共属性 HasSchedule Gets the Boolean property value that specifies whether the job has at least one schedule.
公共属性 HasServer Gets the Boolean property value that specifies whether the job has a target server assigned for multiple-server operations.
公共属性 HasStep Gets the Boolean property value that specifies whether the job has at least one job step.
公共属性 IsEnabled Gets or sets the Boolean property value that specifies whether the job is enabled.
受保护属性 IsTouched 获取 Boolean 属性值，该值指定在服务器上对象属性是否已更新但尚未持久化。 （从 SqlSmoObject 继承。）
公共属性 JobID Gets the job ID value.
公共属性 JobSchedules Gets a collection of JobSchedule objects that represent the schedules assigned to the job.
公共属性 JobSteps Gets a collection of JobStep objects that represent the job steps defined for the job.
公共属性 JobType Gets the job type, which specifies whether the job is local or multiserver.
公共属性 LastRunDate Gets the date and time when the job was last run.
公共属性 LastRunOutcome Gets the result of the job from the last time it completed execution.
公共属性 Name Gets or sets the name of the Job. （覆盖 NamedSmoObject. . :: . .Name。）
公共属性 NetSendLevel Gets or sets the completion action that determines whether to net-send a notification to an operator when the job finishes execution.
公共属性 NextRunDate Gets the date and time when the job is next scheduled to run.
公共属性 NextRunScheduleID Gets the ID value of the schedule that is responsible for the next execution of the job.
受保护属性 ObjectInSpace 获取 Boolean 属性值，该值指定对象是否单独存在，或者对象是否直接或间接连接到 SQL Server 的实例。 （从 SqlSmoObject 继承。）
公共属性 OperatorToEmail Gets or sets the operator that receives notification by e-mail when the job finishes execution.
公共属性 OperatorToNetSend Gets or sets the operator that receives a net-send notification when the job finishes execution.
公共属性 OperatorToPage Gets or sets the operator that receives a pager notification when the job finishes execution.
公共属性 OriginatingServer Gets the name of the server that is acting as the master server in a multiserver job.
公共属性 OwnerLoginName Gets or sets the owner of the job.
公共属性 PageLevel Gets or sets the completion action that determines whether to send a pager notification to an operator when the job finishes execution.
公共属性 Parent Gets or sets the JobServer object that is the parent of the Job object.
公共属性 Properties 获取表示对象属性的 Property 对象的集合。 （从 SqlSmoObject 继承。）
受保护属性 ScalarResult 获取所引用对象的标量结果。 （从 SqlSmoObject 继承。）
公共属性 StartStepID Gets or sets the ID value of the first job step in the sequence to be executed.
公共属性 State Gets the state of the referenced object. （从 SmoObjectBase 继承。）
公共属性 Urn 获取唯一标识对象的统一资源名称 (URN) 地址值。 （从 SqlSmoObject 继承。）
公共属性 UserData Gets or sets user-defined data associated with the referenced object. （从 SmoObjectBase 继承。）
公共属性 VersionNumber Gets a system-maintained value that is incremented every time the job is modified.

页首

方法

  名称 说明
受保护方法 AddDatabaseContext(StringCollection) 将数据库上下文添加到 queries 参数标识的查询集合。 （从 SqlSmoObject 继承。）
受保护方法 AddDatabaseContext(StringCollection, ScriptingOptions) 将数据库上下文添加到 queries 参数标识的查询集合，并且使用指定的脚本选项。 （从 SqlSmoObject 继承。）
公共方法 AddSharedSchedule Adds a shared schedule to the Microsoft SQL Server Agent job.
公共方法 Alter Updates any Job object property changes on an instance of Microsoft SQL Server. 
受保护方法 AlterImpl 激活对象已更改事件。 （从 SqlSmoObject 继承。）
受保护方法 AlterImplFinish 在对象已更改事件完成时调用的方法。 （从 SqlSmoObject 继承。）
受保护方法 AlterImplInit 在对象已更改事件初始化时调用的方法。 （从 SqlSmoObject 继承。）
受保护方法 AlterImplWorker 调用 Alter 方法。 （从 SqlSmoObject 继承。）
公共方法 ApplyToTargetServer Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
公共方法 ApplyToTargetServerGroup Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job.
受保护方法 BindDefaultImpl 绑定由参数标识的默认项。 （从 SqlSmoObject 继承。）
受保护方法 BindRuleImpl 将规则架构绑定到由参数标识的规则和列。 （从 SqlSmoObject 继承。）
受保护方法 CheckCollation 按 collationName 参数标识的排序规则方法检查脚本选项的顺序。 （从 SqlSmoObject 继承。）
受保护方法 CheckObjectState() () () () 验证所引用对象的状态。 （从 SqlSmoObject 继承。）
受保护方法 CheckObjectState(Boolean) 使用用来指定在尚未创建对象时引发异常的选项，验证所引用对象的状态。 （从 SqlSmoObject 继承。）
受保护方法 CheckObjectStateImpl 检查 SqlSmoObject 的状态。 （从 SqlSmoObject 继承。）
受保护方法 CheckVersion100 检查 SQL Server 的版本是否为 SQL Server 2008。 （从 SqlSmoObject 继承。）
受保护方法 CheckVersion80 检查 SQL Server 2000 上对象的有效性。 （从 SqlSmoObject 继承。）
受保护方法 CheckVersion80SP3 检查 SQL Server 2000 SP3 上对象的有效性。 （从 SqlSmoObject 继承。）
受保护方法 CheckVersion90 检查 SQL Server 2005 上对象的有效性。 （从 SqlSmoObject 继承。）
受保护方法 CheckVersionBelow90 检查 SQL Server 的版本是否在 SQL Server 2005 之前。 （从 SqlSmoObject 继承。）
受保护方法 CleanObject 将对象设置为未修改的状态。 （从 SqlSmoObject 继承。）
公共方法 Create Creates a job on the instance of Microsoft SQL Server as defined by the Job object.
受保护方法 CreateImpl 使用脚本选项创建对象。 （从 SqlSmoObject 继承。）
受保护方法 CreateImplFinish 在创建事件完成时调用的方法。 （从 SqlSmoObject 继承。）
受保护方法 CreateImplInit 在创建事件初始化时调用的方法。 （从 SqlSmoObject 继承。）
公共方法 DeleteJobStepLogs(DateTime) Deletes job step log files that are older than the specified date.
公共方法 DeleteJobStepLogs(Int32) Deletes job step log files that are larger that the specified log ID number.
公共方法 Discover 发现 Object 类型的列表。 （从 SqlSmoObject 继承。）
公共方法 Drop() () () () Removes an existing job.
公共方法 Drop(Boolean) Removes an existing job.
受保护方法 DropImpl 删除 SqlSmoObject。 （从 SqlSmoObject 继承。）
受保护方法 DropImplWorker 调用 drop 方法。 （从 SqlSmoObject 继承。）
公共方法 EnumAlerts Enumerates a list of Agent alerts that cause automated execution of the referenced job.
公共方法 EnumHistory() () () () Enumerates a list of execution history associated with the referenced job.
公共方法 EnumHistory(JobHistoryFilter) Enumerates a list of execution history associated with the referenced job.
公共方法 EnumJobStepLogs() () () () Enumerates a list of job step log files for the referenced job.
公共方法 EnumJobStepLogs(Int32) Enumerates a list of job step log files for the job step with the specified ID value.
公共方法 EnumJobStepLogs(String) Enumerates a list of job step log files for the job step with the specified name.
公共方法 EnumJobStepsByID Returns an array of JobStep objects that belong to the referenced job and that are ordered by ID value.
受保护方法 EnumScriptImpl 枚举 so 参数指定的脚本。 （从 SqlSmoObject 继承。）
受保护方法 EnumScriptImplWorker 调用枚举 so 参数指定的脚本的方法。 （从 SqlSmoObject 继承。）
受保护方法 EnumScriptImplWorkerSOChanged 返回描述对象的脚本选项的 IEnumerable 字符串。 （从 SqlSmoObject 继承。）
公共方法 EnumTargetServers Enumerates a list of execution target servers that have been assigned to the referenced job.
公共方法 Equals （从 Object 继承。）
受保护方法 ExecuteNonQuery （从 SqlSmoObject 继承。）
受保护方法 Finalize （从 Object 继承。）
受保护方法 FormatSqlVariant 将对象格式化为 SqlVariant 类型。 （从 SqlSmoObject 继承。）
受保护方法 GenerateDataSpaceFileStreamScript 生成用于创建数据文件的脚本。 （从 SqlSmoObject 继承。）
受保护方法 GenerateDataSpaceScript 生成用于分配数据文件中的空间的脚本。 （从 SqlSmoObject 继承。）
受保护方法 GetBindDefaultScript 获取绑定 defSchema 和 defName 参数指定的默认值的脚本。 （从 SqlSmoObject 继承。）
受保护方法 GetBindRuleScript 获取指定绑定规则的脚本。 （从 SqlSmoObject 继承。）
受保护方法 GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) 对 SqlSmoObject 的布尔参数赋值。 （从 SqlSmoObject 继承。）
受保护方法 GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) 对 SqlSmoObject 的布尔属性赋值。 （从 SqlSmoObject 继承。）
受保护方法 GetDateTimeParameter 对 SqlSmoObject 的日期时间属性赋值。 （从 SqlSmoObject 继承。）
受保护方法 GetDateTimeParameterAsInt 为 SqlSmoObject 的日期时间属性赋一个整数值（如果该日期时间属性不为 Null）。 （从 SqlSmoObject 继承。）
受保护方法 GetDBName 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 Gets the database name that is associated with the object. （从 AgentObjectBase 继承。）
受保护方法 GetEnumParameter 对 SqlSmoObject 的枚举属性赋值。 （从 SqlSmoObject 继承。）
受保护方法 GetFragOptionString 获取作为字符串值的 FragmentationOption 对象。 （从 SqlSmoObject 继承。）
受保护方法 GetGuidParameter 对 SqlSmoObject 的 Guid 属性赋值。 （从 SqlSmoObject 继承。）
公共方法 GetHashCode （从 Object 继承。）
受保护方法 GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) 对 SqlSmoObject 的参数赋值。 （从 SqlSmoObject 继承。）
受保护方法 GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) 对 SqlSmoObject 的参数赋值。 （从 SqlSmoObject 继承。）
受保护方法 GetPropValue 获取 SqlSmoObject 对象的属性值。 （从 SqlSmoObject 继承。）
受保护方法 GetPropValueOptional 获取 SqlSmoObject 对象的属性值。 （从 SqlSmoObject 继承。）
受保护方法 GetPropValueOptionalAllowNull 获取 SqlSmoObject 对象的属性值。 （从 SqlSmoObject 继承。）
受保护方法 GetRealValue 获取 SqlSmoObject 对象的属性值。 （从 SqlSmoObject 继承。）
受保护方法 GetScriptingOptionsForCreate 获取 SqlSmoObject 对象的 ScriptingOptions。 （从 SqlSmoObject 继承。）
受保护方法 GetServerName 获取对象与之关联的 SQL Server 实例的名称。 （从 SqlSmoObject 继承。）
受保护方法 GetServerObject 获取 SqlSmoObject 对象的服务器。 （从 SqlSmoObject 继承。）
受保护方法 GetSqlServerVersionName 获取对象与之关联的 SQL Server 实例的版本名称。 （从 SqlSmoObject 继承。）
受保护方法 GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) 对 SqlSmoObject 对象的字符串参数赋值。 （从 SqlSmoObject 继承。）
受保护方法 GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) 对 SqlSmoObject 对象的字符串参数赋值。 （从 SqlSmoObject 继承。）
受保护方法 GetTimeSpanParameterAsInt 对 SqlSmoObject 对象的时间范围参数赋值。 （从 SqlSmoObject 继承。）
公共方法 GetType （从 Object 继承。）
受保护方法 GetUrnRecursive(StringBuilder) 对 SqlSmoObject 对象的 Urn 对象赋值。 （从 SqlSmoObject 继承。）
受保护方法 GetUrnRecursive(StringBuilder, UrnIdOption) 对 SqlSmoObject 对象的 Urn 对象赋值。 （从 SqlSmoObject 继承。）
受保护方法 ImplInitialize 初始化 SqlSmoObject 对象的字段。 （从 SqlSmoObject 继承。）
公共方法 Initialize() () () () 初始化对象并强制加载属性。 （从 SqlSmoObject 继承。）
公共方法 Initialize(Boolean) 初始化对象并强制加载属性。 （从 SqlSmoObject 继承。）
公共方法 Invoke Runs the job.
受保护方法 IsObjectDirty 验证在 SQL Server 的实例上对象属性是否已修改并且更改是否尚未持久化。 （从 SqlSmoObject 继承。）
受保护方法 IsObjectInitialized 验证对象是否已初始化。 （从 SqlSmoObject 继承。）
受保护方法 IsObjectInSpace 验证对象是单独存在还是连接到 SQL Server 的实例。 （从 SqlSmoObject 继承。）
受保护方法 IsVersion80SP3 确定 SQL Server 的版本是否为 SQL Server 2000 SP3。 （从 SqlSmoObject 继承。）
受保护方法 IsVersion90AndAbove 确定 SQL Server 的版本是否为 SQL Server 2005 或更高版本。 （从 SqlSmoObject 继承。）
受保护方法 MarkDropped 将 SqlSmoState 设置为删除。 （从 SqlSmoObject 继承。）
受保护方法 MarkForDropImpl 将 SqlSmoState 设置为删除。 （从 SqlSmoObject 继承。）
受保护方法 MemberwiseClone （从 Object 继承。）
受保护方法 PostAlter 在更改 SqlSmoObject 后激活的方法。 （从 SqlSmoObject 继承。）
受保护方法 PostCreate 在创建 SqlSmoObject 后激活的方法。 （从 SqlSmoObject 继承。）
受保护方法 PostDrop 在删除 SqlSmoObject 后激活的方法。 （从 SqlSmoObject 继承。）
公共方法 PurgeHistory Removes system records maintaining execution history for the referenced job.
公共方法 Refresh 刷新对象并在下一次访问该对象时检索属性。 （从 SqlSmoObject 继承。）
公共方法 RemoveAllJobSchedules() () () () Removes all shared and unshared schedules from the job.
公共方法 RemoveAllJobSchedules(Boolean) Removes all unused schedules from the job.
公共方法 RemoveAllJobSteps Removes all the job steps associated with the job.
公共方法 RemoveFromTargetServer Removes an execution target server from the list of target servers maintained for a job.
公共方法 RemoveFromTargetServerGroup Removes a group of execution target servers from the list of target servers maintained for a job.
公共方法 RemoveSharedSchedule(Int32) Removes the specified shared schedule from the job.
公共方法 RemoveSharedSchedule(Int32, Boolean) Removes the specified shared schedule from the job and keeps unused schedules.
公共方法 Rename Renames the job.
受保护方法 RenameImpl 标识为仅供参考。不提供支持。不保证以后的兼容性。 （从 NamedSmoObject 继承。）
受保护方法 RenameImplWorker 标识为仅供参考。不提供支持。不保证以后的兼容性。 （从 NamedSmoObject 继承。）
公共方法 Script() () () () Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job.
公共方法 Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job as specified by the scripting options.
受保护方法 ScriptAlter 根据参数更改 SqlSmoObject。 （从 SqlSmoObject 继承。）
受保护方法 ScriptChangeOwner This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
受保护方法 ScriptCreate 根据参数更改 SqlSmoObject。 （从 SqlSmoObject 继承。）
受保护方法 ScriptDdl 引发 InvalidSmoOperationException。 （从 SqlSmoObject 继承。）
受保护方法 ScriptDrop 引发 InvalidSmoOperationException。 （从 SqlSmoObject 继承。）
受保护方法 ScriptImpl() () () () 获取 SqlSmoObject 脚本的集合。 （从 SqlSmoObject 继承。）
受保护方法 ScriptImpl(ScriptingOptions) 获取 SqlSmoObject 脚本的集合。 （从 SqlSmoObject 继承。）
受保护方法 ScriptImplWorker 获取 SqlSmoObject 脚本的集合。 （从 SqlSmoObject 继承。）
受保护方法 ScriptOwner Alters the script owner authorization. （从 NamedSmoObject 继承。）
受保护方法 ScriptRename This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
受保护方法 SetParentImpl 将 SqlSmoObject 的父级设置为 newParent 参数。 （从 SqlSmoObject 继承。）
受保护方法 SetSchemaOwned Sets the schema owned value. （从 NamedSmoObject 继承。）
公共方法 Start() () () () Runs the referenced job.
公共方法 Start(String) Runs the referenced job starting at the specified job step.
公共方法 Stop Stops executing the referenced job.
公共方法 ToString 返回表示所引用对象的 String。 （从 SqlSmoObject 继承。）
受保护方法 TouchImpl 未实现。 （从 SqlSmoObject 继承。）
受保护方法 UnbindDefaultImpl 取消绑定 SqlSmoObject 的默认列。 （从 SqlSmoObject 继承。）
受保护方法 UnbindRuleImpl 取消绑定 SqlSmoObject 的规则。 （从 SqlSmoObject 继承。）
公共方法 Validate Validates the state of an object. （从 SmoObjectBase 继承。）

页首

事件

  名称 说明
公共事件 PropertyChanged 表示更改属性时发生的事件。 （从 SqlSmoObject 继承。）
公共事件 PropertyMetadataChanged 表示属性元数据更改时发生的事件。 （从 SqlSmoObject 继承。）

页首

字段

  名称 说明
受保护字段 m_ExtendedProperties 表示一个属性，可以对该属性进行定义以便扩展 SqlSmoObject 提供的属性。 （从 SqlSmoObject 继承。）
受保护字段 singletonParent 表示单一父级。 （从 SqlSmoObject 继承。）

页首

显式接口实现

  名称 说明
显式接口实现私有方法 IAlienObject. . :: . .Discover 发现任何依赖关系。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。）
显式接口实现私有方法 IAlienObject. . :: . .GetDomainRoot 返回域的根。 （从 SqlSmoObject 继承。）
显式接口实现私有方法 IAlienObject. . :: . .GetParent 获取此对象的父对象。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。）
显式接口实现私有方法 IAlienObject. . :: . .GetPropertyType 获取指定属性的类型。 （从 SqlSmoObject 继承。）
显式接口实现私有方法 IAlienObject. . :: . .GetPropertyValue 获取指定属性的值。 （从 SqlSmoObject 继承。）
显式接口实现私有方法 IAlienObject. . :: . .GetUrn 获取对象的统一资源名称。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。）
显式接口实现私有方法 IAlienObject. . :: . .Resolve 获取一个实例，该实例包含与来自该对象的统一资源名称的对象有关的信息。 （从 SqlSmoObject 继承。）
显式接口实现私有方法 IAlienObject. . :: . .SetObjectState 将对象状态设置为指定的 SfcObjectState 值。 （从 SqlSmoObject 继承。）
显式接口实现私有方法 IAlienObject. . :: . .SetPropertyValue 设置属性值。 （从 SqlSmoObject 继承。）
显式接口实现私有方法 ISfcPropertyProvider. . :: . .GetPropertySet 获取对此对象的属性集的接口引用。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。）

页首

注释

To get or set Job object properties, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be the owner of the job, or be a member of the sysadmin fixed server role.

To create a job, users must be a member of the SQLAgentUserRole, SQLAgentReaderRole, and SQLAgentOperatorRole database roles on the MSDB database, or be a member of the sysadmin fixed server role.

To drop a job, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be the owner of the job, or be a member of the sysadmin fixed server role.

Thread Safety

此类型的任何公共静态（Microsoft Visual Basic 中的 Shared）成员在多线程操作中是安全的。不保证所有实例成员都是线程安全的。

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。