sys.fn_get_audit_file (Transact-SQL)

  • 项目

适用于：SQL ServerAzure SQL 数据库Azure SQL 托管实例Azure Synapse Analytics

从 SQL Server 中的服务器审核创建的审核文件中返回信息。 有关详细信息，请参阅 SQL Server 审核（数据库引擎）。

Transact-SQL 语法约定

语法

fn_get_audit_file ( file_pattern ,
    { default | initial_file_name | NULL } ,
    { default | audit_record_offset | NULL } )

参数

file_pattern

指定要读取的审核文件集的目录（或路径）和文件名。 类型为 nvarchar（260）。

传递没有文件名模式的路径将生成错误。

此参数必须包括路径（驱动器盘符或网络共享）和文件名，可以包含通配符。 单个星号 • 可用于从审核文件集中收集多个文件。 例如：

  • \<path>\* - 收集指定位置中的所有审核文件。

  • <path>\LoginsAudit_{GUID}* - 收集具有指定名称和 GUID 对的所有审核文件。

  • <path>\LoginsAudit_{GUID}_00_29384.sqlaudit - 收集特定的审核文件。

initial_file_name

指定审核文件集中要开始读取审核记录的特定文件的路径和名称。 类型为 nvarchar（260）。

initial_file_name参数必须包含有效的条目，或者必须包含default或NULL值。

audit_record_offset

指定具有为 initial_file_name指定的文件的已知位置。 使用此参数时，函数将开始在指定偏移量之后立即读取缓冲区的第一条记录。

audit_record_offset参数必须包含有效的条目，或者必须包含default或NULL值。 类型为 bigint。

返回的表

下表描述此函数可返回的审核文件内容。

列名称 类型 描述
action_id varchar(4) 操作的 ID。 不可为 Null。
additional_information nvarchar(4000) 仅适用于单个事件的唯一信息，以 XML 的形式返回。 一些可审核的操作包含此类信息。

对于与 T-SQL 堆栈关联的操作，一个级别的 T-SQL 堆栈以 XML 格式显示。 XML 格式为： <tsql_stack><frame nest_level = '%u' database_name = '%.*s' schema_name = '%.*s' object_name = '%.*s' /></tsql_stack>

frame nest_level 指示帧的当前嵌套级别。 模块名称以三部分格式（database_name和schema_nameobject_name）表示。 将分析模块名称以转义无效的 XML 字符，例如<，<>>/_x/>。 他们逃脱了。_xHHHH\_ 代表 HHHH 字符的四位数十六进制 UCS-2 代码。 Nullable。 当 NULL 事件没有报告其他信息时返回。
affected_rows bigint 受执行语句影响的行数。

仅适用于：仅Azure SQL 数据库
application_name nvarchar(128) 执行导致审核事件的语句的客户端应用程序的名称。

适用于：SQL Server 2017 (14.x) 及更高版本和 Azure SQL 数据库
audit_file_offset bigint 包含审核记录的文件中的缓冲区偏移量。 不可为 Null。

适用于：仅限 SQL Server
audit_schema_version int 总是为 1。
class_type varchar(2) 发生审核的可审核实体的类型。 不可为 Null。
client_ip nvarchar(128) 客户端应用程序的源 IP。

适用于：SQL Server 2017 (14.x) 及更高版本和 Azure SQL 数据库
connection_id uniqueidentifier 服务器中连接的 ID。

适用于：Azure SQL 数据库和SQL 托管实例
data_sensitivity_information nvarchar(4000) 受审核查询根据数据库中分类的列返回的信息类型和敏感度标签。 详细了解Azure SQL 数据库数据发现和分类。

仅适用于：仅Azure SQL 数据库
database_name sysname 发生此操作的数据库上下文。 Nullable。 返回 NULL 服务器级别发生的审核。
database_principal_id int 在其中执行操作的数据库用户上下文 ID。 不可为 Null。 如果不适用，则返回 0 。 例如，如果是服务器操作，则返回 0。
database_principal_name sysname 当前用户。 Nullable。 如果不可用，则 NULL 返回。
duration_milliseconds bigint 查询执行持续时间（以毫秒为单位）。

适用于：Azure SQL 数据库和SQL 托管实例
event_time datetime2 触发可审核操作的日期和时间。 不可为 Null。
file_name varchar(260) 作为记录来源的审核日志文件的路径和名称。 不可为 Null。
is_column_permission bit 指示是否为列级权限的标志。 不可为 Null。 返回 0 当 permission_bitmask = 0.

1 = true
0 = false
object_id int 发生审核的实体的 ID，其中包括以下对象：

- 服务器对象
-数据库
- 数据库对象
- 架构对象

