sp_audit_write (Transact-SQL)

Статья
03/07/2014

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

Применимо для следующих объектов: SQL Server (начиная с SQL Server 2012 до текущей версии).

Значок ссылки на раздел Синтаксические обозначения в Transact-SQL

Синтаксис

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

Аргументы

@user_defined_event_id
Определяемый пользователем параметр, регистрируемый в столбце user_defined_event_id журнала аудита. Аргумент @user\_defined\_event\_id имеет тип smallint.
@succeeded
Параметр, переданный пользователем с целью указания, было ли событие успешным или нет. Содержится в столбце успеха журнала аудита. Аргумент @succeeded имеет тип bit.
@user_defined_information
Определяемый пользователем текст, который заносится в новый столбец user_defined_event_id журнала аудита. Аргумент @user\_defined\_information имеет тип nvarchar(4000).

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

0 (успешное завершение) или 1 (ошибка)

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

Замечания

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

Разрешения

Необходимо членство в роли базы данных public.

Примеры

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

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

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