Read-SqlXEvent

  • リファレンス
モジュール:
SQLServer

XEL ファイルまたはライブ SQL XEvent セッションから XEvents SQL Server読み取ります。

構文

Read-SqlXEvent
    [-FileName] <String>
    [<CommonParameters>]
Read-SqlXEvent
    -ConnectionString <String>
    -SessionName <String>
    [<CommonParameters>]

説明

Read-SqlXEventは、ファイルまたはライブ SQL XEvent セッションから SQL Server XEvents を読み取ります。 XEvent セッションは、CREATE EVENT SESSION Transact-SQL API によって作成されます。 SQL XEvent ファイルには通常、 があります。XEL または .sqlaudit 拡張機能。XEvents のストリームが含まれています。 XEvents の構造は、セッション構成で定義されます。 SQL ライブ ストリームは SQL TDS プロトコルを介して使用でき、それらを生成したサーバーに対する認証が必要です。

New in v22: if you are using the -ConnectionString parameter, you may get an error like "The certificate chain was issued by an authority that is not trusted." This is because the new SQL driver changed its default to something more secure. Either make sure you configure your server properly, or install/trust the certificate; alternatively (not recommended), you can pass Encrypt=Optional or TrustServerCertificate=true in the connection string to go back to the behavior that existed in v21 of the module.

例

例 1: sqlaudit ファイルの読み取りと解析。 返される各オブジェクトには、1 つの監査レコードのすべての情報が含まれます。

Read-SqlXEvent -FileName C:\audits\Audit-20190529-132659.sqlaudit

# The output would look like this:
#
# Name      : audit_event
# UUID      : c6479a6f-f1bd-4759-9881-fcb493821aff
# Timestamp : 6/13/2019 7:49:42 AM +00:00
# Fields    : {[audit_schema_version, 1], [event_time, 6/13/2019 7:49:42 AM +00:00], [sequence_number, 1], [action_id,
#             1129534785]...}
# Actions   : {}
#
# Name      : audit_event
# UUID      : c6479a6f-f1bd-4759-9881-fcb493821aff
# Timestamp : 6/13/2019 12:42:28 PM +00:00
# Fields    : {[audit_schema_version, 1], [event_time, 6/13/2019 12:42:28 PM +00:00], [sequence_number, 1], [action_id,
#             1129534785]...}
# Actions   : {}
# ...

例 2: Windows 認証に接続されている同じマシンで実行されているSQL Serverから XEvents のライブ ストリームを読み取り、解析します。 返される各オブジェクトには、1 つの XEvent レコードのすべての情報が含まれます。

Read-SQLXEvent -ConnectionString "Server=.;Database=master;Trusted_Connection=True" -SessionName telemetry_xevents

# The output would look like this:
#
# Name      : auto_stats
# UUID      : 9237e17a-a73d-4832-8936-f319e19e219b
# Timestamp : 11/14/2022 5:31:12 AM +00:00
# Fields    : {[database_id, 1], [object_id, 74], [index_id, 1], [job_id, 0]…}
# Actions   : {}
# 
# Name      : auto_stats
# UUID      : 9237e17a-a73d-4832-8936-f319e19e219b
# Timestamp : 11/14/2022 5:31:12 AM +00:00
# Fields    : {[database_id, 1], [object_id, 74], [index_id, 17], [job_id, 0]…}
# Actions   : {}
# ...

パラメーター

-ConnectionString

接続文字列をSQL Serverします。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-FileName

読み取る XEvent ファイルのファイル名。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SessionName

CREATE EVENT SESSION Transact-SQL によって定義された XEvent セッション名SQL Server。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

入力

System.String

出力

Microsoft.SqlServer.XEvent.XELite.IXEvent