Класс JobServer

Статья
04/26/2013

The JobServer object represents the SQL Server Agent subsystem and the msdb database.

Иерархия наследования

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.Agent.JobServer

Пространство имен: Microsoft.SqlServer.Management.Smo.Agent
Сборка: Microsoft.SqlServer.Smo (в Microsoft.SqlServer.Smo.dll)

Синтаксис

'Декларация
Public NotInheritable Class JobServer _
    Inherits SqlSmoObject _
    Implements IAlterable, IScriptable
'Применение
Dim instance As JobServer

public sealed class JobServer : SqlSmoObject, 
    IAlterable, IScriptable

public ref class JobServer sealed : public SqlSmoObject, 
    IAlterable, IScriptable

[<SealedAttribute>]
type JobServer =  
    class 
        inherit SqlSmoObject 
        interface IAlterable 
        interface IScriptable 
    end

public final class JobServer extends SqlSmoObject implements IAlterable, IScriptable

Тип JobServer обеспечивает доступ к следующим элементам.

Свойства

	Имя	Описание
	AgentDomainGroup	Gets the SQL Server Agent domain group.
	AgentLogLevel	Gets or sets the type of messages that are logged by SQL Server Agent.
	AgentMailType	Gets or sets the mail type for SQL Server Agent.
	AgentShutdownWaitTime	Gets or sets the time that SQL Server Agent waits for jobs to complete execution before shutting down.
	AlertCategories	Represents a collection of AlertCategory objects. Each AlertCategory object represents an alert category defined on SQL Server Agent.
	Alerts	Represents a collection of Alert objects. Each Alert object represents an alert defined on SQL Server Agent.
	AlertSystem	The AlertSystem object stores information that applies to all the alerts defined on SQL Server Agent.
	DatabaseMailProfile	Gets or sets a Database Mail profile.
	ErrorLogFile	Gets or sets the name and path of the file in which SQL Server Agent records errors.
	HostLoginName	Gets or sets the login used to log in to SQL Server.
	IdleCpuDuration	Gets or sets the length of time in seconds that the processor must have to maintain the CPU idle percentage value before the processor is considered idle.
	IdleCpuPercentage	Gets or sets the CPU idle percentage threshold that the processor is required to achieve before it is considered idle.
	IsCpuPollingEnabled	Gets or sets the Boolean property value that specifies whether CPU polling is enabled.
	JobCategories	Represents a collection of JobCategory objects. Each JobCategory object represents a job category defined on Microsoft SQL Server Agent.
	Jobs	Represents a collection of Job objects. Each Job object represents a job defined on SQL Server Agent.
	JobServerType	Gets or sets the type of job server with regard to multiserver administration.
	LocalHostAlias	Gets or sets the local host alias that is used to connect to the local instance of SQL Server.
	LoginTimeout	Gets or sets the number of seconds after which an attempt to connect times out.
	MaximumHistoryRows	Gets or sets the maximum number of history rows retained.
	MaximumJobHistoryRows	Gets or sets the maximum number of history rows retained per job.
	MsxAccountCredentialName	Gets or sets the Windows account required to connect to the master server using Windows Authentication.
	MsxAccountName	Gets or sets the login required to connect to the master server using SQL Server Authentication.
	MsxServerName	Gets or sets the name of the master server participating in multiserver administration.
	Name	Gets the name of the SQL Server Agent service.
	NetSendRecipient	Gets or sets the recipient of net send messages.
	OperatorCategories	Represents a collection of OperatorCategory objects. Each OperatorCategory object represents an operator category defined on SQL Server Agent.
	Operators	Represents a collection of Operator objects. Each Operator object represents an operator defined on SQL Server Agent.
	Parent	Gets the Server object that is the parent of the JobServer object.
	Properties	Gets a collection of Property objects that represent the object properties. (Производный от SqlSmoObject.)
	ProxyAccounts	Represents a collection of ProxyAccount objects. Each ProxyAccount object represents a proxy account defined on Microsoft SQL Server Agent.
	ReplaceAlertTokensEnabled	Gets or sets the Boolean value that determines whether alert tokens are replaced on the instance of SQL Server Agent.
	SaveInSentFolder	Gets or sets the Boolean property value that specifies whether the notifications are saved.
	ServiceAccount	Gets the account under which the SQL Server Agent service runs
	ServiceStartMode	Gets the mode used to start the SQL Server Agent service.
	SharedSchedules	Represents a collection of JobSchedule objects. Each JobSchedule object represents a shared schedule defined on SQL Server Agent.
	SqlAgentAutoStart	Gets or sets the Boolean property value that specifies whether SQL Server Agent is automatically started.
	SqlAgentMailProfile	Gets or sets a SQL Server Agent mail profile.
	SqlAgentRestart	Gets or sets the Boolean property value that specifies whether SQL Server Agent is monitored and restarted if it stops.
	SqlServerRestart	Gets or sets the Boolean property value that specifies whether the SQL Server Service is monitored and restarted if it stops.
	State	Gets the state of the referenced object. (Производный от SmoObjectBase.)
	SysAdminOnly	Gets the Boolean property value that specifies whether CmdExec and ActiveX commands can only be executed by members of the sysadmin fixed server role.
	TargetServerGroups	Represents a collection of TargetServerGroup objects. Each TargetServerGroup object represents a target server group defined on SQL Server Agent.
	TargetServers	Represents a collection of TargetServer objects. Each TargetServer object represents a target server defined on SQL Server Agent.
	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.)
	WriteOemErrorLog	Gets or sets the Boolean property value that specifies whether to write the error log to a non-Unicode file or not.

