Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Applies to: 
SQL Server
Adds a user-defined audit event to USER_DEFINED_AUDIT_GROUP. If USER_DEFINED_AUDIT_GROUP isn't enabled, sp_audit_write is ignored.
Transact-SQL syntax conventions
sp_audit_write [ @user_defined_event_id = ] user_defined_event_id
[ , [ @succeeded = ] succeeded ]
[ , [ @user_defined_information = ] N'user_defined_information' ]
[ ; ]
Important
Arguments for extended stored procedures must be entered in the specific order as described in the Syntax section. If the parameters are entered out of order, an error message occurs.
A parameter defined by the user and recorded in the user_defined_event_id column of the audit log. @user_defined_event_id is smallint.
A parameter passed by user to indicate whether the event was successful or not. This value appears in the succeeded column of the audit log. @succeeded is bit.
The text defined by the user and recorded in the new user_defined_event_id column of the audit log. @user_defined_information is nvarchar(4000).
0 (success) or 1 (failure).
Failures are caused by incorrect input parameters, or failure to write to the target audit log.
When the USER_DEFINED_AUDIT_GROUP is added to either a server audit specification or a database audit specification, the event triggered by sp_audit_write is included in the audit log.
Requires membership in the public database role.
The following example creates an audit event with a @user_defined_event_id value of 27, the @succeeded value of 0, and includes optional informational text.
EXEC sp_audit_write @user_defined_event_id = 27,
@succeeded = 0,
@user_defined_information = N'Access to a monitored object.';
The following example creates an audit event with a @user_defined_event_id value of 27, the @succeeded value of 0, and doesn't include optional informational text or the optional parameter names.
EXEC sp_audit_write 27, 0;