Get‑SqlDscAudit - dsccommunity/SqlServerDsc GitHub Wiki

Get server audit.

Get-SqlDscAudit [-ServerObject] <Server> [[-Name] <String>] [-Refresh] 
 [<CommonParameters>]

This command gets a server audit from a SQL Server Database Engine instance.

$serverObject = Connect-SqlDscDatabaseEngine -InstanceName 'MyInstance'
$sqlServerObject | Get-SqlDscAudit -Name 'MyFileAudit'

Get the audit named MyFileAudit.

Specifies the name of the server audit to get.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Specifies that the ServerObject's audits should be refreshed before trying get the audit object. This is helpful when audits could have been modified outside of the ServerObject, for example through T-SQL. But on instances with a large amount of audits it might be better to make sure the ServerObject is recent enough, or pass in AuditObject.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Specifies current server connection object.

Type: Server
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.