Share via

  • Article

Audit.EnumDatabaseAuditSpecification Method

Enumerates a list of databases and audit specifications defined by the audit.

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

Syntax

'Declaration
Public Function EnumDatabaseAuditSpecification As DataTable
'Usage
Dim instance As Audit
Dim returnValue As DataTable

returnValue = instance.EnumDatabaseAuditSpecification()

public DataTable EnumDatabaseAuditSpecification()

public:
DataTable^ EnumDatabaseAuditSpecification()

member EnumDatabaseAuditSpecification : unit -> DataTable 

public function EnumDatabaseAuditSpecification() : DataTable

Return Value

Type: System.Data.DataTable
A DataTable system object value that contains a list of information about the databases in the audit. The following table describes the different columns of the returned DataTable.

Column

Data type

Description

Database Name

String

The name of the database.

DB Specification Name

String

The name of the database audit specification associated with the database.

Examples

The following code example demonstrates how to get the audit database and specification information.

C#

using System;
using System.Data;
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();

            //Gets the audit database and specification information
            DataTable auditData = new DataTable("Test Audit Data");
            auditData = dbAudit.EnumDatabaseAuditSpecification();
        }
    }
}

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

#Gets the audit database and specification information
$auditData = New-Object System.Data.DataTable("Test Audit Data") 
$auditData = $dbAudit.EnumDatabaseAuditSpecification()