Share via

  • Article

Audit.DestinationType Property

Gets or sets the type of destination to which the audit log information is recorded, such as a file, or an application log.

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

Syntax

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

value = instance.DestinationType

instance.DestinationType = value

[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public AuditDestinationType DestinationType { get; set; }

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

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

function get DestinationType () : AuditDestinationType
function set DestinationType (value : AuditDestinationType)

Property Value

Type: Microsoft.SqlServer.Management.Smo.AuditDestinationType
A AuditDestinationType object that represents the type of destination to which the audit log information is logged.

Examples

The following code example shows how to set the audit destination type to a Windows Security event log.

C#

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

namespace samples
{
    class Program
    {
        static void Main(string[] args)
        {
            //Create the audit and set the destination file type
            Server dbServer = new Server("(local)");
            Audit dbAudit = new Audit(dbServer, "Test Audit");
            dbAudit.DestinationType = AuditDestinationType.SecurityLog;
            dbAudit.FilePath = "C:\\AuditDirectory";
            dbAudit.Create();
        }
    }
}

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()