Share via

  • Article

Audit.OnFailure Property

Gets or sets the action taken when the audit fails.

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

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public Property OnFailure As OnFailureAction
    Get
    Set
'Usage
Dim instance As Audit
Dim value As OnFailureAction

value = instance.OnFailure

instance.OnFailure = value

[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public OnFailureAction OnFailure { get; set; }

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

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

function get OnFailure () : OnFailureAction
function set OnFailure (value : OnFailureAction)

Property Value

Type: Microsoft.SqlServer.Management.Smo.OnFailureAction
A OnFailureAction value that specifies the type of action taken after the audit fails, such as whether to continue or shut down the system.

Examples

The following code example demonstrates how to configure the system to shut down after an audit fails.

C#

using System;
using Microsoft.SqlServer.Management.Smo;

namespace samples
{
    class Program
    {
        static void Main(string[] args)
        {
            //Create the audit
            Server dbServer = new Server("(local)");
            Audit dbAudit = new Audit(dbServer, "Test Audit");
            dbAudit.DestinationType = AuditDestinationType.File;
            dbAudit.FilePath = "C:\\AuditDirectory";
            dbAudit.Create();
             
            //Set the system to shut down if the audit fails
            dbAudit.OnFailure = OnFailureAction.Shutdown;
        }
    }
}

Powershell

#Create the audit 
$dbServer = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$dbAudit = New-Object Microsoft.SqlServer.Management.Smo.Audit($dbServer, "Test Audit")
$dbAudit.DestinationType = [Microsoft.SqlServer.Management.Smo.AuditDestinationType]'File'
$dbAudit.FilePath = "C:\AuditDirectory"
$dbAudit.Create()

#Set the system to shut down if the audit fails
$dbAudit.OnFailure = [Microsoft.SqlServer.Management.Smo.OnFailureAction]'Shutdown'