sp_audit_write (Transact-SQL)sp_audit_write (Transact-SQL)

APLICA-SE A: simSQL Server nãoBanco de Dados SQL do Azure nãoAzure Synapse Analytics (SQL DW) nãoParallel Data Warehouse APPLIES TO: yesSQL Server noAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

Adiciona um evento de auditoria definido pelo usuário à USER_DEFINED_AUDIT_GROUP.Adds a user-defined audit event to the USER_DEFINED_AUDIT_GROUP. Se USER_DEFINED_AUDIT_GROUP não estiver habilitado, sp_audit_write será ignorado.If USER_DEFINED_AUDIT_GROUP is not enabled, sp_audit_write is ignored.

Ícone de link do tópico Convenções de sintaxe de Transact-SQLTopic link icon Transact-SQL Syntax Conventions

SintaxeSyntax

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

ArgumentosArguments

[ @user_defined_event_id = ] user_defined_event_id
Um parâmetro definido pelo usuário e registrado na coluna user_defined_event_id do log de auditoria.A parameter defined by the user and recorded in the user_defined_event_id column of the audit log. @user_defined_event_id é do tipo smallint.@user_defined_event_id is type smallint.

[ @succeeded = ] succeeded
Um parâmetro passado por usuário para indicar se o evento teve êxito ou não.A parameter passed by user to indicate whether the event was successful or not. Isso aparece na coluna Êxito do log de auditoria.This appears in the succeeded column of the audit log. @succeeded é bit.@succeeded is bit.

[ @user_defined_information = ] 'user_defined_information'
É o texto definido pelo usuário e registrado na coluna user_defined_event_id do log de auditoria.Is the text defined by the user and recorded in the new user_defined_event_id column of the audit log. @user_defined_information é nvarchar (4000) .@user_defined_information is nvarchar(4000).

Valores do código de retornoReturn Code Values

0 (êxito) ou 1 (falha)0 (success) or 1 (failure)

As falhas são provocadas por parâmetros de entrada incorretos ou erros de gravação no log de auditoria de destino.Failures are caused by incorrect input parameters or failure to write to the target audit log.

RemarksRemarks

Quando o USER_DEFINED_AUDIT_GROUP é adicionado a uma especificação de auditoria de servidor ou uma especificação de auditoria de banco de dados, o evento disparado pelo sp_audit_write será incluído no log de auditoria.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 will be included in the audit log.

PermissõesPermissions

Requer associação na função de banco de dados pública .Requires membership in the public database role.

ExemplosExamples

A.A. Criando um evento de auditoria definido pelo usuário com texto informativoCreating a user-defined audit event with informational text

O exemplo a seguir cria um evento de auditoria com a id 27, o valor de êxito igual a 0 e o texto informativo opcional incluído.The following example creates an audit event with the id 27, the succeeded value of 0, and included optional informational text.

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

B.B. Criando um evento de auditoria definido pelo usuário sem texto informativoCreating a user-defined audit event without informational text

O exemplo a seguir cria um evento de auditoria com a id 27, o valor de êxito igual a 0 e não inclui o texto informativo opcional ou os nomes dos parâmetros opcionais.The following example creates an audit event with the id 27, the succeeded value of 0, and does not include optional informational text or the optional parameter names.

EXEC sp_audit_write 27, 0;  
  

Consulte tambémSee Also

Procedimentos de segurança armazenados (Transact-SQL) Security Stored Procedures (Transact-SQL)
sys.server_principals (Transact-SQL) sys.server_principals (Transact-SQL)
sp_addrole (Transact-SQL) sp_addrole (Transact-SQL)
CREATE USER (Transact-SQL) CREATE USER (Transact-SQL)
sp_dropuser (Transact-SQL) sp_dropuser (Transact-SQL)
sp_grantdbaccess (Transact-SQL) sp_grantdbaccess (Transact-SQL)
sp_grantlogin (Transact-SQL) sp_grantlogin (Transact-SQL)
Procedimentos armazenados do sistema (Transact-SQL)System Stored Procedures (Transact-SQL)