В начало

Методы

	Имя	Описание
	Alter	Updates any JobServer object property changes on an instance of SQL Server.
	ClearHostLoginAccount	Clears the host login account and uses integrated security to log in to SQL Server.
	ClearMsxAccount	Clears the master server login account and uses integrated security to log in to the master server.
	CycleErrorLog	Closes and renames the current error log, and then creates a new empty error log file.
	Discover	Discovers a list of type Object. (Производный от SqlSmoObject.)
	DropJobByID	Removes the job with the specified ID value.
	DropJobsByLogin	Removes the job with the specified login name.
	DropJobsByServer	Removes the job with the specified server.
	EnumErrorLogs	Enumerates a list of SQL Server Agent error log information.
	EnumJobHistory()	Enumerates a list of SQL Server Agent job history information.
	EnumJobHistory(JobHistoryFilter)	Enumerates a list of job history information.
	EnumJobs()	Enumerates a list of information about the current job.
	EnumJobs(JobFilter)	Enumerates a list of information about current jobs.
	EnumPerformanceCounters()	Enumerates a list of SQL Server Agent performance counter information.
	EnumPerformanceCounters(String)	Enumerates a list of SQL Server Agent performance counter information for the specified object.
	EnumPerformanceCounters(String, String)	Enumerates a list of SQL Server Agent performance counter information for the specified object and specified counter.
	EnumPerformanceCounters(String, String, String)	Enumerates a list of SQL Server Agent performance counter information for the specified object, specified counter, and specified instance of SQL Server.
	EnumSubSystems	Enumerates a list of SQL Server Agent execution subsystems.
	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. (Производный от SqlSmoObject.)
	GetHashCode	(Производный от Object.)
	GetJobByID	Returns a job with the specified ID value.
	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.)
	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.)
	MsxDefect()	Ends Microsoft SQL Server Agent participation in a multiserver administration group.
	MsxDefect(Boolean)	Ends SQL Server Agent participation in a multiserver administration group with the option to force defection.
	MsxEnlist	Enlists SQL Server Agent as a target server with the specified master server in a multiserver administration.
	PurgeJobHistory()	Removes all logged records of SQL Server Agent jobs.
	PurgeJobHistory(JobHistoryFilter)	Removes all logged records of SQL Server Agent jobs as specified by a filter.
	ReadErrorLog()	Enumerates the error log.
	ReadErrorLog(Int32)	Enumerates the error log.
	ReassignJobsByLogin	Changes ownership for any SQL Server Agent job currently owned by a SQL Server login.
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Производный от SqlSmoObject.)
	RemoveJobByID	Removes a job with a specified ID value.
	RemoveJobsByLogin	Removes a job with a specified login.
	Script()	Generates a Transact-SQL script that can be used to re-create SQL Server Agent.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create SQL Server Agent as specified by the scripting options.
	SetHostLoginAccount	Sets the SQL Server authentication account and password used to log in to SQL Server.
	SetMsxAccount(String)	Sets the name of the credentials used to log in to the master server in multiserver administration.
	SetMsxAccount(String, String)	Sets the name of the credentials used to log in to the master server in multiserver administration.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Производный от SqlSmoObject.)
	StartMonitor	Starts monitoring the local SQL Server Agent Service by an instance of SQL Server.
	StopMonitor	Ends monitoring the local SQL Server Agent Service by an instance of SQL Server.
	TestMailProfile	Tests the validity of an e-mail profile.
	TestNetSend	Tests the validity of a net send address.
	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.)

В начало

Замечания

When you use the SQL Server Agent objects, you can reference them by using the JobServer object property of the Server object. It is not necessary to call the constructor for the JobServer object because it is automatically created when the constructor is called for the Server object.

Примечание
If the CompatibilityLevel property for the MSDB database is set to Version70 SMO might throw an exception with a COLLATE error.

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

To set JobServer object properties, users must be a member of the sysadmin fixed server role.

To run methods on the JobServer object, users must be a member of the sysadmin fixed server role.

Thread Safety

Все общие статические члены этого типа (Shared в Microsoft Visual Basic) можно использовать в многопоточных операциях. Потокобезопасная работа с членами экземпляров типа не гарантируется.