Job.EventLogLevel Property

  • Article

Gets or sets the completion action that determines whether to generate an operating system event log entry when the job finishes execution.

Namespace:  Microsoft.SqlServer.Management.Smo.Agent
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property EventLogLevel As CompletionAction 
    Get 
    Set
'Usage
Dim instance As Job 
Dim value As CompletionAction 

value = instance.EventLogLevel

instance.EventLogLevel = value

[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public CompletionAction EventLogLevel { get; set; }

[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property CompletionAction EventLogLevel {
    CompletionAction get ();
    void set (CompletionAction value);
}

[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member EventLogLevel : CompletionAction with get, set

function get EventLogLevel () : CompletionAction 
function set EventLogLevel (value : CompletionAction)

Property Value

Type: Microsoft.SqlServer.Management.Smo.Agent.CompletionAction
A CompletionAction value that specifies whether to generate an operating system event log entry.

Remarks

If directed, Microsoft SQL Server Agent can generate an event log entry when execution succeeds or fails. Event log entries can also be generated regardless of success or failure of the job. By default, event log entries are not generated when execution finishes.

Examples

The following code example sets the job to generate an operating system event log entry when the job execution finishes.

C#

Server srv = new Server("(local)");
Job jb = new Job(srv.JobServer, "Test Job");
jb.EventLogLevel = CompletionAction.Always;

PowerShell

$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$jb = new-object Microsoft.SqlServer.Management.Smo.Agent.Job($srv.JobServer, "Test Job")
$jb.EventLogLevel = [Microsoft.SqlServer.Management.Smo.Agent.CompletionAction]::Always

See Also

Reference

Job Class

Microsoft.SqlServer.Management.Smo.Agent Namespace

Other Resources

Automated Administration Tasks (SQL Server Agent)

sp_add_job (Transact-SQL)

Scheduling Automatic Administrative Tasks in SQL Server Agent