Server.Audits Property

Represents a collection of Audit objects. Each Audit object represents an audit log defined on the instance of SQL Server.

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

Syntax

'Declaration
<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny,  _
    GetType(Audit))> _
Public ReadOnly Property Audits As AuditCollection 
    Get
'Usage
Dim instance As Server 
Dim value As AuditCollection 

value = instance.Audits

[SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(Audit))]
public AuditCollection Audits { get; }

[SfcObjectAttribute(SfcContainerRelationship::ObjectContainer, SfcContainerCardinality::ZeroToAny, 
    typeof(Audit))]
public:
property AuditCollection^ Audits {
    AuditCollection^ get ();
}

[<SfcObjectAttribute(SfcContainerRelationship.ObjectContainer, SfcContainerCardinality.ZeroToAny, 
    typeof(Audit))>]
member Audits : AuditCollection

function get Audits () : AuditCollection

Property Value

Type: Microsoft.SqlServer.Management.Smo.AuditCollection
A AuditCollection object that represents all the audit logs defined on the instance of SQL Server.

Examples

C#

//Connect to the local server and create audits
Server srv = new Server("(local)");
testAudit1 = new Audit(srv, "First Test Audit");
testAudit1.DestinationType = AuditDestinationType.File;
testAudit1.FilePath = "C:\AuditDirectory";
testAudit1.Create();
testAudit2 = new Audit(srv, "Second Test Audit");
testAudit2.DestinationType = AuditDestinatinoType.File;
testAudit2.FilePath = "C:\AuditDirectory";
testAudit2.Create()

//Display the populated audit property
foreach (Audit a in srv.Audits)
{
   Console.WriteLine(a.Name);
}

PowerShell

#Connect to the local server and create audits
$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$testAudit1 = new-object Microsoft.SqlServer.Management.Smo.Audit($srv, "First Test Audit")
$testAudit1.DestinationType = [Microsoft.SqlServer.Management.Smo.AuditDestinationType]::File
$testAudit1.FilePath = "C:\AuditDirectory"
$testAudit2 = new-object Microsoft.SqlServer.Management.Smo.Audit($srv, "Second Test Audit")
$testAudit2.FilePath = "C:\AuditDirectory"
$testAudit2.DestinationType = [Microsoft.SqlServer.Management.Smo.AuditDestinationType]::File
$testAudit1.Create()
$testAudit2.Create()

#Display the populated audit property
foreach ($a in $srv.Audits)
{
   Write-Host $a.Name
}

See Also

Reference

Server Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Using Collections

Managing Servers