The Job class represents a Microsoft SQL Server Agent job.
繼承階層
System.Object
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.NamedSmoObject
Microsoft.SqlServer.Management.Smo.Agent.AgentObjectBase
Microsoft.SqlServer.Management.Smo.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. |
![]() |
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. |
![]() |
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. |
![]() |
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 | Gets a collection of Property objects that represent the object properties. (繼承自 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 | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (繼承自 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. |
上層
方法
| 名稱 | 說明 | |
|---|---|---|
![]() |
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. |
![]() |
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. |
![]() |
Create | Creates a job on the instance of Microsoft SQL Server as defined by the Job object. |
![]() |
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 | Discovers a list of type Object. (繼承自 SqlSmoObject。) |
![]() |
Drop() | Removes an existing job. |
![]() |
Drop(Boolean) | Removes an existing job. |
![]() |
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. |
![]() |
EnumTargetServers | Enumerates a list of execution target servers that have been assigned to the referenced job. |
![]() |
Equals | (繼承自 Object。) |
![]() |
FormatSqlVariant | Formats an object as SqlVariant type. (繼承自 SqlSmoObject。) |
![]() |
GetContextDB | Gets the context database that is associated with this object. (繼承自 SqlSmoObject。) |
![]() |
GetDBName | Gets the database name that is associated with the object. (繼承自 AgentObjectBase。) |
![]() |
GetHashCode | (繼承自 Object。) |
![]() |
GetPropValue | Gets a property value of the SqlSmoObject object. (繼承自 SqlSmoObject。) |
![]() |
GetPropValueOptional | Gets a property value of the SqlSmoObject object. (繼承自 SqlSmoObject。) |
![]() |
GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. (繼承自 SqlSmoObject。) |
![]() |
GetServerObject | Gets the server of the SqlSmoObject object. (繼承自 SqlSmoObject。) |
![]() |
GetType | (繼承自 Object。) |
![]() |
Initialize() | Initializes the object and forces the properties be loaded. (繼承自 SqlSmoObject。) |
![]() |
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (繼承自 SqlSmoObject。) |
![]() |
Invoke | Runs the job. |
![]() |
IsObjectInitialized | Verifies whether the object has been initialized. (繼承自 SqlSmoObject。) |
![]() |
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (繼承自 SqlSmoObject。) |
![]() |
PurgeHistory | Removes system records maintaining execution history for the referenced job. |
![]() |
Refresh | Refreshes the object and retrieves properties when the object is next accessed. (繼承自 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. |
![]() |
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. |
![]() |
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (繼承自 SqlSmoObject。) |
![]() |
Start() | Runs the referenced job. |
![]() |
Start(String) | Runs the referenced job starting at the specified job step. |
![]() |
Stop | Stops executing the referenced job. |
![]() |
ToString | Returns a String that represents the referenced object. (繼承自 SqlSmoObject。) |
![]() |
Validate | Validates the state of an object. (繼承自 SmoObjectBase。) |
上層
事件
| 名稱 | 說明 | |
|---|---|---|
![]() |
PropertyChanged | Represents the event that occurs when a property is changed. (繼承自 SqlSmoObject。) |
![]() |
PropertyMetadataChanged | Represents the event that occurs when property metadata changes. (繼承自 SqlSmoObject。) |
上層
明確 繼承 實作
| 名稱 | 說明 | |
|---|---|---|
![]() ![]() |
IAlienObject.Discover | Discovers any dependencies. 不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
![]() ![]() |
IAlienObject.GetDomainRoot | Returns the root of the domain. (繼承自 SqlSmoObject。) |
![]() ![]() |
IAlienObject.GetParent | Gets the parent of this object. 不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
![]() ![]() |
IAlienObject.GetPropertyType | Gets the type of the specified property. (繼承自 SqlSmoObject。) |
![]() ![]() |
IAlienObject.GetPropertyValue | Gets the value of the specified property. (繼承自 SqlSmoObject。) |
![]() ![]() |
IAlienObject.GetUrn | Gets the Unified Resource Name (URN) of the object. 不要直接在程式碼中參照此成員。其支援 SQL Server 基礎結構。 (繼承自 SqlSmoObject。) |
![]() ![]() |
IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (繼承自 SqlSmoObject。) |
![]() ![]() |
IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. (繼承自 SqlSmoObject。) |
![]() ![]() |
IAlienObject.SetPropertyValue | Sets the property value. (繼承自 SqlSmoObject。) |
![]() ![]() |
ISfcPropertyProvider.GetPropertySet | Gets the interface reference to the set of properties of this object. (繼承自 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 為共用) 成員具備多執行緒作業安全。並非所有的執行個體成員都是安全執行緒。
範例
執行緒安全性
這個型別的任何公用 static (在 Visual Basic 中為 Shared) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。
請參閱
參考
Microsoft.SqlServer.Management.Smo.Agent 命名空間
.gif)
.gif)
.gif)
.gif)
.gif)
.gif)