Classe Job
The Job class represents a Microsoft SQL Server Agent job.
Hiérarchie d'héritage
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
Espace de noms : Microsoft.SqlServer.Management.Smo.Agent
Assembly : Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)
Syntaxe
'Déclaration
Public NotInheritable Class Job _
Inherits AgentObjectBase _
Implements IAlterable, ICreatable, IDroppable, IRenamable, _
IScriptable
'Utilisation
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
Le type Job expose les membres suivants.
Constructeurs
Nom | Description | |
---|---|---|
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 |
Haut de la page
Propriétés
Nom | Description | |
---|---|---|
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 | Obtient ou définit la valeur de la propriété Boolean qui spécifie si l'objet est défini selon l'option permettant l'exécution qui retourne une valeur scalaire. (hérité de 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 | Obtient la valeur de la propriété Boolean qui spécifie si les propriétés de l'objet ont été mises à jour mais n'ont pas encore été rendues persistantes sur le serveur. (hérité de 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. (remplace 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 | Obtient la valeur de la propriété Boolean qui spécifie si l'objet existe dans l'isolation, ou s'il est connecté directement ou indirectement à l'instance de SQL Server. (hérité de 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 | Obtient une collection d'objets Property qui représentent les propriétés de l'objet. (hérité de SqlSmoObject.) | |
ScalarResult | Obtient le résultat scalaire pour l'objet référencé. (hérité de 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. (hérité de SmoObjectBase.) | |
Urn | Obtient la valeur URN (Uniform Resource Name) qui identifie de façon unique l'objet. (hérité de SqlSmoObject.) | |
UserData | Gets or sets user-defined data associated with the referenced object. (hérité de SmoObjectBase.) | |
VersionNumber | Gets a system-maintained value that is incremented every time the job is modified. |
Haut de la page
Méthodes
Nom | Description | |
---|---|---|
AddDatabaseContext(StringCollection) | Ajoute le contexte de base de données à la collection de requêtes identifiée par le paramètre queries. (hérité de SqlSmoObject.) | |
AddDatabaseContext(StringCollection, ScriptingOptions) | Ajoute le contexte de base de données à la collection de requêtes identifiée par le paramètre queries, à l'aide des options de script spécifiées. (hérité de 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 | Active l'événement d'objet modifié. (hérité de SqlSmoObject.) | |
AlterImplFinish | Méthode appelée lorsque l'événement d'objet modifié est terminé. (hérité de SqlSmoObject.) | |
AlterImplInit | Méthode appelée lorsque l'événement d'objet modifié est initialisé. (hérité de SqlSmoObject.) | |
AlterImplWorker | Appelle les méthodes de modification. (hérité de 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 | Lie les éléments par défaut identifiés par les paramètres. (hérité de SqlSmoObject.) | |
BindRuleImpl | Lie le schéma de règle à la règle et aux colonnes identifiées par les paramètres. (hérité de SqlSmoObject.) | |
CheckCollation | Vérifie l'ordre des options de script par la méthode de classement identifiée par le paramètre collationName. (hérité de SqlSmoObject.) | |
CheckObjectState() () () () | Valide l'état de l'objet référencé. (hérité de SqlSmoObject.) | |
CheckObjectState(Boolean) | Valide l'état de l'objet référencé avec l'option permettant de spécifier qu'une exception est levée si l'objet n'est pas encore créé. (hérité de SqlSmoObject.) | |
CheckObjectStateImpl | Vérifie l'état de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
CheckVersion100 | Vérifie si la version de SQL Server est SQL Server 2008. (hérité de SqlSmoObject.) | |
CheckVersion80 | Vérifie la validité de l'objet sur SQL Server 2000. (hérité de SqlSmoObject.) | |
CheckVersion80SP3 | Vérifie la validité de l'objet sur SQL Server 2000 SP3. (hérité de SqlSmoObject.) | |
CheckVersion90 | Vérifie la validité de l'objet sur SQL Server 2005. (hérité de SqlSmoObject.) | |
CheckVersionBelow90 | Vérifie si la version de SQL Server est antérieure à SQL Server 2005. (hérité de SqlSmoObject.) | |
CleanObject | Définit l'objet sur l'état non modifié. (hérité de SqlSmoObject.) | |
Create | Creates a job on the instance of Microsoft SQL Server as defined by the Job object. | |
CreateImpl | Crée un objet avec les options de script. (hérité de SqlSmoObject.) | |
CreateImplFinish | Méthode appelée lorsque l'événement de création est terminé. (hérité de SqlSmoObject.) | |
CreateImplInit | Méthode appelée lorsque l'événement de création est initialisé. (hérité de 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 | Découvre une liste de type Object. (hérité de SqlSmoObject.) | |
Drop() () () () | Removes an existing job. | |
Drop(Boolean) | Removes an existing job. | |
DropImpl | Supprime un SqlSmoObject. (hérité de SqlSmoObject.) | |
DropImplWorker | Appelle les méthodes de suppression. (hérité de 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 | Énumère des scripts spécifiés par le paramètre so. (hérité de SqlSmoObject.) | |
EnumScriptImplWorker | Appelle les méthodes qui énumèrent des scripts spécifiés par le paramètre so. (hérité de SqlSmoObject.) | |
EnumScriptImplWorkerSOChanged | Retourne une chaîne IEnumerable qui décrit les options de script pour un objet. (hérité de SqlSmoObject.) | |
EnumTargetServers | Enumerates a list of execution target servers that have been assigned to the referenced job. | |
Equals | (hérité de Object.) | |
ExecuteNonQuery | (hérité de SqlSmoObject.) | |
Finalize | (hérité de Object.) | |
FormatSqlVariant | Met en forme un objet en tant que type SqlVariant. (hérité de SqlSmoObject.) | |
GenerateDataSpaceFileStreamScript | Génère un script pour créer un fichier de données. (hérité de SqlSmoObject.) | |
GenerateDataSpaceScript | Génère un script pour allouer l'espace dans le fichier de données. (hérité de SqlSmoObject.) | |
GetBindDefaultScript | Obtient le script qui lie les valeurs par défaut spécifiées par les paramètres defName et defSchema. (hérité de SqlSmoObject.) | |
GetBindRuleScript | Obtient le script qui spécifie les règles de liaison. (hérité de SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Affecte un paramètre booléen du SqlSmoObject. (hérité de SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Affecte une propriété booléenne du SqlSmoObject. (hérité de SqlSmoObject.) | |
GetDateTimeParameter | Affecte une propriété datetime du SqlSmoObject. (hérité de SqlSmoObject.) | |
GetDateTimeParameterAsInt | Affecte la propriété datetime du SqlSmoObject comme une valeur entière, si la propriété datetime n'est pas Null. (hérité de SqlSmoObject.) | |
GetDBName | Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. Gets the database name that is associated with the object. (hérité de AgentObjectBase.) | |
GetEnumParameter | Affecte une propriété d'énumération du SqlSmoObject. (hérité de SqlSmoObject.) | |
GetFragOptionString | Obtient un objet FragmentationOption en tant que valeur de chaîne. (hérité de SqlSmoObject.) | |
GetGuidParameter | Affecte une propriété Guid du SqlSmoObject. (hérité de SqlSmoObject.) | |
GetHashCode | (hérité de Object.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Affecte un paramètre du SqlSmoObject. (hérité de SqlSmoObject.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Affecte un paramètre du SqlSmoObject. (hérité de SqlSmoObject.) | |
GetPropValue | Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetPropValueOptional | Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetPropValueOptionalAllowNull | Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetRealValue | Obtient une valeur de propriété de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetScriptingOptionsForCreate | Obtient ScriptingOptions pour l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetServerName | Obtient le nom de l'instance de SQL Server à laquelle l'objet est associé. (hérité de SqlSmoObject.) | |
GetServerObject | Obtient le serveur de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetSqlServerVersionName | Obtient le nom de version de l'instance de SQL Server à laquelle l'objet est associé. (hérité de SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Affecte un paramètre de chaîne de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Affecte un paramètre de chaîne de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetTimeSpanParameterAsInt | Affecte un paramètre d'intervalle de temps de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetType | (hérité de Object.) | |
GetUrnRecursive(StringBuilder) | Affecte un objet Urn de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | Affecte un objet Urn de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
ImplInitialize | Initialise les champs de l'objet SqlSmoObject. (hérité de SqlSmoObject.) | |
Initialize() () () () | Initialise l'objet et force le chargement des propriétés. (hérité de SqlSmoObject.) | |
Initialize(Boolean) | Initialise l'objet et force le chargement des propriétés. (hérité de SqlSmoObject.) | |
Invoke | Runs the job. | |
IsObjectDirty | Vérifie si les propriétés de l'objet ont été modifiées et si les modifications n'ont pas encore été rendues persistantes sur l'instance de SQL Server. (hérité de SqlSmoObject.) | |
IsObjectInitialized | Vérifie si l'objet a été initialisé. (hérité de SqlSmoObject.) | |
IsObjectInSpace | Vérifie si l'objet est isolé ou connecté à l'instance de SQL Server. (hérité de SqlSmoObject.) | |
IsVersion80SP3 | Détermine si la version de SQL Server est SQL Server 2000 avec SP3. (hérité de SqlSmoObject.) | |
IsVersion90AndAbove | Détermine si la version de SQL Server est SQL Server 2005 ou une version ultérieure. (hérité de SqlSmoObject.) | |
MarkDropped | Définit l'objet SqlSmoState à supprimer. (hérité de SqlSmoObject.) | |
MarkForDropImpl | Définit l'objet SqlSmoState à supprimer. (hérité de SqlSmoObject.) | |
MemberwiseClone | (hérité de Object.) | |
PostAlter | Méthode activée après la modification du SqlSmoObject. (hérité de SqlSmoObject.) | |
PostCreate | Méthode activée après la création du SqlSmoObject. (hérité de SqlSmoObject.) | |
PostDrop | Méthode activée après la suppression du SqlSmoObject. (hérité de SqlSmoObject.) | |
PurgeHistory | Removes system records maintaining execution history for the referenced job. | |
Refresh | Actualise l'objet et récupère les propriétés lors du prochain accès à l'objet. (hérité de 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 | Identifié à titre d'information uniquement. Non pris en charge. La compatibilité future n'est pas garantie. (hérité de NamedSmoObject.) | |
RenameImplWorker | Identifié à titre d'information uniquement. Non pris en charge. La compatibilité future n'est pas garantie. (hérité de 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 | Modifie l'objet SqlSmoObject d'après les paramètres. (hérité de SqlSmoObject.) | |
ScriptChangeOwner | This method supports the SMO infrastructure and is not intended to be used directly from your code. (hérité de NamedSmoObject.) | |
ScriptCreate | Modifie l'objet SqlSmoObject d'après les paramètres. (hérité de SqlSmoObject.) | |
ScriptDdl | Lève une exception InvalidSmoOperationException. (hérité de SqlSmoObject.) | |
ScriptDrop | Lève une exception InvalidSmoOperationException. (hérité de SqlSmoObject.) | |
ScriptImpl() () () () | Obtient une collection de scripts du SqlSmoObject. (hérité de SqlSmoObject.) | |
ScriptImpl(ScriptingOptions) | Obtient une collection de scripts du SqlSmoObject. (hérité de SqlSmoObject.) | |
ScriptImplWorker | Obtient une collection de scripts du SqlSmoObject. (hérité de SqlSmoObject.) | |
ScriptOwner | Alters the script owner authorization. (hérité de NamedSmoObject.) | |
ScriptRename | This method supports the SMO infrastructure and is not intended to be used directly from your code. (hérité de NamedSmoObject.) | |
SetParentImpl | Définit le parent du SqlSmoObject sur le paramètre newParent. (hérité de SqlSmoObject.) | |
SetSchemaOwned | Sets the schema owned value. (hérité de 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 | Retourne un String qui représente l'objet référencé. (hérité de SqlSmoObject.) | |
TouchImpl | Non implémenté. (hérité de SqlSmoObject.) | |
UnbindDefaultImpl | Annule la liaison des colonnes par défaut du SqlSmoObject. (hérité de SqlSmoObject.) | |
UnbindRuleImpl | Annule la liaison des règles du SqlSmoObject. (hérité de SqlSmoObject.) | |
Validate | Validates the state of an object. (hérité de SmoObjectBase.) |
Haut de la page
Événements
Nom | Description | |
---|---|---|
PropertyChanged | Représente l'événement qui se produit lorsqu'une propriété est modifiée. (hérité de SqlSmoObject.) | |
PropertyMetadataChanged | Représente l'événement qui se produit lorsque les métadonnées de la propriété sont modifiées. (hérité de SqlSmoObject.) |
Haut de la page
Champs
Nom | Description | |
---|---|---|
m_ExtendedProperties | Représente une propriété définie pour étendre les propriétés fournies par un SqlSmoObject. (hérité de SqlSmoObject.) | |
singletonParent | Représente le parent de singleton. (hérité de SqlSmoObject.) |
Haut de la page
Implémentations d'interfaces explicites
Nom | Description | |
---|---|---|
IAlienObject. . :: . .Discover | Découvre les éventuelles dépendances. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.) | |
IAlienObject. . :: . .GetDomainRoot | Retourne la racine du domaine. (hérité de SqlSmoObject.) | |
IAlienObject. . :: . .GetParent | Obtient le parent de cet objet. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyType | Obtient le type de la propriété spécifiée. (hérité de SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyValue | Obtient la valeur de la propriété spécifiée. (hérité de SqlSmoObject.) | |
IAlienObject. . :: . .GetUrn | Obtient l'URN (Uniform Resource Name) de l'objet. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.) | |
IAlienObject. . :: . .Resolve | Obtient l'instance qui contient les informations relatives à l'objet de l'URN (Unified Resource Name) de l'objet. (hérité de SqlSmoObject.) | |
IAlienObject. . :: . .SetObjectState | Définit l'état de l'objet sur la valeur SfcObjectState spécifiée. (hérité de SqlSmoObject.) | |
IAlienObject. . :: . .SetPropertyValue | Définit la valeur de la propriété. (hérité de SqlSmoObject.) | |
ISfcPropertyProvider. . :: . .GetPropertySet | Obtient la référence d'interface au jeu de propriétés de cet objet. Ne référencez pas directement ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.) |
Haut de la page
Notes
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
Tout membre statique public (Partagé dans Microsoft Visual Basic) de ce type est sûr dans le cadre des opérations à plusieurs threads. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.
Sécurité des threads
Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.
Voir aussi