不可为 Null。 返回 0 实体是服务器本身，或者未在对象级别执行审核。 例如，对于 Authentication，则返回 NULL。
object_name sysname 发生审核的实体的名称，其中包括以下对象：

- 服务器对象
-数据库
- 数据库对象
- 架构对象

Nullable。 返回 NULL 实体是服务器本身，或者未在对象级别执行审核。 例如，对于 Authentication，则返回 NULL。
obo_middle_tier_app_id varchar（120） 使用 OBO 访问连接到Azure SQL 数据库的中间层应用程序的应用程序 ID。 Nullable。 如果请求未使用 OBO 访问进行，则 NULL 返回。

适用于： Azure SQL 数据库
permission_bitmask varbinary(16) 在某些操作中，此位掩码是授予、拒绝或撤销的权限。
response_rows bigint 结果集中返回的行数。

适用于：Azure SQL 数据库和SQL 托管实例
schema_name sysname 在其中执行操作的架构上下文。 Nullable。 返回 NULL 架构外部发生的审核。
sequence_group_id varbinary 唯一的 标识符。

适用于：SQL Server 2016 (13.x) 及更高版本
sequence_number int 跟踪单个审核记录中的记录顺序，该记录太大而无法放在写入缓冲区中以进行审核。 不可为 Null。
server_instance_name sysname 发生审核的服务器实例的名称。 使用标准服务器\实例格式。
server_principal_id int 在其中执行操作的登录上下文 ID。 不可为 Null。
server_principal_name sysname 当前登录名。 Nullable。
server_principal_sid varbinary 当前登录名 SID。 Nullable。
session_id smallint 发生该事件的会话的 ID。 不可为 Null。
session_server_principal_name sysname 会话的服务器主体。 Nullable。 返回连接到 SQL Server 实例的原始登录名的标识，以防出现显式或隐式上下文切换。
statement nvarchar(4000) 如果存在 Transact-SQL 语句，则为 Transact-SQL 语句。 Nullable。 如果不适用，则 NULL 返回。
succeeded bit 指示触发事件的操作是否成功。 不可为 Null。 对于除登录事件之外的所有事件，它仅报告权限检查（而不是操作）成功或失败。

1 = success
0 = 失败
target_database_principal_id int 执行操作的数据库主体GRANT//DENYREVOKE。 不可为 Null。 如果不适用，则 0 返回。
target_database_principal_name sysname 操作的目标用户。 Nullable。 如果不适用，则 NULL 返回。
target_server_principal_id int 执行操作的服务器主体GRANT//DENYREVOKE。 不可为 Null。 如果不适用，则 0 返回。
target_server_principal_name sysname 操作的目标登录名。 Nullable。 如果不适用，则 NULL 返回。
target_server_principal_sid varbinary 目标登录名的 SID。 Nullable。 如果不适用，则 NULL 返回。
transaction_id bigint 用于标识一个事务中的多个审核事件的唯一标识符。

适用于：SQL Server 2016 (13.x) 及更高版本
user_defined_event_id smallint 作为参数 sp_audit_write传递给的用户定义的事件 ID。 NULL 用于系统事件（默认值）和用户定义的事件的非零。 有关详细信息，请参阅sp_audit_write（Transact-SQL）。

适用于：SQL Server 2012（11.x）及更高版本、Azure SQL 数据库和SQL 托管实例
user_defined_information nvarchar(4000) 用于记录用户希望使用 sp_audit_write 存储过程在审核日志中记录的任何额外信息。

适用于：SQL Server 2012（11.x）及更高版本、Azure SQL 数据库和SQL 托管实例

注解

  • 如果传递给fn_get_audit_file引用的路径或文件不存在的file_pattern参数，或者该文件不是审核文件，则MSG_INVALID_AUDIT_FILE返回错误消息。

  • fn_get_audit_file使用或SECURITY_LOGEXTERNAL_MONITOR选项创建APPLICATION_LOG审核时，不能使用。

权限

需要 CONTROL SERVER 权限。

示例

此示例从名为 \\serverName\Audit\HIPAA_AUDIT.sqlaudit 的文件读取。

SELECT *
FROM sys.fn_get_audit_file(
    '\\serverName\Audit\HIPAA_AUDIT.sqlaudit',
    DEFAULT,
    DEFAULT
);
GO

有关如何创建审核的完整示例，请参阅 SQL Server 审核（数据库引擎）。

限制

在 Azure Synapse Analytics 上运行时，从 sys.fn_get_audit_file “创建表作为选择”（CTAS）中选择行或 INSERT INTO 存在限制。 尽管查询成功完成且未显示错误消息，但表中没有使用 CTAS 或 INSERT INTO创建的行。

相关内容