Audit.ID Property

Gets the integer value that uniquely identifies the audit.

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

Syntax

'Declaration
<SfcPropertyAttribute(SfcPropertyFlags.Standalone)> _
Public ReadOnly Property ID As Integer 
    Get
'Usage
Dim instance As Audit 
Dim value As Integer 

value = instance.ID

[SfcPropertyAttribute(SfcPropertyFlags.Standalone)]
public int ID { get; }

[SfcPropertyAttribute(SfcPropertyFlags::Standalone)]
public:
property int ID {
    int get ();
}

[<SfcPropertyAttribute(SfcPropertyFlags.Standalone)>]
member ID : int

function get ID () : int

Property Value

Type: System.Int32
A Integer value that uniquely identifies the audit.

Examples

The following code example demonstrates how to get the unique ID of the audit and display it on the console.

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();
            
            //Get the ID
            Console.WriteLine("The ID of the audit log file is: " +
                               dbAudit.ID);
        }
    }
}

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

#Get and display the ID
Write-Host "The ID of the audit log file is:" $dbAudit.ID

See Also

Reference

Audit Class

Microsoft.SqlServer.Management.Smo Namespace