Freigeben über


Read-SqlXEvent

Liest SQL Server XEvents aus der XEL-Datei oder der SQL XEvent-Livesitzung.

Syntax

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

Beschreibung

Die Read-SqlXEvent liest SQL Server XEvents aus einer Datei oder einer SQL XEvent-Livesitzung. XEvent-Sitzungen werden von der CREATE EVENT SESSION Transact-SQL-API erstellt. SQL XEvent-Dateien verfügen in der Regel über die . XEL- oder SQLaudit-Erweiterungen und enthalten einen Datenstrom von XEvents. Die Struktur der XEvents wird in der Sitzungskonfiguration definiert. SQL-Livestreams sind über das SQL TDS-Protokoll verfügbar und erfordern eine Authentifizierung für den Server, der sie erzeugt hat.

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.

Beispiele

Beispiel 1: Lesen und Analysieren der sqlaudit-Datei. Jedes zurückgegebene Objekt enthält alle Informationen aus einem einzelnen Überwachungsdatensatz.

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   : {}
# ...

Beispiel 2: Lesen und Analysieren des Livestreams von XEvents vom SQL Server, der auf demselben Computer ausgeführt wird, der mit der Windows-Authentifizierung verbunden ist. Jedes zurückgegebene Objekt enthält alle Informationen aus einem einzelnen XEvent-Datensatz.

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   : {}
# ...

Parameter

-ConnectionString

SQL Server-Verbindungszeichenfolge.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-FileName

Dateiname einer zu lesenden XEvent-Datei.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-ProgressAction

Bestimmt, wie PowerShell auf Statusaktualisierungen reagiert, die von einem Skript, Cmdlet oder Anbieter generiert werden, z. B. auf die Statusanzeigen, die vom Cmdlet Write-Progress generiert werden. Das Cmdlet Write-Progress erstellt Statusanzeigen, die den Status eines Befehls anzeigen.

Typ:ActionPreference
Aliase:proga
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-SessionName

Der NAME der SQL Server XEvent-Sitzung gemäß definition durch die CREATE EVENT SESSION Transact-SQL.

Typ:String
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

System.String

Ausgaben

Microsoft.SqlServer.XEvent.XELite.IXEvent