Read-SqlXEvent

Lit SQL Server XEvents à partir d’un fichier XEL ou d’une session SQL XEvent en direct.

Syntax

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

Description

Le Read-SqlXEvent lit SQL Server XEvents à partir d’un fichier ou d’une session SQL XEvent en direct. Les sessions XEvent sont créées par l’API Transact-SQL CREATE EVENT SESSION. Les fichiers XEvent SQL ont généralement le . Extensions XEL ou .sqlaudit et contiennent un flux de XEvents. La structure des événements XEvents est définie dans la configuration de session. Les flux en direct SQL sont disponibles via le protocole SQL TDS et nécessitent une authentification sur le serveur qui les a produits.

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.

Exemples

Exemple 1 : lire et analyser le fichier sqlaudit. Chaque objet retourné contient toutes les informations d’un enregistrement d’audit unique.

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

Exemple 2 : Lire et analyser le flux en direct de XEvents à partir du SQL Server s’exécutant sur la même machine connectée à Authentification Windows. Chaque objet retourné contient toutes les informations d’un enregistrement XEvent unique.

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

Paramètres

-ConnectionString

SQL Server chaîne de connexion.

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

-FileName

Nom de fichier d’un fichier XEvent à lire.

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

-SessionName

Le SQL Server nom de session XEvent tel que défini par CREATE EVENT SESSION Transact-SQL.

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

Entrées

System.String

Sorties

Microsoft.SqlServer.XEvent.XELite.IXEvent