sp_audit_write (Transact-SQL)

Область применения: SQL Server

Добавляет в определяемое пользователем событие USER_DEFINED_AUDIT_GROUPаудита. Если USER_DEFINED_AUDIT_GROUP параметр не включен, sp_audit_write игнорируется.

Соглашения о синтаксисе Transact-SQL

Синтаксис

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

Аргументы

[ @user_defined_event_id = ] user_defined_event_id

Параметр, определенный пользователем и записанный в столбце user_defined_event_id журнала аудита. @user_defined_event_id имеет небольшой размер.

[ @succeeded = ] успешно выполнено

Параметр, переданный пользователем с целью указания, было ли событие успешным или нет. Это значение отображается в succeeded столбце журнала аудита. @succeeded бит.

[ @user_defined_information = ] N'user_defined_information'

Текст, определенный пользователем и записанный в новом user_defined_event_id столбце журнала аудита. @user_defined_information nvarchar(4000).

Значения кода возврата

0 (успешно) или 1 (сбой).

Сбои вызваны неправильными входными параметрами или сбоем записи в целевой журнал аудита.

Замечания

USER_DEFINED_AUDIT_GROUP При добавлении в спецификацию аудита сервера или спецификацию аудита базы данных событие, активируется sp_audit_write в журнал аудита.

Разрешения

Требуется членство в роли общедоступной базы данных.

Примеры

А. Создание определяемого пользователем события аудита с информационным текстом

В следующем примере создается событие аудита со @user_defined_event_id значением 27, @succeeded значением 0и включается необязательный информационный текст.

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

B. Создание определяемого пользователем события аудита без информационного текста

В следующем примере создается событие аудита со @user_defined_event_id значением 27, @succeeded значением 0и не включает необязательный информационный текст или необязательные имена параметров.

EXEC sp_audit_write 27, 0;