sp_audit_write (Transact-SQL)

Se aplica a: SQL Server

Agrega un evento de auditoría definido por el usuario a USER_DEFINED_AUDIT_GROUP. Si USER_DEFINED_AUDIT_GROUP no está habilitado, sp_audit_write se omite.

Convenciones de sintaxis de Transact-SQL

Sintaxis

sp_audit_write [ @user_defined_event_id = ] user_defined_event_id
    [ , [ @succeeded = ] succeeded ]
    [ , [ @user_defined_information = ] N'user_defined_information' ]
[ ; ]

Argumentos

[ @user_defined_event_id = ] user_defined_event_id

Parámetro definido por el usuario y registrado en la user_defined_event_id columna del registro de auditoría. @user_defined_event_id es smallint.

[ @succeeded = ] correcto

Parámetro pasado por el usuario para indicar si el evento se realizó correctamente o no. Este valor aparece en la succeeded columna del registro de auditoría. @succeeded es bit.

[ @user_defined_information = ] N'user_defined_information'

Texto definido por el usuario y grabado en la nueva user_defined_event_id columna del registro de auditoría. @user_defined_information es nvarchar(4000).

Valores de código de retorno

0 (correcto) o 1 (erróneo).

Los errores se deben a parámetros de entrada incorrectos o errores al escribir en el registro de auditoría de destino.

Comentarios

USER_DEFINED_AUDIT_GROUP Cuando se agrega a una especificación de auditoría de servidor o a una especificación de auditoría de base de datos, el evento desencadenado por sp_audit_write se incluye en el registro de auditoría.

Permisos

Requiere la pertenencia al rol de base de datos pública .

Ejemplos

A Creación de un evento de auditoría definido por el usuario con texto informativo

En el ejemplo siguiente se crea un evento de auditoría con un @user_defined_event_id valor de 27, el @succeeded valor de 0e incluye texto informativo opcional.

EXEC sp_audit_write @user_defined_event_id = 27,
    @succeeded = 0,
    @user_defined_information = N'Access to a monitored object.';

B. Creación de un evento de auditoría definido por el usuario sin texto informativo

En el ejemplo siguiente se crea un evento de auditoría con un @user_defined_event_id valor de 27, el @succeeded valor de 0y no incluye texto informativo opcional ni los nombres de parámetro opcionales.

EXEC sp_audit_write 27, 0;